Documents

Pliki i foldery

MarketplaceTreści i dokumentyWersja 0.3.0AGPL-3.0-or-latermanifest

Do czego służy ​

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

Co pakiet robi, a czego nie robi ​

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.

Szczegóły modułu ​

  • Wersja: 0.3.0
  • Autor: SpaceCorps
  • Licencja: AGPL-3.0-or-later
  • Wymaga rdzenia: ^0.2 (aktualny rdzeń to 0.2.0)
  • Dojrzałość: Beta
  • Kategorie: Produktywność

Modele ​

documents_folder ​

A folder that groups documents

Grupa odczytu: documents.user. Grupa zapisu: documents.manager.

PoleRodzajKlasa danychDane osoboweGrupaAgenci widząOpis
nametextnoneniedocuments.userjawnieFolder name
parent_idref → documents_foldernoneniedocuments.userjawnieThe folder this one sits in
descriptionlongtextnoneniedocuments.userjawnieWhat belongs in the folder

documents_document ​

A contract, policy, certificate or other document on record

Grupa odczytu: documents.user. Grupa zapisu: documents.user.

PoleRodzajKlasa danychDane osoboweGrupaAgenci widząOpis
titletextnoneniedocuments.userjawnieDocument title
folder_idref → documents_foldernoneniedocuments.userjawnieThe folder the document is filed in
kindselect (contract, invoice, policy, report, certificate, other)noneniedocuments.userjawnieType of document: contract, invoice, policy, report, certificate, other
confidentialityselect (public, internal, confidential, restricted)noneniedocuments.userjawnieWho may see it: public and internal documents everyone who may read documents, confidential and restricted ones only the owner and documents.manager
open_to_allboolnoneniedocuments.userjawnieWhether everyone who may read documents can see this one: true for public and internal documents
ownertextinternaltakdocuments.userzamaskowaneUser name of the person responsible for the document; the person who creates it unless set otherwise. Owners see their confidential documents
referencetextnoneniedocuments.userjawnieReference number, for example a contract number
locationtextnoneniedocuments.userjawnieWhere the file is stored, such as a link or archive box
attachmentfileinternalniedocuments.userjawnieThe 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_ondatenoneniedocuments.userjawnieDate after which the document is no longer valid (YYYY-MM-DD)
summarylongtextnoneniedocuments.userjawnieWhat the document says, in a few lines
stateselect (draft, published, archived)noneniedocuments.userjawnieDocument status: draft, published, archived

Przepływy pracy ​

documents_document ​

AkcjaPrzenosiKto może uruchomićZatwierdzenie
documents_document.publishstate: draft → publisheddocuments.usernie
documents_document.archivestate: published → archiveddocuments.managernie

Grupy uprawnień ​

Grupy używane przez tę aplikację:

  • documents.manager
  • documents.user

Kroki zatwierdzania ​

Żaden krok w tej aplikacji nie wymaga zatwierdzenia, poza usuwaniem rekordów.

Co agenci mogą, a czego nie mogą ​

Agent może odczytywać, wyszukiwać, tworzyć i aktualizować rekordy tej aplikacji oraz uruchamiać akcje niewymagające zatwierdzenia, w ramach grup uprawnień swojego tokenu.

Te kroki może tylko zaproponować, a człowiek musi je zatwierdzić: documents_folder.delete, documents_document.delete.

Dane osobowe są maskowane jako tokeny zastępcze: documents_document.owner.

Zależności ​

Brak.

Instalacja ​

Zainstaluj ją w aplikacji Customize (Marketplace) lub z wiersza poleceń:

bash
obop modules install-from documents

Wymaga bazy danych i uprawnień administratora.

Zbuduj własną ​

Przewodnik po modułach pokazuje, jak pisze się takie aplikacje