Parameter Entities values in the Work Portal

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Work Portal > Work Portal Administration >

Parameter Entities values in the Work Portal

Parameter entities can be administered from the Work Portal by end users in order to modify, add or disable records.

Once a project has been deployed, only Parameter entities declared as Manageable in Production environment will be available for end users to administer.

 

Add a Record to a Parameter entity

1. In the Admin menu select the Entities option. A new window will display the list of the Parameter entities.

 

ManageParameterEntities1

 

2. Select the Parameter entity that will be modified. Recall only Parameter entities designed as Manageable in production environment will be shown in the list.

You can use the search field to simplify the search.

 

ManageParameterEntities2

 

3. Select the Parameter entity.
On the right, the Parameter entity table will display. The columns that are shown are the ones defined as Display form.

You can add a new record to the entity using the Plus sign in the bottom of the table.

 

ManageParameterEntities3

 

4. Another window will display to fill-in the attributes.

 

ManageParameterEntities16

 

Records in Parameter entities cannot be deleted. For this reason, they have a Disabled property to flag it as unused (logical delete).

Disabled records will only be shown in existing cases (pending or closed) that references them.

 

ManageParameterEntities4

 

Fill the form with the required information and click Save.

If no changes were saved, it is possible to cancel the request (return to the previous screen) by clicking Cancel.

 

ManageParameterEntities7

 

Edit a Record from a Parameter entity

1. In the Admin menu select the Entities option. A new window will display the list of Parameter entities.

 

ManageParameterEntities1

 

2. Select the Parameter entity to modify.

 

ManageParameterEntities2

 

3. On the right, the Parameter entity table will display. Select the record to edit and click the Edit button on the bottom of the table.

 

ManageParameterEntities8

 

4. The information pertaining to the selected record is displayed.

 

ManageParameterEntities5

 

Make the required changes and click Save.

If no changes were saved, it is possible to cancel the request (return to the previous screen) by clicking Cancel.

 

ManageParameterEntities9

 

Batch upload/edit of parametric entity values

1. In the Admin menu select the Entities option. A new window will display the list of Parameter entities.

 

ManageParameterEntities1

 

2. Select the Parameter entity to modify and click Manage entity records.

 

ManageParameterEntities36

 

3. Click Download template. A new file download starts. The name of this file is EntityData_[Parameter name].xlsx.

 

ManageParameterEntities37

 

4. This new file contains your already existing values.

 

ManageParameterEntities38

 

5. To add a new record, fill a row under the last record. Do not fill the BizKey and id columns since these values will be generated later by Bizagi ignoring any value in this field.

 

ManageParameterEntities39

 

6. You can also change the available records in this file to update their value.

 

note_pin

Keep in mind that some columns are not editable to protect your data integrity.

 

ManageParameterEntities40

 

To add a relationship with another parametric entity you should follow the next format [nameEntity], [key1] = "[value1]". If the business key is a compound key use this format [nameEntity], [key1] = "[value1]", [key2] = "[value2]"

 

If you want to add a relationship to a system table, in the cell you must write the value of a particular attribute of the record. The following table shows which attribute you must use for each table:

 

Entity

Attribute

WFUSER        

'domain\username'

LOCATION        

locDisplayName

AREA        

areaDisplayName

ROLE        

roleDisplayName

SKILL        

skillDisplayName

ORGPOSITION        

posDisplayName

WORKINGTIMESCHEMA        

wtsName

ORG        

orgName

BATIMEZONE        

tzDisplayName

LANGUAGE        

CultureDisplayName

 

note_pin

Through this method, you cannot update images, files or a relationship to a master entity.

 

7. Once you have added all your records to the Excel file save it and upload it to Bizagi by clicking Upload records

 

note_pin

The size of the Excel file must be lower than the limit established in the Upload Max File Size parameter that you configure in the Advanced tab of the Environment settings. See Environment configuration.

 

ManageParameterEntities41

 

8. Upload your file and wait for the process to end.

If the upload finished successfully your new records appear in the right panel.

 

ManageParameterEntities42

 

If you can not see a record or change you wanted to add you can check the log created by the process by clicking Record upload report.

 

ManageParameterEntities43

 

This report contains a brief description of the errors that occurred.

 

ManageParameterEntities44

 

Customize forms for Entity administration

Bizagi defines by default forms for the administration of Parameter entities in the Work Portal. These forms display all the attributes defined for the entity without having to select extra options. You can customize these forms to be able to display, add and edit the records as required. For further information please refer to Administrable Forms for Parameter Entities

 

Column Filters

When Bizagi displays the records of the parameter entity in the Work Portal, you can use some filter to retrieve more specific records. By default, you must register the value that you want to apply in the filter.

 

ManageParameterEntities45

 

If you use a customize form to manage the parameter entity, refer to Management forms for Parameter entities. and you include a relationship with another entity. For example, the entity Cause, has a relationship with entity Type of Request:

 

ManageParameterEntities46

 

The filter in the table's column, displays a drop-down list with the values of the related entity.

 

ManageParameterEntities47

 

The records displayed in the drop-down list (e.g Claim, Complaint, Petition, Suggestion) depend on the display attribute that is configured in the parameter entity's properties (right-click the entity in the Expert view and select properties).

 

ManageParameterEntities48


Last Updated 1/6/2022 5:28:13 PM