Files based

Files based are components using the private part of Files from BrightSide Attachments. Each uses a specific root and makes the content available to specific roles or users, depending on functionality.

Current components are [ Deliverables, Documentation ] .

Deliverables

The Deliverables component aims to facilitate publishing entity deliverables. The roles allowing uploads and downloads can be controlled using Concept permissions . The show permissions grant users to download. The action permissions grant users to upload.

The administration form is quite forward and responds to user roles.


Deliverables configuration is included out-of-the-box in projects.
Documentation

The goal of this component is to allow specific roles to require documentation to specific users.

Documentation definition

Before requiring documentation, a definition about this documentation must be made. The definition fields are:

Field

Description

Required

Name

The name of the documentation. This name must be user-friendly and unmistakable.

Type

Indicates the type of files to be uploaded. Can be:

  • ANY
  • TEXT (pdf, txt, odt, fodt, doc, docx)
  • SHEET (ods, fods, xls, xlsx)
  • IMAGE (png, jpg)

Description

Supporting text describing what the documentation is about.

Allowed root

Filters whether this documentation will be shown. The root refers to the entity root.

Multiple contacts

Allows adding more contacts to a single documentation petition.

Upload control

Allows overriding files only when the uploaded version is newer than the already existing. When the failing condition is met, shows a message requesting the user to use the last file version.

min, max

Controls the numbers of files that should be uploaded. The min value must be reached before the documentation is evaluated.

References

Files used as a reference to documentation. In some cases, references can be the forms to fulfill.


Especial cases

The flow

Documentation fulfillment is a conversation between a requester and a requested, both registered users. The status of pending actions will appear in both users areas, with an easy-to-follow link.

Empty documentation form. The request action must be initiated by users with specific roles, depending on the associated entity.


The user with the right roles starts a request and the status changes to pending to upload. Only the requested user will be able to see the form and upload documents.


The documentation is uploaded and pending validation. Only the requester or administrators can validate or deny the documentation.


Denied documentation with a reason message.


Validated documentation.