|
| 1 | +--- |
| 2 | +title: "Flows Explorer" |
| 3 | +linkTitle: "Flows Explorer" |
| 4 | +description: "Browse, search and create flows and groups in {{% ctx %}} Gateway." |
| 5 | +weight: 1 |
| 6 | +--- |
| 7 | + |
| 8 | +# {{% param title %}} |
| 9 | + |
| 10 | +## Summary |
| 11 | + |
| 12 | +The Flows Explorer allows developers to browse and search the hierarchical structure of [flows][What is a Flow?] and extend the hierarchy by creating new groups and flows. |
| 13 | + |
| 14 | +## Anatomy |
| 15 | + |
| 16 | +{{< figure src="/images/Flows Explorer.png" title="Flows Explorer" >}} |
| 17 | + |
| 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 | + |
| 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 | + |
| 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 | + |
| 24 | +## Actions |
| 25 | + |
| 26 | +### Create a Group |
| 27 | + |
| 28 | +To create a new group: |
| 29 | + |
| 30 | +* [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: |
| 33 | + |
| 34 | + * Enter a `Name` for the new group. A valid name cannot start or end with a full stop, or contain any of the following characters \ / ? * : | " < > &. The name does not have to be unique in the platform but must be unique at the level it is being created at. |
| 35 | + * The `Description` is optional but can be any literal text. |
| 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 LDAP Groups listed. |
| 37 | + |
| 38 | +* Click OK to create the new group. |
| 39 | + |
| 40 | +See the [Create a Group][Create a Group tutorial] tutorial for a step-by-step guide. |
| 41 | + |
| 42 | +### Create a Process |
| 43 | + |
| 44 | +To create a new Process: |
| 45 | + |
| 46 | +* [Browse][] to the group in the hierarchy where the new Process 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: |
| 49 | + |
| 50 | + * Enter a `Name` for the new Process. A valid name can only contain alphabetic, numeric and hyphen characters, whitespace is not allowed. The name must be unique in the platform. |
| 51 | + * The `Description` is optional but can be any literal text. |
| 52 | + * Select the appropriate `Template` for the Process: |
| 53 | + |
| 54 | + * `Blank` - This template will create an empty Process, which can then be developed as required. |
| 55 | + |
| 56 | + See the [Create a Process from a blank template][Create Process 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 can then be extended manually if required. |
| 58 | + |
| 59 | + See the [Create a Process using a BPMN XML template][Create Process 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 will be automatically created, which can then be extended manually if required. |
| 61 | + |
| 62 | + See the [Create a Process using a Natural Language Template][Create Process Natural tutorial] tutorial for a step-by-step guide. |
| 63 | + |
| 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 LDAP Groups listed. |
| 65 | + |
| 66 | +* Click OK to create the new Process. |
| 67 | + |
| 68 | +### Create an Activity |
| 69 | + |
| 70 | +To create a new Activity: |
| 71 | + |
| 72 | +* [Browse][] to the group in the hierarchy where the new Activity 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: |
| 75 | + |
| 76 | + * Enter a `Name` for the new Activity. A valid name can only contain alphabetic, numeric and hyphen characters, whitespace is not allowed. The name must be unique in the platform. |
| 77 | + * The `Description` is optional but can be any literal text. |
| 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 LDAP Groups listed. |
| 79 | + |
| 80 | +* Click OK to create the new Activity. |
| 81 | + |
| 82 | +See the [Create an Activity][Create an Activity tutorial] tutorial for a step-by-step guide. |
| 83 | + |
| 84 | +### Browse |
| 85 | + |
| 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 name to open the flow in the [Main Panel][] of the [Flow Editor][]. |
| 91 | + |
| 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. |
| 93 | + |
| 94 | +See the [Browsing the Flows Explorer][Browsing the Flows Explorer tutorial] tutorial for a step-by-step guide. |
| 95 | + |
| 96 | +### Search |
| 97 | + |
| 98 | +To search the hierarchy, start typing into the search box. All the flow names that contain the search characters will be displayed; the more characters entered, the more refined the search will be, displaying fewer flows. The search is a fuzzy search, which means that even misspelt flow names should identify the intended matching flows. The scope of the search is restricted to the current group and all it's descendant groups. |
| 99 | + |
| 100 | +See the [Searching the Flows Explorer][Searching the Flows Explorer tutorial] tutorial for a step-by-step guide. |
| 101 | + |
| 102 | +### Rename a Flow |
| 103 | + |
| 104 | +Both Processes and Activities may be renamed; it is not possible to rename groups. |
| 105 | + |
| 106 | +To rename a Process or Activity: |
| 107 | + |
| 108 | +* Right-click on the name and select `Rename` from the context menu. |
| 109 | + |
| 110 | + {{% alert title="Note" %}}You must have `Edit` permissions on the Process or Activity to access the `Rename` menu option.{{% /alert %}} |
| 111 | + |
| 112 | +* On the *Rename Flow* dialog: |
| 113 | + |
| 114 | + * Enter a new `Name` for the flow. A valid name can only contain alphabetic, numeric and hyphen characters, whitespace is not allowed. The name must be unique in the platform. |
| 115 | + * Click `OK` to change the name of the flow. |
| 116 | + |
| 117 | +See the [Rename a Flow][Rename a Flow tutorial] tutorial for a step-by-step guide. |
| 118 | + |
| 119 | +## Remarks |
| 120 | + |
| 121 | +### Known Limitations |
| 122 | + |
| 123 | +* Groups cannot be renamed |
| 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. |
| 126 | +* The data entered into the Description field when creating a new group or flow is not surfaced anywhere in the platform. |
| 127 | +* When creating a new item, only the existing permissions may be changed. It is not possible to add additional permissions. |
| 128 | + |
| 129 | +## See Also |
| 130 | + |
| 131 | +### Related Concepts |
| 132 | + |
| 133 | +* [Flows][] |
| 134 | + |
| 135 | +### Related Tutorials |
| 136 | + |
| 137 | +* [Create a Group][Create a Group tutorial] |
| 138 | +* [Create a Process from a blank template][Create Process Blank tutorial] |
| 139 | +* [Create a Process using a BPMN XML template][Create Process BPMN tutorial] |
| 140 | +* [Create a Process using a Natural Language Template][Create Process Natural tutorial] |
| 141 | +* [Create an Activity][Create an Activity tutorial] |
| 142 | +* [Browsing the Flows Explorer][Browsing the Flows Explorer tutorial] |
| 143 | +* [Searching the Flows Explorer][Searching the Flows Explorer tutorial] |
| 144 | +* [Rename a Flow][Rename a Flow tutorial] |
| 145 | + |
| 146 | +[Browsing the Flows Explorer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.Browse" >}} |
| 147 | +[Create a Group tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.CreateGroup" >}} |
| 148 | +[Create Process Blank tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.CreateProcessBlank" >}} |
| 149 | +[Create Process Natural tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.CreateProcessNatural" >}} |
| 150 | +[Create Process BPMN tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.CreateProcessBpmnXml" >}} |
| 151 | +[Create an Activity tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.CreateActivity" >}} |
| 152 | +[Rename a Flow tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.Rename" >}} |
| 153 | +[Searching the Flows Explorer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowsExplorer.Search" >}} |
| 154 | + |
| 155 | +[Browse]: {{< ref "#browse">}} |
| 156 | +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} |
| 157 | + |
| 158 | +[Edit Permissions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}} |
| 159 | +[Flow Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainDoc" >}} |
| 160 | +[Main Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.MainDoc" >}} |
| 161 | +[Studio Authorisation]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.MainDoc" >}} |
| 162 | +[View Permissions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.View" >}} |
| 163 | +[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}} |
0 commit comments