Flow Editor User Guide Updates (#249)

Co-authored-by: Donna-Marie Smith <donna.smith@wearecortex.com>

Author: Cortex-DMS

config/_default/config.toml

@@ -74,6 +74,9 @@ weight = 1
       style = "tango"
       # Uncomment if you want your chosen highlight style used for code blocks without a specified language
       # guessSyntax = "true"
+  [markup.tableOfContents]
+    startLevel = 2
+    endLevel = 4
 
 # Everything below this are Site Params
 

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

@@ -25,6 +25,8 @@ Flows that are `Running` or `Paused` are shown with a green background; flows th
 
 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.
 
+See the [Selecting an Execution][Selecting an Execution tutorial] tutorial for a step-by-step guide.
+
 ### 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.
@@ -91,13 +93,15 @@ None
 
 ### Related Tutorials
 
+* [Selecting an Execution][Selecting an Execution tutorial]
 * [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" >}}
+[Selecting an Execution tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.SelectExecution" >}}
 [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" >}}

content/en/docs/2025.11/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel.md

@@ -47,33 +47,47 @@ At the top of each workspace, a workspace Toolbar displays the workspace name an
 
 When a new workspace is created, it is initially given the default name of `Untitled Workspace`. This should be changed to a meaningful name, which will be displayed in the [breadcrumb trail][] in the [Navigation Bar][].
 
+#### Context Menus
+
+Context menus exist for workspaces and blocks on workspaces.
+
+##### Workspaces
+
+The workspace context menu allows for the pasting of objects copied to the {{% ctx %}} clipboard and creation of notes on the workspace, dependent on the Editor mode selected.
+
+##### Blocks on Workspaces
+
+The block context menu allows for the copying, cutting, deletion, setting and removing of breakpoints and the setting of the next block to execute, dependent on the Editor mode selected.
+
 ## Actions
 
-### Undo
+### Main Toolbar
+
+#### Undo
 
 Available in Editor Modes: `Edit`, `Debug Edit`
 
-The {{< image src="/images/Flow Editor - Undo.png" >}} icon allows the developer to undo changes made to the flow.
+The {{< image src="/images/Flow Editor - Undo.png" >}} icon allows the developer to undo changes made to the flow. The undo action can also be achieved by pressing `Ctrl+Z` on the keyboard.
 
 See the [Undo and Redo Changes][Undo and Redo Changes tutorial] tutorial for a step-by-step guide.
 
-### Redo
+#### Redo
 
 Available in Editor Modes: `Edit`, `Debug Edit`
 
-The {{< image src="/images/Flow Editor - Redo.png" >}} icon allows the developer to redo changes undone by the Undo command.
+The {{< image src="/images/Flow Editor - Redo.png" >}} icon allows the developer to redo changes undone by the Undo command. The redo action can also be achieved by pressing `Ctrl+Y` on the keyboard.
 
 See the [Undo and Redo Changes][Undo and Redo Changes tutorial] tutorial for a step-by-step guide.
 
-### Start an Execution
+#### Start an Execution
 
 Available in Editor Modes: `View`, `Edit`, `Debug`
 
 The {{< image src="/images/Flow Editor - Start Execution.png" >}} icon saves any changes made to the flow to the developer’s local repository, changes the editor mode to `Debug`, and starts [debugging][Executions in Development] the flow.
 
 See the [Start an Execution][Start an Execution tutorial] tutorial for a step-by-step guide.
 
-### Execution Options
+#### Execution Options
 
 Available in Editor Modes: `View`, `Edit`, `Debug`
 
@@ -84,75 +98,149 @@ The {{< image src="/images/Flow Editor - Execution Options.png" >}} dropdown ena
 
 See the [Start an Execution][Start an Execution tutorial] tutorial for a step-by-step guide.
 
-### Edit Flow
+#### Edit Flow
 
 Available in Editor Modes: `Debug` (if user has [`Edit`][Edit] permissions)
 
 The {{< image src="/images/Flow Editor - Edit Flow.png" >}} icon causes a flow that is being debugged to pause and then changes the editor mode to `Debug Edit`.
 
 See the [Edit Flow and Continue Debugging][Edit Flow and Continue Debugging tutorial] tutorial for a step-by-step guide.
 
-### Continue Debugging
+#### Continue Debugging
 
 Available in Editor Modes: `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Continue Debugging.png" >}} icon saves any changes made to the flow to the developer’s local repository and changes the editor mode to `Debug`.
 
 See the [Edit Flow and Continue Debugging][Edit Flow and Continue Debugging tutorial] tutorial for a step-by-step guide.
 
-### Remove all Breakpoints
+#### Remove all Breakpoints
 
 Available in Editor Modes: `View`, `Edit`, `Debug`, `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Remove Breakpoints.png" >}} icon removes all the breakpoints set on the currently selected flow.
 
 See the [Remove All Breakpoints][Remove All Breakpoints tutorial] tutorial for a step-by-step guide.
 
-### Save
+#### Save
 
 Available in Editor Modes: `Edit`, `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Save.png" >}} icon saves any changes made to the flow to the developer’s local repository.
 
 See the [Save and Commit Flow][Save and Commit Flow tutorial] tutorial for a step-by-step guide.
 
-### Commit Flow
+#### Commit Flow
 
 Available in Editor Modes: `Edit`, `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Commit.png" >}} icon saves any changes to the developer's local repository and commits a copy of the flow, without any breakpoints, to the Master Repository. This makes this version of the flow the Master Version, which can be accessed by others with relevant permissions. An asterisk (*) next to the icon indicates that the locally saved version of the flow has not been committed.
 
 See the [Save and Commit Flow][Save and Commit Flow tutorial] tutorial for a step-by-step guide.
 
-### Get the Master Version of this Flow
+#### Get the Master Version of this Flow
 
 Available in Editor Modes: `View`, `Edit`, `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Get Master.png" >}} icon retrieves the Master Version of the flow from the Master Repository and saves it to the developer's local repository, overwriting the version currently being viewed or edited. An asterisk (*) next to the icon indicates that someone else has made changes to the Master version, which differs from the local version of the flow.
 
 See the [Get Master Version of Flow][Get Master Version of Flow tutorial] tutorial for a step-by-step guide.
 
-### Compare Flow with Master Version
+#### Compare Flow with Master Version
 
 Available in Editor Modes: `View`, `Edit`, `Debug`, `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Compare with Master.png" >}} icon saves the flow to the developer’s local repository and opens a new browser window that displays the local version of the flow alongside the Master Version of the flow in the Master Repository, highlighting any differences.
 
 See the [Compare Flow with Master Version][Compare Flow with Master Version tutorial] tutorial for a step-by-step guide.
 
-### Delete
+#### Delete
 
 Available in Editor Modes: `Edit`, `Debug Edit`
 
 The {{< image src="/images/Flow Editor - Delete Flow.png" >}} icon deletes the currently displayed flow.
 
 See the [Delete Flow][Delete Flow tutorial] tutorial for a step-by-step guide.
 
+### Workspace Context Menu
+
+#### Add Note
+
+Available in Editor Modes: `Edit`, `Debug Edit`
+
+Selecting this option will create a Note object on the workspace at the cursor’s location. This allows for the addition of text on the workspace to enhance the understanding of the flow.
+
+See the [Add Notes to Workspaces][Add Notes to Workspaces tutorial] tutorial for a step-by-step guide.
+
+#### Paste
+
+Available in Editor Modes: `Edit`, `Debug Edit` (if an object has been copied or cut to the {{% ctx %}} clipboard)
+
+Selecting this option, or pressing `Ctrl+V` on the keyboard, will paste a copy of the clipboard on to the workspace at the cursor’s location.
+
+See the [Cut, Copy, Paste and Delete Objects][Cut, Copy, Paste and Delete Objects tutorial] tutorial for a step-by-step guide.
+
+### Block Context Menu
+
+#### Copy
+
+Available in Editor Modes: `Edit`, `Debug Edit`
+
+Selecting this option, or pressing `Ctrl+C` on the keyboard, will copy the selected blocks and their configurations, plus any connections between the selected blocks, to the {{% ctx %}} clipboard. This allows a copy of the selected blocks and connections to be pasted on any workspace of any flow open in the Flow Editor.
+
+See the [Cut, Copy, Paste and Delete Objects][Cut, Copy, Paste and Delete Objects tutorial] tutorial for a step-by-step guide.
+
+#### Cut
+
+Available in Editor Modes: `Edit`, `Debug Edit`
+
+Selecting this option, or pressing `Ctrl+X` on the keyboard, will copy the selected blocks and their configurations, plus any connections between the selected blocks, to the {{% ctx %}} clipboard and remove them from the workspace. This allows the selected blocks and connections to be moved to any workspace of any flow open in the Flow Editor.
+
+See the [Cut, Copy, Paste and Delete Objects][Cut, Copy, Paste and Delete Objects tutorial] tutorial for a step-by-step guide.
+
+#### Delete
+
+Available in Editor Modes: `Edit`, `Debug Edit`
+
+Selecting this option, or pressing `Delete` on the keyboard, will delete the selected blocks and any connections between the selected blocks.
+
+See the [Cut, Copy, Paste and Delete Objects][Cut, Copy, Paste and Delete Objects tutorial] tutorial for a step-by-step guide.
+
+#### Add Breakpoint
+
+Available in Editor Modes: `Edit`, `Debug`, `Debug Edit` (if the block does not already have a breakpoint set)
+
+Selecting this option will set a breakpoint above the block.
+
+Note: If multiple blocks have been selected, the `Add Breakpoint` action will only apply to the current block.
+
+See the [Add and Remove Breakpoints][Add and Remove Breakpoints tutorial] tutorial for a step-by-step guide.
+
+#### Remove Breakpoint
+
+Available in Editor Modes: `Edit`, `Debug`, `Debug Edit` (if the block has a breakpoint set)
+
+Selecting this option will cause a breakpoint to be removed.
+
+Note: If multiple blocks have been selected, the `Remove Breakpoint` action will only apply to the current block.
+
+See the [Add and Remove Breakpoints][Add and Remove Breakpoints tutorial] tutorial for a step-by-step guide.
+
+#### Set Next Block to Execute
+
+Available in Editor Modes: `Debug`, `Debug Edit` (if the execution is paused)
+
+Selecting this option will cause the execution token, or the selected execution if there are multiple simultaneous executions, to be moved above the current block.
+
+Note: If multiple blocks have been selected, the `Set Next Block to Execute` action will only apply to the current block. If multiple executions have been selected this option is not available.
+
+See the [Set Next Block to Execute][Set Next Block to Execute tutorial] tutorial for a step-by-step guide.
+
 ## Remarks
 
 ### Known Limitations
 
-None
+* It is not possible to set breakpoints on multiple blocks simultaneously.
 
 ## See Also
 
@@ -167,24 +255,36 @@ None
 
 ### Related Tutorials
 
-* [Undo and Redo Changes][Undo and Redo Changes tutorial]
-* [Start an Execution][Start an Execution tutorial]
-* [Edit Flow and Continue Debugging][Edit Flow and Continue Debugging tutorial]
-* [Remove All Breakpoints][Remove All Breakpoints tutorial]
-* [Save and Commit Flow][Save and Commit Flow tutorial]
-* [Get Master Version of Flow][Get Master Version of Flow tutorial]
-* [Compare Flow with Master Version][Compare Flow with Master Version tutorial]
-* [Delete Flow][Delete Flow tutorial]
+* [Main Toolbar][Main Toolbar Actions tutorials]
+  * [Undo and Redo Changes][Undo and Redo Changes tutorial]
+  * [Start an Execution][Start an Execution tutorial]
+  * [Edit Flow and Continue Debugging][Edit Flow and Continue Debugging tutorial]
+  * [Remove All Breakpoints][Remove All Breakpoints tutorial]
+  * [Save and Commit Flow][Save and Commit Flow tutorial]
+  * [Get Master Version of Flow][Get Master Version of Flow tutorial]
+  * [Compare Flow with Master Version][Compare Flow with Master Version tutorial]
+  * [Delete Flow][Delete Flow tutorial]
+* [Context Menus][Context Menu tutorials]
+  * [Cut, Copy, Paste and Delete Objects][Cut, Copy, Paste and Delete Objects tutorial]
+  * [Add and Remove Breakpoints][Add and Remove Breakpoints tutorial]
+  * [Set Next Block to Execute][Set Next Block to Execute tutorial]
+  * [Add Notes to Workspaces][Add Notes to Workspaces tutorial]
 
 [Main Toolbar]: {{< ref "#main-toolbar" >}}
 [workspaces]: {{< ref "#workspaces" >}}
 
+[Add Notes to Workspaces tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.AddNotes" >}}
+[Add and Remove Breakpoints tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.AddRemoveBreakpoints" >}}
 [Compare Flow with Master Version tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.CompareMaster" >}}
+[Context Menu tutorials]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.ContextMenus" >}}
+[Cut, Copy, Paste and Delete Objects tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.CutCopyPasteDelete" >}}
 [Delete Flow tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.DeleteFlow" >}}
 [Edit Flow and Continue Debugging tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.EditFlow" >}}
 [Get Master Version of Flow tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.GetMaster" >}}
+[Main Toolbar Actions tutorials]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.MainToolbar" >}}
 [Remove All Breakpoints tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.RemoveBreakpoints" >}}
 [Save and Commit Flow tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.SaveCommit" >}}
+[Set Next Block to Execute tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.SetNextBlock" >}}
 [Start an Execution tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.StartExecution" >}}
 [Undo and Redo Changes tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.UndoRedo" >}}
 

content/en/docs/2025.11/Reference/Concepts/fundamentals/executions/executions-in-development.md

@@ -15,7 +15,7 @@ A [flow][] can be debugged in [{{% ctx %}} Gateway][CORTEX Gateway] by clicking
 
 The following parameters can be specified:
 
-- Show execution on workspace - when this is `true`, the token will be shown at every step throughout the [flow][], otherwise the token will only be shown when the execution [pauses][Paused], hits a breakpoint, or an exception occurs when `Break on exception` is `true`
+- Show execution on workspace - when this is `true`, the token will be shown at every step throughout the [flow][], otherwise the token will only be shown when the execution [pauses][Paused], hits a [breakpoint][breakpoint], or an exception occurs when `Break on exception` is `true`
 - Break on exception - when this is `true` the execution will [pause][Paused] when an exception occurs
 
 ## Providing Input Variables
@@ -171,6 +171,7 @@ None
 
 [Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
 [block]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
+[breakpoint]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.AddBreakpoint" >}}
 [connections]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.BlockConnections" >}}
 [Handling Exceptions within a Block]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.HandlingExceptionsWithinABlock.MainDoc" >}}
 

content/en/docs/2025.11/Tutorials/Development/flow-editor/bottom-panel.md

@@ -9,6 +9,10 @@ weight: 50
 
 ## Executions Grid
 
+### Select an Execution
+
+{{< scribe title="Selecting_Executions_Displayed_in_the_Executions_Grid" id="aupnEzLhQ7yZcQaNScvLeg" >}}
+
 ### Continue and Stop the Execution
 
 {{< scribe title="Continue_the_Execution_and_Stop_the_Execution" id="Y1VaqZLTQlaLm6bS5c_jGQ" >}}

content/en/docs/2025.11/Tutorials/Development/flow-editor/main-panel.md

@@ -7,34 +7,54 @@ weight: 30
 
 # {{% param title %}}
 
-## Undo and Redo Changes
+## Main Toolbar
+
+### Undo and Redo Changes
 
 {{< scribe title="Redo_and_Undo_Flow_Changes" id="iv4tSynyTdOF_KM8m-gj_A" >}}
 
-## Start an Execution
+### Start an Execution
 
 {{< scribe title="Execution_Options_and_Start_an_Execution" id="eIlJucHPRPOZ_s37BAu0Jg" >}}
 
-## Edit Flow and Continue Debugging
+### Edit Flow and Continue Debugging
 
 {{< scribe title="Edit_Flow_and_Continue_Debugging" id="cAkx-vH6RpWhjWpkEyePRg" >}}
 
-## Remove All Breakpoints
+### Remove All Breakpoints
 
 {{< scribe title="Remove_All_Breakpoints" id="BI8BnbwETdK7fDDJYDZBuQ" >}}
 
-## Save and Commit Flow
+### Save and Commit Flow
 
 {{< scribe title="Save_Flow_and_Commit_Flow" id="REEiz4ZORki-p5QUZO1X3A" >}}
 
-## Get Master Version of Flow
+### Get Master Version of Flow
 
 {{< scribe title="Get_Master_Version_of_Flow" id="2Biuxb5NTU-tZYOmMECGvA" >}}
 
-## Compare Flow with Master Version
+### Compare Flow with Master Version
 
 {{< scribe title="Compare_Flow_with_Master_Version" id="gtMBJZ44RHWV5vWpgMWTMw" >}}
 
-## Delete Flow
+### Delete Flow
 
 {{< scribe title="Delete_a_Flow" id="1N9rmBcJSOCGQPws6fYxEw" >}}
+
+## Context Menus
+
+### Cut, Copy, Paste and Delete Objects
+
+{{< scribe title="How_To_Copy_Cut_Paste_and_Delete_objects_in_CORTEX_Flow_Editor" id="BkLh_Z99TI6t2nmcHDajSQ" >}}
+
+### Add and Remove Breakpoints
+
+{{< scribe title="How_to_Add_and_Remove_Breakpoints_in_a_Flow" id="d_j8QSBVRcOWKIq5gLk2BA" >}}
+
+### Set Next Block to Execute
+
+{{< scribe title="Set_Next_Block_to_Execute_in_Flow" id="m2QXQOiHRF-AIgp8V9SBiA" >}}
+
+### Add Notes to Workspaces
+
+{{< scribe title="How_to_Add_Notes_to_Workspaces" id="0T4U9yUUQXWo7eGSvdVuCg" >}}