Skip to content

Commit 81ed8b3

Browse files
Cortex-DMSCortex-DMS
authored
Add Flow Editor User Guide (#218)
1 parent 42a2d6e commit 81ed8b3

File tree

91 files changed

+1702
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+1702
-5
lines changed

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Dev"
3+
linkTitle: "Dev"
4+
description: "This section includes user guides related to the Development section in {{% ctx %}} Gateway."
5+
weight: 1
6+
---

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Flow Editor"
3+
linkTitle: "Flow Editor"
4+
description: "View, edit and debug flows in {{% ctx %}} Gateway."
5+
weight: 1
6+
---

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Bottom Panel"
3+
linkTitle: "Bottom Panel"
4+
description: "View executions, identify issues preventing the flow from being debugged, and create and manage variables."
5+
weight: 50
6+
---

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/executions-grid.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: "Executions Grid"
3+
linkTitle: "Executions Grid"
4+
description: "View executions being debugged."
5+
weight: 20
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Executions Grid displays information about all the [flows][What is a Flow?] that are currently being debugged by the developer.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Executions Grid.png" title="Executions Grid" >}}
17+
18+
The Executions Grid is automatically displayed when in `Debug` mode and a flow is `Running` or `Paused`; however, it may be manually opened, or closed any time by clicking the Open/Close handle or resized by dragging the handle up or down.
19+
20+
Flows that are `Running` or `Paused` are shown with a green background; flows that have raised an [exception][What is an Exception?] are shown with a red background.
21+
22+
An [execution][What is an Execution?] may be selected by clicking on its row and can be controlled by action icons at the top right of the Executions Grid. Multiple executions can be selected using `Ctrl + Click` or `Shift + Click`. Selected executions are indicated with a darker background and the actions available are dependent on the state of the selected executions; greyed-out action icons are not applicable to the selected executions’ state.
23+
24+
## Actions
25+
26+
### Continue the Execution
27+
28+
Clicking the {{< image src="/images/Flow Editor - Continue Execution.png" >}} icon causes the selected executions to continue until the flow ends, a breakpoint is reached, or [`Break on exception`][Execution Options] is enabled and an exception has occurred causing the flow to pause. This action is only available for paused executions.
29+
30+
See the [Continue and Stop the Execution][Continue and Stop the Execution tutorial] tutorial for a step-by-step guide.
31+
32+
### Pause the Execution
33+
34+
Clicking the {{< image src="/images/Flow Editor - Pause Execution.png" >}} icon pauses the selected executions. This action is only available for running executions.
35+
36+
### Step the Execution
37+
38+
Clicking the {{< image src="/images/Flow Editor - Step Execution.png" >}} icon causes the selected executions to execute the next [block][What is a Block?] and pause again. This action is only available for paused executions.
39+
40+
See the [Step the Execution][Step the Execution tutorial] tutorial for a step-by-step guide.
41+
42+
### Stop the Execution
43+
44+
Clicking the {{< image src="/images/Flow Editor - Stop Execution.png" >}} icon stops the the selected executions, and after a few seconds, removes them from Executions Grid. This action is available for all executions, regardless of their state.
45+
46+
See the [Continue and Stop the Execution][Continue and Stop the Execution tutorial] tutorial for a step-by-step guide.
47+
48+
### Go To
49+
50+
Clicking the {{< image src="/images/Flow Editor - Go To.png" >}} icon causes the Flow Editor to open the [workspace][What is a Workspace?] which the selected execution is executing and focus on the location of the execution. It is typically used to locate the selected execution when the execution is not automatically tracked. This action is available for all executions, regardless of their state.
51+
52+
See the [Stop Tracking and Go To][Stop Tracking and Go To tutorial] tutorial for a step-by-step guide.
53+
54+
### Start Tracking
55+
56+
Clicking the {{< image src="/images/Flow Editor - Start Tracking.png" >}} icon causes the Flow Editor to follow the selected execution, opening any necessary workspaces. This action is available for any execution not being tracked.
57+
58+
Note: When an execution is started, if no other executions are being tracked, it will be automatically tracked if [`Show execution on workspace`][Execution Options] is enabled.
59+
60+
See the [Start Tracking][Start Tracking tutorial] tutorial for a step-by-step guide.
61+
62+
### Stop Tracking
63+
64+
Clicking the {{< image src="/images/Flow Editor - Stop Tracking.png" >}} icon causes the tracking of the execution to stop, and the Flow Editor will not follow the selected execution. This action is available for any execution being tracked.
65+
66+
See the [Stop Tracking and Go To][Stop Tracking and Go To tutorial] tutorial for a step-by-step guide.
67+
68+
### Show Initial Flow First / Show Initial Flow Last
69+
70+
Clicking the {{< image src="/images/Flow Editor - Show First.png" >}} (Show Initial Flow First) or {{< image src="/images/Flow Editor - Show Last.png" >}} (Show Initial Flow Last) icon changes the order of the hierarchy of parent and child flow executions, placing the parent execution uppermost and its children below, or the child execution uppermost and it's parent below. When {{< image src="/images/Flow Editor - Show First.png" >}} is clicked the icon changes to {{< image src="/images/Flow Editor - Show Last.png" >}} and vice versa. This action applies to all executions in the Executions Grid.
71+
72+
See the [Show Initial Flow First or Last][Show Initial Flow First or Last tutorial] tutorial for a step-by-step guide.
73+
74+
## Remarks
75+
76+
### Known Limitations
77+
78+
None
79+
80+
## See Also
81+
82+
### Related Concepts
83+
84+
* [Blocks][]
85+
* [Exceptions][]
86+
* [Executions][]
87+
* [Flows][]
88+
* [Workspaces][]
89+
90+
### Related Tutorials
91+
92+
* [Continue and Stop the Execution][Continue and Stop the Execution tutorial]
93+
* [Step the Execution][Step the Execution tutorial]
94+
* [Stop Tracking and Go To][Stop Tracking and Go To tutorial]
95+
* [Start Tracking][Start Tracking tutorial]
96+
* [Show Initial Flow First or Last][Show Initial Flow First or Last tutorial]
97+
98+
[Continue and Stop the Execution tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.ContinueStopExecution" >}}
99+
[Show Initial Flow First or Last tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.ShowFirstLast" >}}
100+
[Step the Execution tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.StepExecution" >}}
101+
[Stop Tracking and Go To tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.StopTrackingGoTo" >}}
102+
[Start Tracking tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.StartTracking" >}}
103+
104+
[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
105+
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
106+
[Execution Options]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.ExecutionOptions" >}}
107+
[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
108+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
109+
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
110+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
111+
[What is a Workspace?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc" >}}
112+
[What is an Exception?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.WhatIsAnException.MainDoc" >}}
113+
[What is an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}}
114+
[Workspaces]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc" >}}

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/messages-grid.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Messages Grid"
3+
linkTitle: "Messages Grid"
4+
description: "Identify issues preventing a flow from being debugged."
5+
weight: 30
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Messages Grid lists any [issues][What is a Message?] preventing a [flow][What is a Flow?] from being debugged.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Messages Grid.png" title="Messages Grid" >}}
17+
18+
The Messages Grid is automatically displayed if there are any issues when attempting to debug a flow; however, it may be manually opened, or closed any time by clicking the Open/Close handle or resized by dragging the handle up or down.
19+
20+
Each message identifies the location of the issue, a summary of the issue, and a detailed explanation.
21+
22+
## Actions
23+
24+
### Navigate to Issue
25+
26+
If the issue in the flow is related to a misconfigured block [property][What is a Block Property?], double-clicking on the message will automatically navigate to, and select, the [block][What is a Block?] with the issue, open the [Property Editor][] and select the property causing the issue.
27+
28+
See the [Messages Grid][Messages Grid tutorial] tutorial for a step-by-step guide.
29+
30+
## Remarks
31+
32+
### Known Limitations
33+
34+
* Issues with misconfigured input variables in the [Settings Editor][] cannot be navigated to.
35+
36+
## See Also
37+
38+
### Related Concepts
39+
40+
* [Blocks][]
41+
* [Flows][]
42+
* [Messages][]
43+
44+
### Related Tutorials
45+
46+
* [Messages Grid][Messages Grid tutorial]
47+
48+
[Messages Grid tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.MessagesGrid" >}}
49+
50+
[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
51+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
52+
[Messages]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.MainDoc" >}}
53+
[Property Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.PropertyEditor" >}}
54+
[Settings Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.SettingsEditor" >}}
55+
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
56+
[What is a Block Property?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.MainDoc" >}}
57+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
58+
[What is a Message?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc" >}}

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/overview.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: "Overview"
3+
linkTitle: "Overview"
4+
description: "Summary and anatomy of the Bottom Panel."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Bottom Panel displays the current [executions][What is an Execution?] being debugged, any [issues][What is a Message?] preventing the [flow][What is a Flow?] from being debugged and also allows the management of [variables][What is a Variable?].
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Bottom Panel.png" title="Bottom Panel" >}}
17+
18+
The 3 tabs that form the Bottom Panel are:
19+
20+
* Executions (default) - displays the [Executions Grid][] listing current executions being debugged by the developer.
21+
* Messages - displays the [Messages Grid][] listing issues preventing the flow from being debugged.
22+
* Variables - displays the [Variables Grid][] enabling the management of variables.
23+
24+
## See Also
25+
26+
### Related Concepts
27+
28+
* [Executions][]
29+
* [Flows][]
30+
* [Messages][]
31+
* [Variables][]
32+
33+
### Related Tutorials
34+
35+
* [Bottom Panel][Bottom Panel tutorial]
36+
37+
[Bottom Panel tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.MainDoc" >}}
38+
39+
[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
40+
[Executions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.ExecutionsGrid" >}}
41+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
42+
[Messages]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.MainDoc" >}}
43+
[Messages Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MessagesGrid" >}}
44+
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
45+
[Variables Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.VariablesGrid" >}}
46+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
47+
[What is a Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}}
48+
[What is a Message?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc" >}}
49+
[What is an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}}

0 commit comments

Comments
 (0)