Workflows properties
- 20 Nov 2022
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Workflows properties
- Updated on 20 Nov 2022
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
This article applies to DELIVER EMPOWER licensing
Purpose of the article
This article describes the set of properties available for configuring workflows.
Basic properties
property
| Editable | Type | ? | Values | Description |
|---|---|---|---|---|
| id | Digital | No | Unique workflow identifier assigned to authoring | |
| creationUserId | userId | No | UserId | Unique identifier of the user who created the workflow |
| creationDate | Date | No | Date the workflow was created | |
| lastUpdateUserId | userId | No | UserId | Unique identifier of the user who recently modified the workflow |
| lastUpdateDate | Date | No | Date the workflow was modified | |
| label | Free text | Yes | Workflow Name | |
| description | Free text | Yes | Description for internal use | |
| targetType | Enumeration | No | LIBRARY_MAPPING (Documents) | Object type that initiated the workflow |
| usePreviousStartCard | Boolean | Yes | When starting a new workflow version on the same target, a value of TRUE allows the conversation of the parameters used for the previous execution | |
| forceMetaFromTarget | Boolean | Yes | Force the use of target fields even when usePreviousStartCard is active | |
| labelMask | free text | Yes | A character string based on mustach syntax. Example: PRJ-{{meta1}}-{{meta2}} The keys match the keys on the boot card If the value is empty, the name of the target is used. | The labelMask allows you to create a structured name for the workflow based on the metadata of the boot card |
| templateId | Digital | No | Identifier of the template used to generate the header page. This field is automatically edited by Cooperlink. | |
| icon | Free text | Yes | For example: fa-building | Font Awesome code of the desired icon https://fontawesome.com/icons |
| longCommentsItem | key | Yes | Key of the field concerned e.g. company_project_comment | Identifies the comment field that is replaced on the header page when it is too long. |
| longCommentsLimit | digital | Yes | 150 | The maximum character length allowed for a long comment. Beyond that it is replaced by an alternative text |
| longCommentsWarning | free text | Yes | Long comment. Please read the commentary on the following page. | Alt text when the comment exceeds the limit allowed by longCommentsLimit |
Properties of states
| Type | property values | description | |
|---|---|---|---|
| Name | key | Name of the state used as a key in workflow execution |
Properties of createCard actions
| Type | property values | description | |
|---|---|---|---|
| objectType | .actions. CreateCard | Creating a card | |
| key | key | Single key of the action | |
| title | free text | {"literal" : "text"} | Title of the task supporting the action |
| description | free text | {"literal" : "text"} | Description of the task supporting the action |
| addTask | Boolean | Creating a task that supports the action | |
| cardDesignId | cardId | Choosing the approval card template associated with the task | |
| assignedUser | userId or metadataDefinition | User / Partner assigned to the task | |
| dueDate > remainingDays | digital | 7 | Default task due time |
| dueDate > metadataDefinition | metadataDefinition | Option to change the due date via metadata | |
| dueDate > onlyWorkingDays | Boolean | true | Indicates whether the delay calculation is based on calendar days or working days. The calculation of working days take into account the days of leave entered in the settings of the application. |
waitFor action properties
| Type | property values | description | |
|---|---|---|---|
| objectType | .actions. WaitForOpenCards | Action pending closing of the card of the previous action | |
| key | key | Single key of the action | |
| stateName | stateName | Name of the associated state | |
| completeIfNOK | Boolean | Terminates workflow if cards respond negatively | |
| outMetaData | metaDataKey | Key of the targetType card metadata in which the engine stores the result of this action | |
| outValueIfOK | metaDataValue | Value of metadata identified by outMetaData in case of a positive response | |
| OutValueIfNOK | metaDataValue | Value of metadata identified by outMetaData in case of negative response |
Sequence properties
| Type Value | Description | ||
|---|---|---|---|
| Endpoint | Null | N/A | |
| From | key | Key to the initial action | |
| To | key | Key to destiny action |
MetadataDefinition
Use this object to associate a property with a field in the boot card.
| Type Value | Description | ||
|---|---|---|---|
| elementType | type | CARD | Identifies the type of metadata |
| name | key | E.g. company_project_delay_phase1 | Identifies the reference metadata key |
Was this article helpful?