Workflows properties
  • 20 Nov 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Workflows properties

  • Dark
    Light
  • PDF

Article summary

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

EditableType?ValuesDescription
idDigitalNo
Unique workflow identifier assigned to authoring
creationUserIduserIdNoUserIdUnique identifier of the user who created the workflow
creationDateDateNo
Date the workflow was created
lastUpdateUserIduserIdNoUserIdUnique identifier of the user who recently modified the workflow
lastUpdateDateDateNo
Date the workflow was modified
labelFree textYes
Workflow Name
descriptionFree textYes
Description for internal use
targetTypeEnumerationNoLIBRARY_MAPPING (Documents)Object type that initiated the workflow
usePreviousStartCardBooleanYes
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
forceMetaFromTargetBooleanYes
Force the use of target fields even when usePreviousStartCard is active
labelMaskfree textYesA 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
templateIdDigitalNo
Identifier of the template used to generate the header page. This field is automatically edited by Cooperlink.
iconFree textYesFor example: fa-buildingFont Awesome code of the desired icon
https://fontawesome.com/icons
longCommentsItemkeyYesKey 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.
longCommentsLimitdigitalYes150The maximum character length allowed for a long comment. Beyond that it is replaced by an alternative text
longCommentsWarningfree textYesLong 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 valuesdescription
Namekey
Name of the state used as a key in workflow execution

Properties of createCard actions

Type
property valuesdescription
objectType
.actions. CreateCardCreating a card
keykey
Single key of the action
titlefree text{"literal" : "text"}Title of the task supporting the action
descriptionfree text{"literal" : "text"}Description of the task supporting the action
addTaskBoolean
Creating a task that supports the action
cardDesignIdcardId
Choosing the approval card template associated with the task
assignedUseruserId or metadataDefinition
User / Partner assigned to the task
dueDate > remainingDaysdigital7Default task due time
dueDate > metadataDefinitionmetadataDefinition
Option to change the due date via metadata
dueDate > onlyWorkingDaysBooleantrueIndicates 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 valuesdescription
objectType
.actions. WaitForOpenCardsAction pending closing of the card of the previous action
keykey
Single key of the action
stateNamestateName
Name of the associated state 
completeIfNOKBoolean
Terminates workflow if cards respond negatively
outMetaDatametaDataKey
Key of the targetType card metadata in which the engine stores the result of this action
outValueIfOKmetaDataValue
Value of metadata identified by outMetaData in case of a positive response
OutValueIfNOKmetaDataValue
Value of metadata identified by outMetaData in case of negative response

Sequence properties

Type Value

Description
Endpoint
NullN/A
Fromkey
Key to the initial action
Tokey
Key to destiny action

MetadataDefinition

Use this object to associate a property with a field in the boot card.

Type Value

Description
elementTypetypeCARDIdentifies the type of metadata
namekeyE.g. company_project_delay_phase1Identifies the reference metadata key

Was this article helpful?