Skip to content

Commit 2a735d3

Browse files
Merge branch 'Maria_Workflows_Studio' into development
2 parents 46cdd92 + d87af66 commit 2a735d3

File tree

12 files changed

+35
-8655
lines changed

12 files changed

+35
-8655
lines changed
15.6 KB
Loading
-8.29 KB
Loading
8.01 KB
Loading
-10.3 KB
Loading

content/studio/general.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,14 @@ The top menu bar items are described in the table below:
131131

132132
You can copy and paste pages and microflows. You can also cut, copy, and paste separate elements such as widgets or microflow activities.
133133

134-
### 8.1 Copy/Paste Pages, Microflows, and Enumerations {#copy-paste-documents}
134+
### 8.1 Copy/Paste Workflows, Pages, Microflows, and Enumerations {#copy-paste-documents}
135135

136-
Pages, microflows, and enumerations can be copied to clipboard and then pasted to a different Studio app. You can also copy and paste pages, microflows, and enumerations to the same app, however, there is the **Duplicate** option you can use for this purpose. For more information on how to copy, paste, or duplicate pages, microflows, and enumerations, see [Pages](page-editor), [Microflows](microflows), and [Enumerations](domain-models-enumeration) respectively.
136+
Workflows, pages, microflows, and enumerations can be copied to clipboard and then pasted to a different Studio app. You can also copy and paste them to the same app, however, there is the **Duplicate** option you can use for this purpose. For more information on how to copy, paste, or duplicate workflows, pages, microflows, and enumerations, see [Workflows](workflows), [Pages](page-editor), [Microflows](microflows), and [Enumerations](domain-models-enumeration) respectively.
137137

138138
Mind the following when copying and pasting pages, microflows, and enumerations:
139139

140-
* You can copy/paste pages, microflows, and enumerations only to Studio apps that have the same Mendix version
141-
* You can copy/paste pages, microflows, and enumerations only between instances of the same browser
140+
* You can copy/paste workflows, pages, microflows, and enumerations only to Studio apps that have the same Mendix version
141+
* You can copy/paste workflows, pages, microflows, and enumerations only between instances of the same browser
142142
* You *cannot* copy/paste from Studio to Studio Pro or vice versa
143143

144144
### 8.2 Cut/Copy/Paste Separate Elements

content/studio/workflow-properties.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ The **Data** section contains information on what data context the workflow is u
3939

4040
![Data Section](attachments/workflow-properties/data.jpg)
4141

42-
**Workflow entity** is an entity that is used as a workflow context. This entity should be of a workflow entity type. For more information, see the [Entities and Their Types](domain-models#entity-types) section in the *Domain Model*.
42+
**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.
43+
44+
This entity should be of a workflow entity type. For more information, see the [Entities and Their Types](domain-models#entity-types) section in the *Domain Model*.
4345

4446
### 2.3 Display Information Section {#display-info}
4547

@@ -66,7 +68,7 @@ This section is only displayed when the security is on. For more information, se
6668

6769
### 2.4 Due Date Section {#due-date}
6870

69-
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.
71+
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.
7072

7173
![Due Date Section](attachments/workflow-properties/due-date.jpg)
7274

content/studio/workflow-system-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The section properties are described in the table below:
3131

3232
| Property | Description |
3333
| --------- | ------------------------------------------------------------ |
34-
| Caption | The **Caption** describes what happens in this element. It is displayed in the workflow element to make the workflow easier to read and understand. |
34+
| Caption | The **Caption** describes what happens in this element. It is displayed in the workflow editor to make the workflow easier to read and understand. |
3535
| Microflow | The microflow that is called by this element. |
3636

3737
### 2.3 Parameters Section {#parameters}

content/studio/workflows-general-activities.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,15 @@ The **General** section properties are described in the table below:
3636

3737
| Property | Description |
3838
| --------- | ------------------------------------------------------------ |
39-
| Caption | Describes what happens in this element. It is displayed in the workflow element to make the workflow easier to read and understand. |
39+
| Caption | Describes what happens in this element. It is displayed in the workflow editor to make the workflow easier to read and understand. |
4040
| Condition | **Condition** is configured based on an [expression](/refguide/expressions). The expression should result in a Boolean or an enumeration.<br />For the expression resulting in a Boolean, two paths are possible: **true** and **false**. For example, you can use the expression resulting in a Boolean to follow different processes whether a new employee is working from home or from the office (and either send their devices to the home address or set up a workstation in the office).<br /> |
4141

4242
#### 2.1.2 Outcomes Section {#outcome}
4343

4444
**Outcomes** depends on the condition of the decision. For example, for the Boolean, you have **true** and **false** outcomes, and for the enumeration: an outcome per each enumeration value and an empty one when the value is unassigned.
4545

46+
To change the order of outcomes, click the **Outcome** property and drag it.
47+
4648
## 3 Jump Activity {#jump}
4749

4850
The **Jump** activity allows you to jump to other activities in the workflow. This is useful when, for example, you are approving a request and need more details that are provided in one of the previous user tasks:
@@ -64,18 +66,18 @@ The Jump activity properties consist of the **General** section and are describe
6466
| Property | Description |
6567
| -------- | ------------------------------------------------------------ |
6668
| Name | The internal name of the element. When referring to the element in the you will use this name. It must be unique. |
67-
| Caption | Describes what happens in this element. It is displayed in the workflow element to make the workflow easier to read and understand. |
69+
| Caption | Describes what happens in this element. It is displayed in the workflow editor to make the workflow easier to read and understand. |
6870
| Target | **Target** is the activity the **Jump** goes to. You can select the activity you would like to go to from the drop-down menu. |
6971

7072
## 4 Parallel Split {#parallel-split}
7173

72-
The parallel split is used to have parallel processes in your workflow. For example, when onboarding a new employee, you can have several processes running in parallel: the HR preparing necessary documents, the IT department preparing a workstation, and the Administration department scheduling a training for the employee:
74+
The parallel split is used to have parallel processes in your workflow. For example, when onboarding a new employee, you can have several processes running in parallel: the HR department preparing necessary documents, the IT department preparing a workstation, and the Administration department scheduling a training for the employee:
7375

7476
![Parallel Split Example](attachments/workflows-general-activities/parallel-split-example.jpg)
7577

7678
{{% alert type="info" %}}
7779

78-
All paths of the parallel split need to be completed before the workflow can continue to the next activity.
80+
The workflow will only continue to the next activity when all paths of the parallel split have been completed.
7981

8082
{{% /alert %}}
8183

@@ -98,6 +100,8 @@ The **Caption** describes what happens in this element. It is displayed in the w
98100

99101
The **Paths** property allows you to add as many paths as there are parallel processes.
100102

103+
To change the order of paths, click the **Paths** property and drag it.
104+
101105
## 5 End Activity {#end}
102106

103107
The **End** activity ends the path of the workflow.

content/studio/workflows-user-task.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: ["workflow", "workflows", "user task", "task"]
77

88
## 1 Introduction
99

10-
User task allows you to assign a workflow task to a certain user.
10+
User task allows you to assign a workflow task to a certain user or a group of users.
1111

1212
For example, you can add filters and assign a task to the IT department. When the workflow reaches this user task, the task will appear in their inbox.
1313

@@ -32,7 +32,7 @@ User task properties consist of the following sections:
3232

3333
### 2.2 User Assignment Section {#user-assignment}
3434

35-
**Assign user task using** allows you to manage what users the task will be assigned to. You can filter users or implement a more complicated logic and add several checks using a microflow.
35+
**Assign user task using** allows you to manage which users can pick up the task. You can filter users or implement a more complicated logic and add several checks using a microflow.
3636

3737
![User Assignment](attachments/workflows-user-task/user-assignment.jpg)
3838

@@ -41,17 +41,17 @@ Possible options of this property are described in the table below:
4141
| Option | Description |
4242
| --------- | ------------------------------------------------------------ |
4343
| Filter | Allows you to filter users who should be assigned to the user task. For example, you can assign a certain task only to users with the Administrator user role. For more information on how to use filters, see [Data Filters](data-filters). |
44-
| Microflow | Allows you to assign the user task to certain users. Using microflow you can check, for example, what users have the right to approve user tasks and are currently not on vacation and assign the task only to users who passed the check. For more information on microflows, see [Microflows](microflows). |
44+
| Microflow | Allows you to assign the user task to certain users. Using a microflow you can check, for example, what users are in the right department and are currently not on vacation and assign the task only to users who passed the check. For more information on microflows, see [Microflows](microflows). |
4545

4646
### 2.3 Task Page Section {#task-page}
4747

48-
**Page** is an overview page where the allowed roles can track the progress of the user tasks and view its details, such as open tasks, comments to them or attachments:
48+
**Page** is the page that an assigned user will use to inspect their task and complete it:
4949

5050
![Task Page](attachments/workflows-user-task/task-page.jpg)
5151

5252
### 2.4 Display Information Section {#display-info}
5353

54-
The **Display Information** section defines the user task name and its description that are displayed in the running (published) app.
54+
The **Display Information** section defines the user task name and its description that are displayed in the running (published) app, for example, in the user's task inbox and on the task page.
5555

5656
![Display Information](attachments/workflows-user-task/display-information.jpg)
5757

@@ -64,7 +64,7 @@ The **Display Information** section properties are described in the table below:
6464

6565
### 2.4 Due Date Section {#due-date}
6666

67-
The **Due Date** section allows you to set a deadline for the user task and keep track of it. However, this is not an automatic reminder but rather a deadline you reference when keeping track of the workflow.
67+
The **Due Date** section allows you to set a deadline for the user task 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 overdue tasks on a dashboard.
6868

6969
![Due Date Section](attachments/workflows-user-task/due-date.jpg)
7070

@@ -84,7 +84,7 @@ The **Outcomes** property allows you to create new outcomes for the user task. T
8484

8585
### 2.7 Events Section {#events}
8686

87-
**On Create** event allows you to select a microflow that is executed immediately after users have been determined for a newly created task instance. You can use this setting for a microflow that will send an email notification about the user task to the assigned users.
87+
**On Create** event allows you to select a microflow that is executed immediately after users have been determined for a newly created task. For example, you can use this setting for a microflow that will send an email notification about the user task to the assigned users.
8888

8989
![Events Section](attachments/workflows-user-task/events.jpg)
9090

content/studio/workflows.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Workflows"
33
description: "Describes the workflows in Mendix Studio."
4-
menu_order: 55
4+
menu_order: 15
55
tags: ["workflow", "workflows", "Studio"]
66
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
77
---
@@ -12,15 +12,15 @@ This functionality is in Beta. For more information on Beta products, see [Mendi
1212

1313
## 1 Introduction
1414

15-
Workflow is a visual language in Mendix Studios that allows you to build extendable processes. It is fully integrated with other visual languages, such as the microflow editor and page editor.
15+
Workflow is a visual language in Mendix Studio and Mendix Studio Pro that allows you to to solve your business problems that involve processes. It is fully integrated with other visual languages, such as the microflow editor and page editor.
1616

17-
The main difference of workflows from [microflows](microflows) is a waiting aspect – the workflow is paused until it gets an input from an end-user. For example, an employee sends a travel request (triggering the start of the workflow) and then the workflow is paused until a manager approves the request by clicking a button.
17+
The main difference between workflows and [microflows](microflows) is a waiting aspect – the workflow is paused until it gets an input from an end-user. For example, an employee sends a travel request (triggering the start of the workflow) and then the workflow is paused until a manager approves the request by clicking a button.
1818

19-
To view the workflows of your in Studio, click the **Workflows** icon in the left menu bar:
19+
To view the workflows of your app in Studio, click the **Workflows** icon in the left menu bar:
2020

2121
![Workflow Icon](attachments/workflows/workflow-icon.jpg)
2222

23-
Workflows is a visual way of expressing application logic. A workflow looks like a flow chart. On a new workflow a *start activity* (a starting point of the workflow) and an *end activity* (an endpoint of the workflow) are created by default. You can add various activities to a flow of a workflow that is called a *path*.
23+
Workflows are a visual way of processing logic in your application. A workflow looks like a flow chart. On a new workflow a *start activity* (a starting point of the workflow) and an *end activity* (an endpoint of the workflow) are created by default. You can add various activities to a flow of a workflow that is called a *path*.
2424

2525
![Workflow Example](attachments/workflows/workflow-example.jpg)
2626

@@ -52,7 +52,7 @@ The selected workflow is opened.
5252

5353
### 3.2 Adding a Workflow {#create}
5454

55-
To add a workflow to your in Studio, do the following:
55+
To add a workflow to your app in Studio, do the following:
5656

5757
1. Click the workflow icon in the left menu bar.
5858

@@ -94,7 +94,7 @@ To copy and paste a workflow, do the following:
9494

9595
3. Open the Studio app where you want to paste the workflow and press <kbd>Ctrl</kbd> +<kbd>V</kbd> or <kbd>Cmd</kbd> +<kbd>V</kbd>.
9696

97-
Your workflow is pasted. For more information on copy/paste function in Studio, see the [Copy/Paste Pages, Microflows, and Enumerations](general#copy-paste-documents) section in *General Info*.
97+
Your workflow is pasted. For more information on copy/paste function in Studio, see the [Copy/Paste Workflows, Pages, Microflows, and Enumerations](general#copy-paste-documents) section in *General Info*.
9898

9999
### 3.5 Deleting a Workflow {#delete}
100100

@@ -138,18 +138,18 @@ The elements of this section are described in the table below:
138138
| Start activity | The starting point of a workflow. Workflows are triggered either by the [Call workflow](page-editor-widgets-events-section#call-workflow) on-click event on pages or by the [Workflow call](microflows#microflow-workflow-activities) action in microflows. <br />Click the start event to open [workflow properties](workflow-properties). |
139139
| [Decision](workflows-general-activities#decision) | Makes a choice based on a condition and follows one and only one of the outgoing paths. |
140140
| [Jump activity](workflows-general-activities#jump) | Allows you to jump to other activities in the workflow. |
141-
| [Parallel split](workflows-general-activities#parallel-split) | Adds two parallel paths to your workflow. |
141+
| [Parallel split](workflows-general-activities#parallel-split) | Adds two or more parallel paths to your workflow. |
142142
| [End activity](workflows-general-activities#end) | Ends the path of the workflow |
143143

144144
### 4.2 User Actions {#user-actions}
145145

146-
[User task](workflows-user-task) – a central element in a workflow that allows you to assign a task to a certain user using filters or microflows.
146+
[User task](workflows-user-task) – a central element in a workflow that allows you to assign a task to a certain user or a group of users using filters or microflows.
147147

148148
![User Actions](attachments/workflows/user-actions.jpg)
149149

150150
### 4.3 System Actions {#system}
151151

152-
[Call microflow](workflow-system-actions) activity calls a selected microflow.
152+
[Call microflow](workflow-system-actions) activity calls a selected microflow. You can use this activity to add application logic to the path of the workflow that does not need user interaction.
153153

154154
![System Actions](attachments/workflows/system-actions.jpg)
155155

0 commit comments

Comments
 (0)