πŸ”’Data input via Forms, using Roles to partition user activities.

For a demo example of following steps, here is the policy timestamp: 1675164605.096601003

Objective

Construct a policy in which one group of users can individually fill in and submit documents for approval and view their own documents’ status, and another group of users can view and take approve/reject actions on any of these user documents.

Approach

  1. Assign β€˜User’ and β€˜Approver’ roles to users to partition them into groups where one can fill in forms and send resulting documents to approvals, and the other group would β€˜approve/reject’ these documents.

  2. Create schema and necessary policy elements to enable β€˜form-filling in and submission’ and β€˜approval’ workflows.

Preparation

Create 3 containers which will be responsible for choosing a role, submission and approval documents correspondingly.

Assign these containers to appropriate Permissions: β€˜no_role’, β€˜User’, or β€˜Approver’, and add the first containers into the RoleSelectionBlock.

See detailed information about the Roles in Example 1.

Main section

Creating the document

1. Create a schema for Policy data input

1.1 Go to β€˜Schemas’ tab and create a new schema

1.2 To make sure there is some demo/test data content in this schema create 3 fields:

  • Organization name of type β€˜String’

  • Start Date of type β€˜Date’

  • End Date of type β€˜Date’

  • Amount of type β€˜Number to represent the amount of CO2 emissions for the time period (between the β€˜Start Date’ and β€˜End Date’)

2. To perform data input into the Policy the β€˜requestVcDocumentBlock’ will be used

2.1 Since the scope of this example includes input of multiple documents the Policy requires logic similar to what is known as β€˜loop’ or β€˜iteration’.

For this β€˜interfaceStepBlock’ is required with β€˜Cyclic’ option enabled. This will allow to return to the initial state after the document was saved.

2.2 Add β€˜requestVcDocumentBlock’ into the β€˜cyclic_container’

2.3 Then select the previously created Schema

2.4 Select β€˜New UUID’ to configure automatic generation of unique IDs for each document

2.5 By default β€˜requestVcDocumentBlock’ is displayed as a Form covering the entire page. To prevent this choose β€˜DIALOG’ value for the field β€˜Type’.

3. Save documents in the Database.

3.1 Add β€˜sendToGuardianBlock’ into the container β€˜cyclic_container’ immediately after β€˜create_new_document’

3.2 Select data type and where to store the document

3.3 Create appropriate attributes to capture/store document status

Add β€˜Status’ attribute and set the initial β€˜New’ value for new documents

Displaying the documents

  1. To display documents β€˜interfaceDocumentsSourceBlock’ is used

1.1 Add ’interfaceDocumentsSourceBlock’ into the β€˜user_roles’ container

1.2 Specify the needed columns, their titles and where the values will be taken for display

1.3 To retrieve the data from the database ’documentsSourceAddon’ block is used

1.3.1 Add β€˜documentsSourceAddon’ to the β€˜user_grid’

1.3.2 Select where to retrieve the documents from

1.3.3 Select the schema upon which the selected documents should be based on

1.3.4 Select β€˜Owned by User’ checkbox which would filter in only the documents that are created by this user (this will disable the ability to view other documents)

Approving the documents

  1. To display documents β€˜interfaceDocumentsSourceBlock’ is used

1.1 As in the previous section we added β€˜interfaceDocumentsSourceBlock’ and configured displayed columns

1.2 Add additional column which would contain the β€˜Approve’ button

1.3 Since the Approve button should be displayed only for new documents use two β€˜documentSourceAddon’ block

Configure both β€˜documentSourceAddon’ blocks similarly to how it was in the previous sections, except here do not select the β€˜Owned by User’ checkbox to allow the Approvers to see all documents (created by all users)

1.4 Separate the documents by status by means of creating the corresponding filters

  1. To enable actions (in this example β€˜Approve’ and β€˜Reject’) the β€˜buttonBlock’ block is used.

2.1 Best practice is to wrap the β€˜buttonBlock’ block in a container

Switch off the β€˜Default Active’ option to avoid specifying the button as an independent element and hide it

2.2 Create 2 buttons for β€˜Approve’ and β€˜Reject’ correspondingly.

2.3 β€˜buttonBlock’ is responsible only for the actions, in order to save the refreshed status of the documents.

Create 2 β€˜sendToGuardianBlock’ blocks with the corresponding values for the β€˜Status’.

2.4 By default blocks are always directly connected to the next block (just below it). To decouple the blocks select β€˜Events’ tab and switch off the default events for both blocks.

2.5 Connect events from the β€˜buttonBlock’ with the corresponding β€˜sendToGuardianBlock’ by selecting the Events tab and create 2 new events.

  1. Return to the grid settings and add the created buttons into the previously prepared column

3.1 Set β€˜Type’ to β€˜BLOCK’

3.2 Set β€˜Bind Block’ to the block which we can place into the column

3.3 In order to display the buttons for only new documents set the corresponding value for the β€˜Bind Group'

Result

1. Choose a role

2. Create new document

3. Approve

Last updated