Workflow action dialog box – Applaud Support

Use this dialog box to add and configure a workflow action.

Set property	Use this workflow action to set the value of a selected model's property, either based on another property or a specific value.
Clear property	Use this workflow action to clear a model's property value or a related model's property value.
Add if/then branch	Use this workflow action to branch workflow logic based on a condition.
Send notification	Use this workflow action to send a notification of a particular type.
Create task	Use this workflow task to send a task to a user.
Approval	Use this workflow action to send an approval task to a user.
Create model instance	Use this workflow action to populate a model's property with a calculated value from another property or with an exact value.
Add delay	Use this workflow action to delay a workflow action by a specific period.
Retrieve information	Use this workflow action to retrieve information to use in another workflow action.
Assign or revoke role	Use this workflow action to assign or revoke a user's role.
Trigger integration	Use this workflow action to integrate with third-party systems.

Set property

Target instance	The model schema, which contains the property that you want to set the value for automatically.
Target Property	The property within the model schema that you want to set the value for automatically.
Base the value on	Indicates what you want to base the value of the property on. You can either base the value on another property or set the value to be the same each time.
New Property value	Based on your previous selection, you can either type in a value or select a value to be entered here by selecting the Token button.
Token	The list of available properties that you can select.

Clear property

Target instance	The model schema, which contains the property that you want to clear the value for automatically.
Target Property	The property within the model schema that you want to clear the value for automatically.

Add if/then branch

Conditions

Property	The model schema property.
Criteria	A list of possible conditions to be met.
Value	The value that you want the condition of the property to meet.
Add child actions to	Two options are available: True - Adds child actions if the property value meets the conditions stipulated. False - Adds child actions if the property value doesn't meet the conditions stipulated.

Send notification

Send to	Either a specific user name or a user type, for example, <owner's manager>.
Subject	You can type this and then select the items that change. For example, Absence submitted for <Name>. Select Token and choose the item you want.
Body	Again you can type the content that you want to show with items that change. For example, The leave balance for <Name> is currently <Leave balance>. Select Token and choose the item you want.

Notification type

You can choose from existing notification types or create your own. Any you create are added to the list of available types.

Choose an existing notification type	The dialog box doesn't change, and you can select a notification type from the list available.
Create new notification type	Changes the dialog box to add new fields so that you can add your own notification type.
Type	The list of available notification types available.
Title	The title of your new notification type.
Internal name of new type	What you refer to the notification type, this is populated automatically, but you can change this.
Icon of new type	The list of available icons that you can choose for your new notification type.
Default channels for new type	Sends the notification in the selected channels: Email - Sends the notification in an email. Mobile - Sends the notification in a text message. Desktop - Sends the notification to appear in the Applaud tenant.
Link to page	A list of available pages in your Applaud tenant.
Open in a modal window	Indicates that your notification type opens in a new dialog box.

Create task

Assign to	The user to who you want to assign the task.
Title	The title of the task.
Notes	Any instructions to aid the user in completing the task. You can use HTML when setting up tasks in workflow.
Impact on workflow	Indicates how you want the task to affect the workflow process: Blocking - Workflow can't continue until the task is completed. Non-blocking - Workflow can continue after creating this task.

Task actions

Choose what you want to happen when the user selects the task. You can also add a context menu to add further actions.

Remove primary 'Mark as complete' action	When selected, the user can't mark the task as complete, and only a workflow or API can mark this task as completed. For example, if the task requires the user to complete a form, a workflow action can mark the task as completed once the user submits the form. To do this, you look up the Task Id and use a Set Property workflow action to mark it as completed.
Primary action	Only appears if you select the Remove primary 'Mark as complete' action option. Link to the task details modal page - When your user selects the task, the task detail dialog box opens. Link to another page - When your user selects the task, it opens the form directly.
Link to page	Only appears if you selected the Remove primary 'Mark as complete' action option and the Link to another page option from the Primary action section. The page you want to open when the user selects the task.
Page instance ID	Only appears if you selected the Remove primary 'Mark as complete' action option, the Link to another page option from the Primary action section, and when the page is linked to a modal. The instance-id that you want to pass to the page so that the correct data is shown.
Open in a modal window	Only appears if you selected the Remove primary 'Mark as complete' action option, the Link to another page option from the Primary action section, and when the page is linked to a modal. This indicates that you want the page to open in a dialog box rather than a new page.
Include secondary actions	These show alongside the primary action and allow you to include supplementary links to other pages or external URLs.
Title	The title of your task action.
Type of action	How the task appears to the user, for example, either in a dialog box or a new tab in the browser.
Target	A list of available pages within your Applaud tenant.
	Collapses the task action row extra options.
	Expands the task action row extra options.
Icon	A list of available icons.
Color	The color of the task message.
Weight	The weight of the font used in the message.
	Removes the task action row.
	Adds another task action row.
Allow task to be deleted	This is only available if you select the Non-blocking option from the Impact on workflow.
Task type	You can use an existing task type or create a new one: Choose an existing task type - You can select from the tasks available. Create a new task type - You can create a new task type.
Task type	A list of all available task types.
Title	The title of your new task type.
Internal name of new type	The name of your new task type populated automatically from the Title, but you can change this.
Icon of new type	A list of available icons to choose from.

Due date and reminder

Due date	Setting this removes any actions on tasks and you can set a date when the task is set to complete.
Due	Indicates when the user should complete the task. Immediately A set number of days after creation
Days from task creation	Calculates a due date from this number of days from when the task was created.
At time	The specific time of the day that the task is due.
Set a reminder	A list of available reminder duration periods. For example, 15 minutes before.
Show a link to the completed form	This only appears if you have triggered your workflow from the submission of a form. This allows the task assignee to view the submitted form data.
Notify assignee when created	Sends a notification to the assigned user with details of the required task. This is selected by default.

Approval

Approver	Either a specified user each time or a user based on a model property.
Title	The title of the task or action that needs approval.
Notes	Any rules or instructions for the approver.

Task actions

Choose what you want to happen when the user selects the task. You can also add a context menu to add further actions.

Remove primary 'Mark as complete' action	When selected, the user can't mark the task as complete, and only a workflow or API can mark this task as completed. For example, if the task requires the user to complete a form, a workflow action can mark the task as completed once the user submits the form. To do this, you look up the Task Id and use a Set Property workflow action to mark it as completed.
Primary action	Only appears if you select the Remove primary 'Mark as complete' action option. Link to the task details modal page - When your user selects the task, the task detail dialog box opens. Link to another page - When your user selects the task, it opens the form directly.
Link to page	Only appears if you selected the Remove primary 'Mark as complete' action option and the Link to another page option from the Primary action section. The page you want to open when the user selects the task.
Page instance ID	Only appears if you selected the Remove primary 'Mark as complete' action option, the Link to another page option from the Primary action section, and when the page is linked to a modal. The instance-id that you want to pass to the page so that the correct data is shown.
Open in a modal window	Only appears if you selected the Remove primary 'Mark as complete' action option, the Link to another page option from the Primary action section, and when the page is linked to a modal. This indicates that you want the page to open in a dialog box rather than a new page.
Include secondary actions	These show alongside the primary action and allow you to include supplementary links to other pages or external URLs.
Title	The title of your task action.
Type of action	How the task appears to the user, for example, either in a dialog box or a new tab in the browser.
Target	A list of available pages within your Applaud tenant.
	Collapses the task action row extra options.
	Expands the task action row extra options.
Icon	A list of available icons.
Color	The color of the task message.
Weight	The weight of the font used in the message.
	Removes the task action row.
	Adds another task action row.
Allow task to be deleted	This is only available if you select the Non-blocking option from the Impact on workflow.
Task type	You can use an existing task type or create a new one: Choose an existing task type - You can select from the tasks available. Create a new task type - You can create a new task type.
Task type	A list of all available task types.
Title	The title of your new task type.
Internal name of new type	The name of your new task type populated automatically from the Title, but you can change this.
Icon of new type	A list of available icons to choose from.

Due date and reminder

Due date	Setting this removes any actions on tasks and you can set a date when the task is set to complete.
Due	Indicates when the user should complete the task. Immediately A set number of days after creation
Days from task creation	Calculates a due date from this number of days from when the task was created.
At time	The specific time of the day that the task is due.
Set a reminder	A list of available reminder duration periods. For example, 15 minutes before.
Show a link to the completed form	This only appears if you have triggered your workflow from the submission of a form. This allows the task assignee to view the submitted form data.
Notify assignee when created	Sends a notification to the assigned user with details of the required task. This is selected by default.

Approve or Reject

Add child actions to

Approve
Reject

Create model instance

Model	A list of the available models within your Applaud tenant.
Label	This populates with the model name automatically, but you can amend this to what you want.
Property	The list of properties available in the model.
Base the value on	The options to base the value on: A value from another property - You can populate the Value field. Selected by default. A static value - You can type your value in the Static value.
Value	Selected by default. Select Token to add an expression.
Static value	A text box appears after you select the A static value from the Base the value on options. The exact value you want the property to be.

Add delay

Days	The number of days that you want to defer the workflow for. You can type 0 if you just want this to be less than a day.
Hours	How long you want to defer the workflow. You can type 0 if you want this to be less than an hour.
Minutes	The number of minutes that you want to defer the workflow for.

Retrieve information

Retrieve from model	The list of available models in your Applaud tenant.
Label	A meaningful label that helps you refer to this in later workflow actions,

Conditions

Select the property and the conditions that you want the property to meet.

Property	The model's property.
Criteria	A list of possible conditions to be met.
Value	The value that you want the condition of the property to meet.

Sort

The result of your conditions is retrieved in a single instance. If more than one instance is returned, one is picked randomly unless you specify a sort order here.

Property	The property to sort by.
Direction	The order that you want to sort by.

Assign or revoke role

Assign a new role	This option assigns the selected role when the action is taken on the selected workflow property.
Revoke an existing role	This option revokes the selected role when the action is taken on the selected workflow property.
User	The workflow property that contains the user ID.
Role	The list of available roles in your Applaud tenant.

Trigger integration

Connector	The type of integration connector: Note Once you create this action, you cannot amend the connector from here. You would need to delete this action and create a new one. Applaud Integration Recipe. Note If you use this connector, you need to create an integration recipe that links to this trigger. Webhook
Label	For an Applaud Integration Recipe connector, this is a "Trigger integration recipe" by default. For a Webhook connector, this is "Trigger webhook" by default. If you see a number appended to the label, this means that this workflow already has an integration trigger action with that default label.
Status	This indicates if the connector is: Live - Has a URL. Not live - Doesn't have a URL.
Method	This is the action that the web-hook takes on the third-party system. Options available are: POST - Create new data. PUT - Update existing data. GET - Read data. DELETE - Delete data.
Webhook URL	This needs to start with https://.

Tasks you can perform here:

Create a workflow

See more:

About model workflows

Sections in this article

Set property

Clear property

Add if/then branch

Conditions

Send notification

Notification type

Create task

Task actions

Due date and reminder

Approval

Task actions

Due date and reminder

Approve or Reject

Create model instance

Add delay

Retrieve information

Conditions

Sort

Assign or revoke role

Trigger integration

Note

Note

Tasks you can perform here:

See more:

Sections in this article