Documents

Filer och mappar

MarknadsplatsInnehåll och dokumentVersion 0.3.0AGPL-3.0-or-latermanifest

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
  • 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ältTypDataklassPersonuppgiftGruppAgenter serBeskrivning
nametextnonenejdocuments.useri klartextFolder name
parent_idref → documents_foldernonenejdocuments.useri klartextThe folder this one sits in
descriptionlongtextnonenejdocuments.useri klartextWhat belongs in the folder

documents_document ​

A contract, policy, certificate or other document on record

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

FältTypDataklassPersonuppgiftGruppAgenter serBeskrivning
titletextnonenejdocuments.useri klartextDocument title
folder_idref → documents_foldernonenejdocuments.useri klartextThe folder the document is filed in
kindselect (contract, invoice, policy, report, certificate, other)nonenejdocuments.useri klartextType of document: contract, invoice, policy, report, certificate, other
confidentialityselect (public, internal, confidential, restricted)nonenejdocuments.useri klartextWho may see it: public and internal documents everyone who may read documents, confidential and restricted ones only the owner and documents.manager
open_to_allboolnonenejdocuments.useri klartextWhether everyone who may read documents can see this one: true for public and internal documents
ownertextinternaljadocuments.usermaskeradUser name of the person responsible for the document; the person who creates it unless set otherwise. Owners see their confidential documents
referencetextnonenejdocuments.useri klartextReference number, for example a contract number
locationtextnonenejdocuments.useri klartextWhere the file is stored, such as a link or archive box
attachmentfileinternalnejdocuments.useri klartextThe 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_ondatenonenejdocuments.useri klartextDate after which the document is no longer valid (YYYY-MM-DD)
summarylongtextnonenejdocuments.useri klartextWhat the document says, in a few lines
stateselect (draft, published, archived)nonenejdocuments.useri klartextDocument status: draft, published, archived

Arbetsflöden ​

documents_document ​

ÅtgärdFlyttarVem får köra denGodkännande
documents_document.publishstate: draft → publisheddocuments.usernej
documents_document.archivestate: published → archiveddocuments.managernej

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