You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/2025.5/Guides/user-guides/user-interfaces/gateway/dev/flows-explorer.md
+60-43Lines changed: 60 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,91 +17,102 @@ The Flows Explorer allows developers to view and navigate the hierarchical struc
17
17
18
18
Flows are stored in a hierarchical structure to enable the logical grouping of related flows. The hierarchical structure is created using groups. A group is a container that can hold flows or child groups.
19
19
20
-
There can be multiple top-level or root groups. Top-level groups can only be created by users that have the `Admin` role. Lower-level groups and flows may be created by users that have the `Dev` role, and the appropriate `Edit`permissions set in [Studio Authorisation][Studio Authorisation Edit].
20
+
There can be multiple top-level or root groups. Top-level groups can only be created by users that have the `Admin` role. Lower-level groups and flows may be created by users that have the `Dev` role, and the appropriate [`Edit`][Edit Permissions]permissions set in [Studio Authorisation][].
21
21
22
-
Groups that have `Edit` permissions set for users will display a {{< image src="/images/Flows Explorer - Create New.png" >}} icon in the group’s title bar, allowing those users to create flows and groups in this group; any flows or groups created in this way will inherit the same `View`& `Edit` permissions as the group from which they were created.
22
+
Groups that have `Edit` permissions set for users will display a {{< image src="/images/Flows Explorer - Create New.png" >}} icon in the group’s title bar, allowing those users to create flows and groups in this group; any flows or groups created in this way will inherit the same [`View`][View Permissions]& `Edit` permissions as the group from which they were created by default.
23
23
24
24
## Actions
25
25
26
26
### Create a Group
27
27
28
-
To create a new child group, navigate to the group in the hierarchy where the new group is to be created.
28
+
To create a new group:
29
29
30
-
Click on the + (plus symbol) on the group’s title bar and select Group from the dropdown menu of items.
30
+
*[Navigate][Browse] to the group in the hierarchy where the new group is to be created.
31
+
* Click the {{< image src="/images/Flows Explorer - Create New.png" >}} icon on the group’s title bar and select `Group` from the dropdown menu.
32
+
* On the *Create a new Group* dialog:
31
33
32
-
On the Create a new Group form, enter a Name for the new group. The name can be any literal text and can include the space character. The group name does not have to be unique in the system.
34
+
* Enter a `Name` for the new group. The name can be any literal text and can include space characters. The name does not have to be unique in the system but must be unique at the level it is being created at.
35
+
* The `Description` is optional but can be any literal text and can include space characters.
36
+
* The `Permission Groups`, by default, are inherited from the parent group. The inherited `View`/`Edit` permissions may be altered by clicking on the {{< image src="/images/Flows Explorer - Expand Permissions.png" >}} icon, to the right of the label, to reveal the inherited permissions. Tick, or untick, the appropriate `View`/`Edit` permissions for the Security Groups listed.
33
37
34
-
The Description is optional but can be any literal text and can include the space characters.
35
-
36
-
The Permission Groups, by default, are inherited from the parent object. The inherited View/Edit permissions may be altered by clicking on the ^ (open up-arrow) symbol, to the right of the Permission Groups title, to reveal the inherited permissions. Tick, or untick, the appropriate View/Edit permissions for the relevant Security Groups listed.
37
-
38
-
Click OK to finalise and create the new group.
38
+
* Click OK to create the new group.
39
39
40
40
See the [Create a Group][Create a Group tutorial] tutorial for a step-by-step guide.
41
41
42
42
### Create a Process Flow
43
43
44
-
To create a new Process flow, navigate to the group in the hierarchy where the new Process flow is to be created.
45
-
46
-
Click on the + (plus symbol) on the group’s title bar and select Process from the dropdown menu of items.
47
-
48
-
On the Create a new Process form, enter a Name for the new Process flow. The name can be any literal text and can include the hyphen character, but it cannot include the space nor underscore character. The Process flow name must be unique in the system.
44
+
To create a new Process flow:
49
45
50
-
The Description is optional but can be any literal text and can include the space characters.
46
+
*[Navigate][Browse] to the group in the hierarchy where the new Process flow is to be created.
47
+
* Click the {{< image src="/images/Flows Explorer - Create New.png" >}} icon on the group’s title bar and select `Process` from the dropdown menu.
48
+
* On the *Create a new Process* dialog:
51
49
52
-
Select the appropriate Template for the Process flow.
50
+
* Enter a `Name` for the new Process flow. The name can be any literal text and can include the hyphen character, but it cannot include the space or underscore character. The name must be unique in the system.
51
+
* The `Description` is optional but can be any literal text and can include the space characters.
52
+
* Select the appropriate `Template` for the Process flow:
53
53
54
-
* A Blank Template will create an empty Process flow, which can then be developed as required.
54
+
*`Blank` - This template will create an empty process flow, which can then be developed as required.
55
55
56
-
See the [Create a Process Flow from a blank template][Create Process Flow Blank tutorial] tutorial for a step-by-step guide.
56
+
See the [Create a Process Flow from a blank template][Create Process Flow Blank tutorial] tutorial for a step-by-step guide.
57
+
*`BPMN XML` -This template will provide a text box, into which the XML definition of a Process in BPMN may be inserted. The Process flow can then be extended manually if required.
57
58
58
-
* A Natural Language Template will provide a text box, into which the developer can describe the process to be automated in a natural language. Using the power of AI, a Process flow will be automatically created, which can then be extended manually if required.
59
+
See the [Create a Process Flow using a BPMN XML template][Create Process Flow BPMN tutorial] tutorial for a step-by-step guide.
60
+
*`Natural Language` - This template will provide a text box, into which the developer can describe the Process to be automated in a natural language. Using the power of AI, a Process flow will be automatically created, which can then be extended manually if required.
59
61
60
-
See the [Create a Process Flow using a Natural Language Template][Create Process Flow Natural tutorial] tutorial for a step-by-step guide.
62
+
See the [Create a Process Flow using a Natural Language Template][Create Process Flow Natural tutorial] tutorial for a step-by-step guide.
61
63
62
-
* A BPMN XML Template will provide a text box, into which the XML definition of a process in BPMN may be inserted. The resultant Process flow can then be extended manually if required.
64
+
* The `Permission Groups`, by default, are inherited from the parent group. The inherited `View`/`Edit` permissions may be altered by clicking on the {{< image src="/images/Flows Explorer - Expand Permissions.png" >}} icon, to the right of the label, to reveal the inherited permissions. Tick, or untick, the appropriate `View`/`Edit` permissions for the Security Groups listed.
63
65
64
-
See the [Create a Process Flow using a BPMN XML template][Create Process Flow BPMN tutorial] tutorial for a step-by-step guide.
65
-
66
-
The Permission Groups, by default, are inherited from the parent object. The inherited View/Edit permissions may be altered by clicking on the ^ (open up-arrow) symbol, to the right of the Permission Groups title, to reveal the inherited permissions. Tick, or untick, the appropriate View/Edit permissions for the relevant Security Groups listed.
67
-
68
-
Click OK to finalise and create the new Process flow.
66
+
* Click OK to create the new Process flow.
69
67
70
68
### Create an Activity Flow
71
69
72
-
To create a new Activity flow, navigate to the group in the hierarchy where the new Activity flow is to be created.
73
-
74
-
Click on the + (plus symbol) on the group’s title bar and select Activity from the dropdown menu of items.
70
+
To create a new Activity flow:
75
71
76
-
On the Create a new Activity form, enter a Name for the new Activity flow. The name can be any literal text and can include the hyphen character, but it cannot include the space nor underscore character. The Activity flow name must be unique in the system.
72
+
*[Navigate][Browse] to the group in the hierarchy where the new Activity flow is to be created.
73
+
* Click the {{< image src="/images/Flows Explorer - Create New.png" >}} icon on the group’s title bar and select `Activity` from the dropdown menu.
74
+
* On the *Create a new Activity* dialog:
77
75
78
-
The Description is optional but can be any literal text and can include the space characters.
76
+
* Enter a `Name` for the new Activity flow. The name can be any literal text and can include the hyphen character, but it cannot include the space or underscore character. The name must be unique in the system.
77
+
* The `Description` is optional but can be any literal text and can include the space characters.
78
+
* The `Permission Groups`, by default, are inherited from the parent group. The inherited `View`/`Edit` permissions may be altered by clicking on the {{< image src="/images/Flows Explorer - Expand Permissions.png" >}} icon, to the right of the label, to reveal the inherited permissions. Tick, or untick, the appropriate `View`/`Edit` permissions for the Security Groups listed.
79
79
80
-
The Permission Groups, by default, are inherited from the parent object. The inherited View/Edit permissions may be altered by clicking on the ^ (open up-arrow) symbol, to the right of the Permission Groups title, to reveal the inherited permissions. Tick, or untick, the appropriate View/Edit permissions for the relevant Security Groups listed.
81
-
82
-
Click OK to finalise and create the new Activity flow.
80
+
* Click OK to create the new Activity flow.
83
81
84
82
See the [Create an Activity Flow][Create an Activity Flow tutorial] tutorial for a step-by-step guide.
85
83
86
84
### Browse
87
85
88
-
To browse the hierarchy of flow and groups, the Dev charm to enable the Flow Explorer in the Left Panel to display the top-level groups. Click on a Group, as indicated by a > symbol before its name, to navigate into that group and display its contents; the parent groups will be displayed as leaves to the right of the Flow Explorer.
86
+
To browse the hierarchy of flows and groups:
87
+
88
+
* Click on the `Dev` charm on the left of Gateway to open the Flows Explorer and display the top-level groups.
89
+
* Click on a Group, indicated by the {{< image src="/images/Flows Explorer - Group Icon.png" >}} icon before its name, to navigate into that group and display its contents; the parent groups will be displayed as leaves to the right of the Flows Explorer.
90
+
* Click on a Process or Activity flow by clicking on the name to open the flow in the [Main Panel][] of the [Flow Editor][].
89
91
90
-
To navigate back up the hierarchy, click on a group leaf to the right of the Flow Explorer to navigate directly to that group.
92
+
To navigate back up the hierarchy, click on a group leaf to the right of the Flows Explorer to navigate directly to that group.
91
93
92
94
See the [Browsing the Flows Explorer][Browsing the Flows Explorer tutorial] tutorial for a step-by-step guide.
93
95
94
96
### Search
95
97
96
-
To search for flow contained in the current group, or group in the hierarchy below the current group, click in the Flow Explorer search field and enter part of the flow name being sought. The Flow Explorer will display all flows that match or partially match with the search string entered.
98
+
To search for flow contained in the current group, or group in the hierarchy below the current group, click in the Flows Explorer search field and enter part of the flow name to be searched for. The Flows Explorer will display all flows that match or partially match with the string entered.
97
99
98
100
See the [Searching the Flows Explorer][Searching the Flows Explorer tutorial] tutorial for a step-by-step guide.
99
101
100
102
### Rename a Flow
101
103
102
-
Both Process and Activity flows may be renamed; it is not possible rename groups. To rename a flow, right-click on the flow name and select Rename from the context menu. Note: You must have Edit permissions on the flow to access the Rename feature.
104
+
Both Process and Activity flows may be renamed; it is not possible rename groups.
105
+
106
+
To rename a flow:
107
+
108
+
* Right-click on the flow name and select `Rename` from the context menu.
103
109
104
-
Enter a new name for the flow. The name can be any literal text and can include the hyphen character, but it cannot include the space nor underscore character. The flow name must be unique in the system.
110
+
{{% alert title="Note" %}}You must have `Edit` permissions on the flow to access the `Rename` menu option.{{% /alert %}}
111
+
112
+
* On the *Rename Flow* dialog:
113
+
114
+
* Enter a new name for the flow. The name can be any literal text and can include the hyphen character, but it cannot include the space nor underscore character. The flow name must be unique in the system.
115
+
* Click `OK` to change the name of the flow.
105
116
106
117
See the [Rename a Flow][Rename a Flow tutorial] tutorial for a step-by-step guide.
107
118
@@ -110,8 +121,8 @@ See the [Rename a Flow][Rename a Flow tutorial] tutorial for a step-by-step guid
110
121
### Known Limitations
111
122
112
123
* Groups cannot be renamed
113
-
* When performing a search in Flow Explorer, only the matching flows are displayed without any indication of the flow’s location.
114
-
* A search in the Flow Explorer only searches the current group or child groups for matching flows. To search the entire hierarchy, the search must be undertaken at the top-level of the Flow Explorer.
124
+
* When performing a search in Flows Explorer, only the matching flows are displayed without any indication of the flow’s location.
125
+
* A search in the Flows Explorer only searches the current group or child groups for matching flows. To search the entire hierarchy, the search must be undertaken at the top-level of the Flows Explorer.
115
126
* The data entered into the Description field when creating a new group or flow is not surfaced anywhere in the system.
116
127
* When creating a new item, only the existing permissions may be changed. It is not possible to add additional permissions.
117
128
@@ -141,6 +152,12 @@ See the [Rename a Flow][Rename a Flow tutorial] tutorial for a step-by-step guid
141
152
[Rename a Flow tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.Rename" >}}
142
153
[Searching the Flows Explorer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.Search" >}}
0 commit comments