Types of case documents
Description
Document types are documents that will be available for download by the user at various stages of the Case. It is possible to generate new documents based on data from forms.
Administration access path
Go to the administration panel case types, and then select the following items:
- Administration Panel -> Cases -> Specific case type -> DOCUMENT TYPES
DOCUMENT TYPES tab
Details of the case. Document Types View
The document types view consists of the list visible above in the table:
- name of the Document Type
- Order on the form(s).
- Forms – what they are on (their ID)
- API name (for internal references)
The use of documents in the form is indicated by a set of symbols and colors. Each type of document has a specific degree of maturity assigned to it, associated with a different color; these degrees are:
- Required (green) – visible and mandatory field;
- Read only (white) – not editable;
- Optional (white) – optional field visible;
- Hidden (white) – optional field, initially hidden;
- No access (red) – the user does not see this field.
Additionally, if a given type has been assigned to a form that is currently inactive, the color will be gray. Additionally, if the document has Automatic generation selected, a printer symbol will appear next to the form number on which it is used.
Example of assigning document types to forms.
In the example above, the first type is assigned to three forms and the second type to one. The first type is mandatory in the form with id 6, optional, hidden or read-only in forms 7 and 8, and is generated automatically in form 7. The second type is assigned only to form 6 and there is no access to it.
Editing document types
After pressing an item on the list or selecting edit from action, a simple screen for editing the document type will open. It will be possible to set the API name (1), label (2), hints (3), whether only downloading the template is allowed (4), selecting the mentioned template when we have several of them assigned to a given type (5), folder (6), as well as the forms in which the type is to be used (7), as well as setting the above-mentioned. due(8) and possible automatic generation(9). After making the modifications, it is necessary to select Save(10) in the lower right corner.
Document type edit window
It is also possible to change the order of document types on the form. To modify it, select Edit in the upper right corner and then use the arrows to set the desired order.
Editing the order on the form
Adding and removing document typesTo add a new type, first select Add. A new window will appear in which you will be able to use the search engine to find the type you are looking for (1) and then select one of the templates assigned to it (2). It will then be possible to assign a folder to which the documents will be sent after the Case is completed (3). Finally, we can immediately assign the type to existing forms(4).
Add document type screen
To remove a given type, simply click on the red trash can icon in the Actions column. A window will appear asking for confirmation, after which the type will disappear from our Case.
Import and export of document types
If necessary, our settings can be easily exported and saved locally using the Export button (1). A new file in .JSON format will then be created and saved on our computer. If necessary, this file can be easily uploaded using the Import button (2).
Export and import document type settings
Note: The import works on an incremental basis, i.e. if the imported file does not contain any types that are currently assigned to the Case, these types will not be removed, and only previously absent types will appear.