Workflow Properties

Last update: Edit

1 Introduction

This document describes workflow properties. For details on what workflows are for and what kind of elements you can use there, see Workflows.

2 Workflow Properties

Workflow properties consist of the following sections:

2.1 General Section

The General section contains information on the title and name of the workflow.

General Section

The General section properties are described in the table below:

Property Description
Title Defines a title of the workflow that you see at the top of the working area.
Name The internal name of the workflow that must be unique. When referring to the workflow in the app you will use this name.

2.2 Data Section

The Data section contains information on what data context the workflow is using.

Data Section

Workflow entity is an entity that is used as a workflow context. This entity serves as input for the workflow and can hold the data added during the execution of the workflow. For example, for an expense approval process, it holds the amount to approve and the purpose.

This entity should be of a workflow entity type. For more information, see the Entities and Their Types section in the Domain Model.

2.3 Display Information Section

The Display Information section defines the workflow name and its description that are displayed in the running (published) app.

Display Information Section

The Display Information section properties are described in the table below:

Property Description
Workflow Name Workflow name is displayed in the running app. The Workflow name can contain expression outcomes, which will be displayed to the end-users. For example, you can add the FullName attribute value from the Employee Onboarding data to display the name of the new employee. The expression should be return a string value.
Workflow Description Workflow Description is a description of the workflow displayed in the running app. The Workflow name can contain expression outcomes, which will be displayed to the end-users. For example, you can add the FirstDay attribute value from the Employee Onboarding data to display the start date of the new employee and assign them to a training group.

2.4 Permissions Section

Allowed roles defines the user role that can trigger the workflow.

Permissions Section

2.4 Due Date Section

The Due Date section allows you to set a deadline for the workflow and keep track of it. However, this is not an automatic reminder but rather a deadline you reference when keeping track of the workflow. For example, you can use this due date to show workflows that are overdue in a dashboard.

Due Date Section

The Due Date section properties are described in the table below:

Property Description
None No due date is set.
Duration You can set the deadline for the workflow with the Due In option, which indicates the number of hours, days, or weeks the workflow is due in. Possible values of the property are the following ones:
  • Hour(s)
  • Day(s)
  • Week(s)
Expression You can set a due date for the workflow writing an expression. For example, to set a due date to tomorrow, you can use addDays([%CurrentDateTime%], 1). For more information on expressions, see Expressions.

2.5 Admin Page Section

Override Admin Page is an optional page used for displaying all running workflows to the workflow admin. This overrides a generic page used to display any running workflow in the app, for example, when you have a Show Workflow Page set as an on-click action or as a microflow activity and would like to override the page selected for this event/activity.

Workflow Page Section

3 Read More