| Version | Date | Notes | By |
|---|---|---|---|
| 1.0 | 2021-02-05 | Initial release | ROB |
| 1.1 | 2023-06-19 | Adding recent developments | ROB |
| 1.2 | 2025-05-07 | Adding missing components | ROB |
Note: System is still in early development. Missing propper PDF and Excel editors, graphics and other components. Visually it is still janky (editor) and very simple (pdf, excel).
The interface system is what governs the disposition of information (interactive or not) when exposing information about cases (token process instances).
This system is used in user activities to place information and forms for the responsibles to fill in (note: it does not control the form itself, only where it will appear; the form is provided by the dynamic attribute system).
This system is also used to create reports in PDF and Excel, as well as view only pages that can be consulted by users. The available components are filtered based on use (User Activity, Visualization, PDF, Excel) and based on scope (Case, Process).
As of writting this document, check document version to see if there were any changes.
These components allow for forms to have custom actions besides the standard "Back", "Save" and "Submit". The custom actions can be:
The action form groups together many actions (visually all actions are displayed inside the same row of buttons).
This component places a chart in the spot it ocupies (for the PDF and Visualization it uses ECharts and for the Excel it prompts excel to generate the chart acording to its internal tools).
For the moment the chart is very basic, using information from root variables only and having no customization (You can select bar, pie and line charts and the attribute from witch the values will be retrieved / aggregated).
This component creates a datagrid with configurable columns and permanent filters. The component acts in every way like a datatable (including reordering by clicking on the column). Can be placed in process scoped views.
This component displays the first element of a multiple variable relation (related to a root variable or single variable preceding the selected variable definition via the selected relation).
This component can list multiple variables of multiplicity multiple by allowing the user to create columns to be displayed, and, for each variable, which attribute corresponds to each column. The information of the variables will be displayed by order of creation (forming a linear history).
This creates a panel, that can contain all the other components (allows the user to define the title, header color and whether the panel is closed by default).
This creates a form group, that contains other components (including but not limited to form components).
This component simply inserts unformated text at the position it is placed.
This component simply inserts formated text at the position it is placed.
This component is a fast way to include a group of actions that include the back button, the save draft button and the submit button.
This component exposes information in a two column table format. The first column contains the name of the field and the second contains the value.
This component exposes information about a collection of variables in a list fashion. The header contains names of fields and the body contains the values of the fields (one row per variable in collection).
This component places a form component (text, number, selector, etc ...) that will allow the user to enter / edit the value of that variable / attribute. Since the separation from the dynamic attribute system, this component is directy related only to a local data type table and that table determines the fields that are valid for use in this component for a given variable / attribute.
This component functions like the simple horizontal table but the values come from a collection of cases rather than a collection of variable instances from a single case.
This component represents the worksheet of an excel file (can have multiple worksheets, each with it's own grid with elements).
This component represents the page excluding the header and footer. All PDF interface components must be placed inside this one.
This component is optional and, if not defined, will cause the report to use the standard header. Any components placed inside the header will be displayed as the header.
This component is optional and, if not defined, will cause the report to use the standard footer. Any components placed inside the footer will be displayed as the footer.
Serves as a link to a given view (the view is configured in this component).
This component groups (contains) tabs
This component is a tab and contains other components (allowing for organizing a form by tabs for example).
These components act like the bootstrap counterparts when used in the frontend and PDF reports. The excel reports also use rows and columns but with key diferences
| Component | Frontend and PDF | Excel |
|---|---|---|
| Row | Width is 100% of container | Width is total width of all the columns placed inside of it (with no limit to the number of columns that can be placed). |
| Column | Height is height of contained elements | Height is total height of all contained elements (with no limit to the number of elements contained) |
It is possible to define an interface for the frontend (inside the process only for now) that can be reused as a template throughout the process. When using a template, the template will be placed as a special "template" component that replicates the sub components of the template as the sub component of the "template" component.