Documents
Fichiers et dossiers
À quoi elle sert
A register of business documents with folder, kind, owner, expiry and confidentiality. It stores references to documents, not the file contents.
Ce que fait et ne fait pas le paquet
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.
Détails du module
- Version:
0.3.0 - Auteur: SpaceCorps
- Licence: AGPL-3.0-or-later
- Noyau requis:
^0.2(le noyau actuel est 0.2.0) - Maturité: Bêta
- Catégories: Productivité
Modèles
documents_folder
A folder that groups documents
Groupe de lecture: documents.user. Groupe d'écriture: documents.manager.
| Champ | Type | Classe de données | Données personnelles | Groupe | Vu par les agents | Description |
|---|---|---|---|---|---|---|
name | text | none | non | documents.user | en clair | Folder name |
parent_id | ref → documents_folder | none | non | documents.user | en clair | The folder this one sits in |
description | longtext | none | non | documents.user | en clair | What belongs in the folder |
documents_document
A contract, policy, certificate or other document on record
Groupe de lecture: documents.user. Groupe d'écriture: documents.user.
| Champ | Type | Classe de données | Données personnelles | Groupe | Vu par les agents | Description |
|---|---|---|---|---|---|---|
title | text | none | non | documents.user | en clair | Document title |
folder_id | ref → documents_folder | none | non | documents.user | en clair | The folder the document is filed in |
kind | select (contract, invoice, policy, report, certificate, other) | none | non | documents.user | en clair | Type of document: contract, invoice, policy, report, certificate, other |
confidentiality | select (public, internal, confidential, restricted) | none | non | documents.user | en clair | 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 | non | documents.user | en clair | Whether everyone who may read documents can see this one: true for public and internal documents |
owner | text | internal | oui | documents.user | masqué | 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 | non | documents.user | en clair | Reference number, for example a contract number |
location | text | none | non | documents.user | en clair | Where the file is stored, such as a link or archive box |
attachment | file | internal | non | documents.user | en clair | 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 | non | documents.user | en clair | Date after which the document is no longer valid (YYYY-MM-DD) |
summary | longtext | none | non | documents.user | en clair | What the document says, in a few lines |
state | select (draft, published, archived) | none | non | documents.user | en clair | Document status: draft, published, archived |
Flux de travail
documents_document
| Action | Transition | Qui peut l'exécuter | Approbation |
|---|---|---|---|
documents_document.publish | state: draft → published | documents.user | non |
documents_document.archive | state: published → archived | documents.manager | non |
Groupes de permissions
Groupes utilisés par cette application :
documents.managerdocuments.user
Étapes d'approbation
Aucune étape de cette application ne requiert d'approbation, hormis la suppression d'enregistrements.
Ce que les agents peuvent et ne peuvent pas faire
Un agent peut lire, rechercher, créer et modifier les enregistrements de cette application, et exécuter les actions qui ne requièrent pas d'approbation, dans les limites des groupes de permissions de son jeton.
Il ne peut que proposer ces étapes, qu'une personne doit approuver : documents_folder.delete, documents_document.delete.
Les données personnelles sont masquées sous forme de jetons de substitution : documents_document.owner.
Dépendances
Aucune.
Installation
Installez-la depuis l'application Customize (Place de marché), ou en ligne de commande :
obop modules install-from documentsNécessite une base de données et des droits d'administrateur.
Créer la vôtre
Le guide des modules montre comment sont écrites les applications de ce type