---
title: "Documents"
description: "Filer och mappar. Varje app är en modul i en gemensam datamodell."
canonical: "https://obop.dev/sv/apps/documents/"
lang: "sv"
---

# Documents

## Vad den är till för

A register of business documents with folder, kind, owner, expiry and confidentiality. It stores references to documents, not the file contents.

## Vad paketet gör och inte gör

A register of business documents: folders, document records with kind, owner, expiry and confidentiality, and a draft, published and archived flow. It stores references and, when you upload one, the file itself. Confidentiality is enforced: confidential and restricted documents are visible only to their owner and to documents.manager; public and internal ones to everyone who may read documents.

## Modulinformation

- **Version:** `0.3.0`
- **Utgivare:** SpaceCorps
- **Licens:** [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html)
- **Kräver kärna:** `^0.2` (aktuell kärna är 0.2.0)
- **Mognad:** Beta
- **Kategorier:** Produktivitet

## Modeller

### `documents_folder`

A folder that groups documents

Läsgrupp: `documents.user`. Skrivgrupp: `documents.manager`.

| Fält | Typ | Dataklass | Personuppgift | Grupp | Agenter ser | Beskrivning |
|---|---|---|---|---|---|---|
| `name` | text | `none` | nej | `documents.user` | i klartext | Folder name |
| `parent_id` | ref → documents_folder | `none` | nej | `documents.user` | i klartext | The folder this one sits in |
| `description` | longtext | `none` | nej | `documents.user` | i klartext | What belongs in the folder |

### `documents_document`

A contract, policy, certificate or other document on record

Läsgrupp: `documents.user`. Skrivgrupp: `documents.user`.

| Fält | Typ | Dataklass | Personuppgift | Grupp | Agenter ser | Beskrivning |
|---|---|---|---|---|---|---|
| `title` | text | `none` | nej | `documents.user` | i klartext | Document title |
| `folder_id` | ref → documents_folder | `none` | nej | `documents.user` | i klartext | The folder the document is filed in |
| `kind` | select (contract, invoice, policy, report, certificate, other) | `none` | nej | `documents.user` | i klartext | Type of document: contract, invoice, policy, report, certificate, other |
| `confidentiality` | select (public, internal, confidential, restricted) | `none` | nej | `documents.user` | i klartext | Who may see it: public and internal documents everyone who may read documents, confidential and restricted ones only the owner and documents.manager |
| `open_to_all` | bool | `none` | nej | `documents.user` | i klartext | Whether everyone who may read documents can see this one: true for public and internal documents |
| `owner` | text | `internal` | ja | `documents.user` | maskerad | User name of the person responsible for the document; the person who creates it unless set otherwise. Owners see their confidential documents |
| `reference` | text | `none` | nej | `documents.user` | i klartext | Reference number, for example a contract number |
| `location` | text | `none` | nej | `documents.user` | i klartext | Where the file is stored, such as a link or archive box |
| `attachment` | file | `internal` | nej | `documents.user` | i klartext | The document file itself (PDF, image, text, spreadsheet or office document, up to 25 MiB); served only as a download to people who may read the record |
| `expires_on` | date | `none` | nej | `documents.user` | i klartext | Date after which the document is no longer valid (YYYY-MM-DD) |
| `summary` | longtext | `none` | nej | `documents.user` | i klartext | What the document says, in a few lines |
| `state` | select (draft, published, archived) | `none` | nej | `documents.user` | i klartext | Document status: draft, published, archived |

## Arbetsflöden

### `documents_document`

| Åtgärd | Flyttar | Vem får köra den | Godkännande |
|---|---|---|---|
| `documents_document.publish` | state: draft → published | `documents.user` | nej |
| `documents_document.archive` | state: published → archived | `documents.manager` | nej |

## Behörighetsgrupper

Grupper som den här appen använder:

- `documents.manager`
- `documents.user`

## Steg som kräver godkännande

Inget steg i den här appen kräver godkännande, förutom att ta bort poster.

## Vad agenter kan och inte kan göra

En agent kan läsa, söka, skapa och uppdatera poster i den här appen, och köra de åtgärder som inte kräver godkännande, inom behörighetsgrupperna för sin token.

Den kan bara föreslå de här stegen, och en person måste godkänna dem: `documents_folder.delete`, `documents_document.delete`.

Personuppgifter maskeras som platshållare: `documents_document.owner`.

## Beroenden

Inga.

## Installera

Installera den från appen Customize (Marknadsplats), eller från kommandoraden:

```bash
obop modules install-from documents
```

Kräver en databas och administratörsbehörighet.

## Bygg din egen

[Modulguiden visar hur appar som den här skrivs](/sv/docs/reference/module-manifest/)