Activity - Update Invite
Overview
- Remove or updates permissions for a particular role on a certain task, or component
Advanced Editor properties and what they do
Properties shared between activities
Property | What does the property do (in plain english) | Possible values | How to find these values (in plain english) |
displayName | label of the activity | any string | |
comments | additional comments on what the activity do | any string | |
executeWhen | decides on when to execute the activity
| BeforeExecute
AfterExecute
OnExecute
Manual | |
runOnSystemEvents | specify an action event (that starts with $) that this activity will be executed | [”$actionEvent1”, “$actionEvent1”] | |
expression | data path expression if it satisfies then it will execute this activity | e.g. "'{$.asset.id}' = “123" |
Properties unique to this activity
- All of these unique properties sit within a “properties” object e.g.
{
"property one shared between components": "",
"properties": {
"entityType": "",
"etc": "",
}
}
Property | What does the property do (in plain english) | Possible values | How to find these values (in plain english) |
TargetDataPath | Specifies the path in the data model where the target data is located. | A string value, e.g., "$user.details.name" | Identify the specific path in the data structure where the target data can be found. This path should match the schema used in the system |
Initiator | Identifies the entity or user that initiated the action or process. | A string value, e.g., "Admin" , "System" | Determine who or what triggered the action. This is usually set to the name of the user or system process that initiated the action.
These strings are defined in the roles section of the workflow |
StepName | Represents the name of the step in the process. | A string value, e.g., "Approval" , "Review" | Define the name of the step within the workflow. This should correspond to the logical or business step in the process. |
RemovePermissionAndSkipSendingInvite | A boolean that determines whether to remove permissions and skip sending an invite for this process. (default : false) | true or false
(default : false) | Decide whether permissions should be removed and the invite should be skipped. If yes, set to true ; otherwise, leave to default false . |
Advanced Editor example of this activity fully set up
{
"continueOnError": false,
"executeWhen": "AfterExecute",
"runOnSystemEvents": [],
"properties": {
"targetDataPath": "$.datapath",
"initiator": "seller",
"stepName": "step",
"removePermissionAndSkipSendingInvite": false
}
}