Documents
Dateien und Ordner
Wofür sie gedacht ist
A register of business documents with folder, kind, owner, expiry and confidentiality. It stores references to documents, not the file contents.
Was das Paket leistet und was nicht
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.
Moduldetails
- Version:
0.3.0 - Autor: SpaceCorps
- Lizenz: AGPL-3.0-or-later
- Benötigt Kern:
^0.2(aktuell ist Kern 0.2.0) - Reifegrad: Beta
- Kategorien: Produktivität
Modelle
documents_folder
A folder that groups documents
Lesegruppe: documents.user. Schreibgruppe: documents.manager.
| Feld | Art | Datenklasse | Personenbezogene Daten | Gruppe | Agenten sehen | Beschreibung |
|---|---|---|---|---|---|---|
name | text | none | nein | documents.user | im Klartext | Folder name |
parent_id | ref → documents_folder | none | nein | documents.user | im Klartext | The folder this one sits in |
description | longtext | none | nein | documents.user | im Klartext | What belongs in the folder |
documents_document
A contract, policy, certificate or other document on record
Lesegruppe: documents.user. Schreibgruppe: documents.user.
| Feld | Art | Datenklasse | Personenbezogene Daten | Gruppe | Agenten sehen | Beschreibung |
|---|---|---|---|---|---|---|
title | text | none | nein | documents.user | im Klartext | Document title |
folder_id | ref → documents_folder | none | nein | documents.user | im Klartext | The folder the document is filed in |
kind | select (contract, invoice, policy, report, certificate, other) | none | nein | documents.user | im Klartext | Type of document: contract, invoice, policy, report, certificate, other |
confidentiality | select (public, internal, confidential, restricted) | none | nein | documents.user | im 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 | nein | documents.user | im Klartext | Whether everyone who may read documents can see this one: true for public and internal documents |
owner | text | internal | ja | documents.user | maskiert | 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 | nein | documents.user | im Klartext | Reference number, for example a contract number |
location | text | none | nein | documents.user | im Klartext | Where the file is stored, such as a link or archive box |
attachment | file | internal | nein | documents.user | im 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 | nein | documents.user | im Klartext | Date after which the document is no longer valid (YYYY-MM-DD) |
summary | longtext | none | nein | documents.user | im Klartext | What the document says, in a few lines |
state | select (draft, published, archived) | none | nein | documents.user | im Klartext | Document status: draft, published, archived |
Workflows
documents_document
| Aktion | Bewegt | Wer sie ausführen darf | Freigabe |
|---|---|---|---|
documents_document.publish | state: draft → published | documents.user | nein |
documents_document.archive | state: published → archived | documents.manager | nein |
Berechtigungsgruppen
Von dieser App verwendete Gruppen:
documents.managerdocuments.user
Freigabeschritte
Kein Schritt dieser App braucht eine Freigabe, abgesehen vom Löschen von Datensätzen.
Was Agenten tun können und was nicht
Ein Agent kann Datensätze dieser App lesen, durchsuchen, anlegen und aktualisieren sowie Aktionen ausführen, die keine Freigabe brauchen, und zwar innerhalb der Berechtigungsgruppen seines Tokens.
Diese Schritte kann er nur vorschlagen, und eine Person muss sie freigeben: documents_folder.delete, documents_document.delete.
Personenbezogene Daten werden als Platzhalter maskiert: documents_document.owner.
Abhängigkeiten
Keine.
Installation
Installieren Sie sie in der App Customize (Marktplatz) oder über die Kommandozeile:
obop modules install-from documentsErfordert eine Datenbank und Administratorrechte.
Selbst bauen
Der Modulleitfaden zeigt, wie Apps wie diese geschrieben werden