Skip to content

Add Flow Editor User Guide #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Jun 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
af954ff
Added initial structure for Flow Editor User Guide
May 7, 2025
5576ac5
Modified Tutorials ordering and final 1st version of Flow Editor Over…
May 8, 2025
4412c81
Added Navigation Bar first pass content
May 8, 2025
16209ca
First pass of Left Panel added
May 8, 2025
6e08f76
Started adding Main Panel content
May 9, 2025
2182c55
added Main Panel content first pass
May 9, 2025
ad1e398
modified typo in main panel
May 9, 2025
29f2b33
changes following PO review
May 13, 2025
e817bd8
Modified Overview following review
May 13, 2025
2d3036d
modified Nav Bar content
May 13, 2025
57e133e
Added Tutorials
May 13, 2025
b5f3fc0
updated tutorials
May 15, 2025
9aa5931
Started adding Right Panel content
May 15, 2025
3728dbd
made changes
May 19, 2025
49d55f6
finished first pass of Property Editor
May 20, 2025
99d13c1
Added Initial Execution Viewer Content
May 20, 2025
eeba691
Added Initial Content for Settings Editor
May 20, 2025
7e718a9
Initial content of Exceptions Viewer added
May 21, 2025
58326f3
Changes following PO Review
May 21, 2025
d8810f0
made further changes
May 21, 2025
d16824d
fixed typo
May 22, 2025
703397d
Added Executions Grid
May 22, 2025
1fa2367
Added Initial Variables Grid content
May 22, 2025
7fdfa2a
Finished Reviewing Main Panel
May 22, 2025
dad5b7a
Changes following PO Review
May 27, 2025
f948462
added Change Data Type action
May 27, 2025
447f3bd
updated known limitations
May 27, 2025
4080fc0
finalised intial content for Flow Editor
May 28, 2025
b7ad7d6
Changes following further PO Review
May 29, 2025
fe6fc08
Made changes to structure following PO review
May 30, 2025
1210ca6
Changes following further PO Review
Jun 3, 2025
91e4441
Final PO Review
Jun 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Dev"
linkTitle: "Dev"
description: "This section includes user guides related to the Development section in {{% ctx %}} Gateway."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Flow Editor"
linkTitle: "Flow Editor"
description: "View, edit and debug flows in {{% ctx %}} Gateway."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Bottom Panel"
linkTitle: "Bottom Panel"
description: "View executions, identify issues preventing the flow from being debugged, and create and manage variables."
weight: 50
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: "Executions Grid"
linkTitle: "Executions Grid"
description: "View executions being debugged."
weight: 20
---

# {{% param title %}}

## Summary

The Executions Grid displays information about all the [flows][What is a Flow?] that are currently being debugged by the developer.

## Anatomy

{{< figure src="/images/Flow Editor - Executions Grid.png" title="Executions Grid" >}}

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.

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.

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.

## Actions

### Continue the Execution

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.

See the [Continue and Stop the Execution][Continue and Stop the Execution tutorial] tutorial for a step-by-step guide.

### Pause the Execution

Clicking the {{< image src="/images/Flow Editor - Pause Execution.png" >}} icon pauses the selected executions. This action is only available for running executions.

### Step the Execution

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.

See the [Step the Execution][Step the Execution tutorial] tutorial for a step-by-step guide.

### Stop the Execution

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.

See the [Continue and Stop the Execution][Continue and Stop the Execution tutorial] tutorial for a step-by-step guide.

### Go To

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.

See the [Stop Tracking and Go To][Stop Tracking and Go To tutorial] tutorial for a step-by-step guide.

### Start Tracking

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.

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.

See the [Start Tracking][Start Tracking tutorial] tutorial for a step-by-step guide.

### Stop Tracking

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.

See the [Stop Tracking and Go To][Stop Tracking and Go To tutorial] tutorial for a step-by-step guide.

### Show Initial Flow First / Show Initial Flow Last

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.

See the [Show Initial Flow First or Last][Show Initial Flow First or Last tutorial] tutorial for a step-by-step guide.

## Remarks

### Known Limitations

None

## See Also

### Related Concepts

* [Blocks][]
* [Exceptions][]
* [Executions][]
* [Flows][]
* [Workspaces][]

### Related Tutorials

* [Continue and Stop the Execution][Continue and Stop the Execution tutorial]
* [Step the Execution][Step the Execution tutorial]
* [Stop Tracking and Go To][Stop Tracking and Go To tutorial]
* [Start Tracking][Start Tracking tutorial]
* [Show Initial Flow First or Last][Show Initial Flow First or Last tutorial]

[Continue and Stop the Execution tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.ContinueStopExecution" >}}
[Show Initial Flow First or Last tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.ShowFirstLast" >}}
[Step the Execution tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.StepExecution" >}}
[Stop Tracking and Go To tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.StopTrackingGoTo" >}}
[Start Tracking tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.StartTracking" >}}

[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
[Execution Options]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.ExecutionOptions" >}}
[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
[What is a Workspace?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc" >}}
[What is an Exception?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.WhatIsAnException.MainDoc" >}}
[What is an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}}
[Workspaces]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: "Messages Grid"
linkTitle: "Messages Grid"
description: "Identify issues preventing a flow from being debugged."
weight: 30
---

# {{% param title %}}

## Summary

The Messages Grid lists any [issues][What is a Message?] preventing a [flow][What is a Flow?] from being debugged.

## Anatomy

{{< figure src="/images/Flow Editor - Messages Grid.png" title="Messages Grid" >}}

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.

Each message identifies the location of the issue, a summary of the issue, and a detailed explanation.

## Actions

### Navigate to Issue

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.

See the [Messages Grid][Messages Grid tutorial] tutorial for a step-by-step guide.

## Remarks

### Known Limitations

* Issues with misconfigured input variables in the [Settings Editor][] cannot be navigated to.

## See Also

### Related Concepts

* [Blocks][]
* [Flows][]
* [Messages][]

### Related Tutorials

* [Messages Grid][Messages Grid tutorial]

[Messages Grid tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.MessagesGrid" >}}

[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
[Messages]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.MainDoc" >}}
[Property Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.PropertyEditor" >}}
[Settings Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.SettingsEditor" >}}
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
[What is a Block Property?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.MainDoc" >}}
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
[What is a Message?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "Overview"
linkTitle: "Overview"
description: "Summary and anatomy of the Bottom Panel."
weight: 10
---

# {{% param title %}}

## Summary

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?].

## Anatomy

{{< figure src="/images/Flow Editor - Bottom Panel.png" title="Bottom Panel" >}}

The 3 tabs that form the Bottom Panel are:

* Executions (default) - displays the [Executions Grid][] listing current executions being debugged by the developer.
* Messages - displays the [Messages Grid][] listing issues preventing the flow from being debugged.
* Variables - displays the [Variables Grid][] enabling the management of variables.

## See Also

### Related Concepts

* [Executions][]
* [Flows][]
* [Messages][]
* [Variables][]

### Related Tutorials

* [Bottom Panel][Bottom Panel tutorial]

[Bottom Panel tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.MainDoc" >}}

[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
[Executions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.ExecutionsGrid" >}}
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
[Messages]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.MainDoc" >}}
[Messages Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MessagesGrid" >}}
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
[Variables Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.VariablesGrid" >}}
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
[What is a Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}}
[What is a Message?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc" >}}
[What is an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}}
Loading