diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/_index.md new file mode 100644 index 000000000..e5180d3c7 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/_index.md @@ -0,0 +1,6 @@ +--- +title: "Dev" +linkTitle: "Dev" +description: "This section includes user guides related to the Development section in {{% ctx %}} Gateway." +weight: 1 +--- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/_index.md new file mode 100644 index 000000000..dd6345892 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/_index.md @@ -0,0 +1,6 @@ +--- +title: "Flow Editor" +linkTitle: "Flow Editor" +description: "View, edit and debug flows in {{% ctx %}} Gateway." +weight: 1 +--- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/_index.md new file mode 100644 index 000000000..f8332e13f --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/_index.md @@ -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 +--- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/executions-grid.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/executions-grid.md new file mode 100644 index 000000000..ffc9608ce --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/executions-grid.md @@ -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" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/messages-grid.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/messages-grid.md new file mode 100644 index 000000000..173515a30 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/messages-grid.md @@ -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" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/overview.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/overview.md new file mode 100644 index 000000000..a89709652 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/overview.md @@ -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" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/variables-grid.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/variables-grid.md new file mode 100644 index 000000000..124083558 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/variables-grid.md @@ -0,0 +1,173 @@ +--- +title: "Variables Grid" +linkTitle: "Variables Grid" +description: "Create and manage variables." +weight: 40 +--- + +# {{% param title %}} + +## Summary + +The Variable Grid enables [variables][What is a Variable?] to be created and modified. + +## Anatomy + +{{< figure src="/images/Flow Editor - Variables Grid.png" title="Variables Grid" >}} + +The Variables Grid may be manually opened, or closed any time by clicking the Open/Close handle or resized by dragging the handle up or down. + +Each variable is represented by a single row and the properties are represented by the different columns. The properties of a variable are: + +* `Description` – This is an optional free-format text property to aid understanding of the purpose of variable. +* `Name` – This must be unique within its [scope][Variable Scopes] and is case insensitive. It cannot contain space characters, but it can contain hyphens and underscores. +* `Type` – This is always set to *Variable*. +* `Set Default Value?` – This is used to initialise the variable with a value when the variable is created, i.e., when it comes into scope. It can be set to either true (initialise) and is used in connection `Default Value` or false (do not initialise). +* `Default Value` – The value to initialise the variable with when it is created, defined using an [Expression Editor][], and is used in connection with `Set Default Value?`. +* `Is Input Variable?` – This is used to allow the variable to accept an input from an external REST Request, e.g., from a 3rd party system. It can be set to either true or false; the default value is false. For the variable to be used as an [Input Variable][Flow Input Variable], it must have its `Scope` set to the top-Level [workspace][What is a Workspace?], i.e. flow level. +* `Is Output Variable?` – This allows the variable to pass back its value, when the [execution][What is an Execution?] terminates, to the calling system via the REST Response. It can be set to either true or false; the default value is false. For the variable to be used as an Output Variable, it must have its `Scope` set to the top-Level workspace, i.e. flow level. +* `Scope` – This property defines the scope of a variable, i.e., the workspace, or workspaces, where the variable is [accessible][]. Variables operate on the principle of inherited scope, where variables defined in a workspace are accessible from any of its nested workspaces. + +Variables in different scopes may be named identically, but identically named variables cannot be defined in the same workspace. When referring to identically named variables within a block’s [properties][What is a Block Property?], the variable with the most local scope will be used, e.g., a variable defined in the current workspace will be used rather than one with an identical name in a parent workspace. + +A variable may be selected by clicking on its row. Multiple variables can be selected using `Ctrl + Click` or `Shift + Click`. Selected variables are indicated with bold text. + +## Actions + +### Create a Variable + +Clicking the {{< image src="/images/Flow Editor - Add Variables.png" >}} icon will create a new variable. The variable will be created with the scope of the currently selected workspace. + +See the [Create, Rename and Delete a Variable][Create, Rename and Delete a Variable tutorial] tutorial for a step-by-step guide. + +### Rename a Variable + +Double-click the variable’s `Name` field to enable its editing; rename the variable and click outside the field to complete the renaming process. It is entered as free-format text, however, when it is saved, it will automatically be prepended by `($)` to denote that this is a variable. If the `Name` is entered prepended by a `($)`, the system will not duplicate the prefix. + +Renaming a variable will update any use of that variable in the flow to use the new name. If a variable is renamed to a name that already exists the renamed variable and the existing variable will be highlighted in red text. + +See the [Create, Rename and Delete a Variable][Create, Rename and Delete a Variable tutorial] tutorial for a step-by-step guide. + +### Copy Variables + +Right-click anywhere on a variable and select `Copy` from the context menu to copy the variable. To copy multiple variables select all the variables to be copied before right-clicking. + +### Cut Variables + +Right-click anywhere on a variable and select `Cut` from the context menu to cut the variable. To cut multiple variables select all the variables to be cut before right-clicking. + +### Paste Variables + +Right-click anywhere in the variable grid and select `Paste` from the context menu to paste the cut or copied variable(s). The pasted variable(s) will be added to the currently selected workspace and if a variable already exists on that workspace with the same name it will append `-Copy` to the name. + +### Delete Variables + +Right-click anywhere on a variable and select `Delete` from the context menu to delete the variable. Alternatively, select the variable to be deleted and use the `delete` key to delete the variable. To delete multiple variables select all the variables to be deleted before right-clicking or using the `delete` key. + +See the [Create, Rename and Delete a Variable][Create, Rename and Delete a Variable tutorial] tutorial for a step-by-step guide. + +### Assigning a Default Value to a Variable + +Double-click the `Set Default Value?` field of the required variable to reveal a checkbox; click on the checkbox to enable the default value. +Then, double-click on the `Default Value` field to open an [Expression Editor][] in which to specify the default value. + +See the [Assign a Default Value to a Variable][Assign a Default Value to a Variable tutorial] tutorial for a step-by-step guide. + +### Defining an Input or Output Variable + +The scope of an input or output variable must be set to the top-Level workspace, i.e. flow level, for it to accept an input value or return an output value. Double-click on the `Is Input Variable?` or `Is Output Variable?` fields, as appropriate, to reveal a checkbox. Click on the checkbox to tick it to make the selected variable an input or output variable. + +A single variable can be both an input variable and an output variable. + +See the [Define an Input or Output Variable][Define an Input or Output Variable tutorial] tutorial for a step-by-step guide. + +### Modifying the Scope of a Variable + +Double-click on the `Scope` field of the variable to open a dropdown menu. Select the scope from the dropdown. + +To change the scope for multiple variables, they can be changed individually, or alternatively, select all variables to be changed, [cut][] them, open the workspace that they should be moved to and then [paste][] them. + +See the [Modify the Scope of a Variable][Modify the Scope of a Variable tutorial] tutorial for a step-by-step guide. + +### Sort Variables + +The variables displayed may be ordered by any of the columns. + +To sort by a singles column's values, click the column header, each click will cycle through the sort options in the following order: + +* Ascending +* Descending +* Remove Sort + +To sort by multiple columns, click the {{< image src="/images/Flow Editor - Sort Variables.png" >}} icon next to each column name to be sorted by and select `Sort Ascending` or `Sort Descending` option. The sort should be applied to each column in the order to be sorted by. To remove a column from the multi-column sort, click the {{< image src="/images/Flow Editor - Sort Variables.png" >}} icon next to the name of the column to be removed and select `Remove Sort`. + +If there is a multi-column sort in place, clicking on a column header will replace the sort with a single column sort cycling to the next option as listed above. + +### Filter Variables + +The displayed variables may be filtered, based on the values contained in any property of the variables, by typing into the box below each property column name. + +The filtering on `Scope` allows for the following options: + +* `All` – All variables in the flow, regardless of their scope, are displayed +* `Flow` – Only variables defined at the top-level workspace, i.e. flow variables, are displayed +* `Defined (Selected Workspace)` – Only variables defined in the selected workspace are displayed; inherited scope variables are not displayed. +* `Available (Selected Workspace)` – Variables defined in the selected workspace and inherited scope variables are displayed. This is the default setting. + +### Show or Hide Filters + +The filters themselves can be hidden by clicking the {{< image src="/images/Flow Editor - Hide Filters.png" >}} icon; note, although the filters may be hidden, their filtering actions still apply. + +When filters are hidden, the icon will change to {{< image src="/images/Flow Editor - Show Filters.png" >}}. Clicking this will make the filters visible again. + +### Enable or Disable Filtering + +The filtering of displayed variables can be disabled by clicking the {{< image src="/images/Flow Editor - Disable Filtering.png" >}} icon. + +When filtering is disabled, the icon will change to {{< image src="/images/Flow Editor - Enable Filtering.png" >}} and all variables will be displayed. Clicking this will enable filtering and any existing filters will be re-applied. + +## Remarks + +### Known Limitations + +* The scope of a variable is referenced to the Description property of the flow or workspace, not the name of the workspace. +* It is possible to mark a non-global variable as `Is Input Variable?` or `Is Output Variable?`. However, the variable will not accept an input value nor return an output value. + +## See Also + +### Related Concepts + +* [Blocks][] +* [Executions][] +* [Flows][] +* [Variables][] +* [Workspaces][] + +### Related Tutorials + +* [Create, Rename and Delete a Variable][Create, Rename and Delete a Variable tutorial] +* [Assign a Default Value to a Variable][Assign a Default Value to a Variable tutorial] +* [Define an Input or Output Variable][Define an Input or Output Variable tutorial] +* [Modify the Scope of a Variable][Modify the Scope of a Variable tutorial] + +[Assign a Default Value to a Variable tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.AssignDefaultVariableValue" >}} +[Create, Rename and Delete a Variable tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.CreateRenameDeleteVariable" >}} +[Define an Input or Output Variable tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.DefineInputOutputVariable" >}} +[Modify the Scope of a Variable tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.BottomPanel.ModifyVariableScope" >}} + +[cut]: {{< ref "#cut-variables" >}} +[paste]: {{< ref "#paste-variables" >}} +[accessible]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.Accessible" >}} +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}} +[Expression Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[Flow Input Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}} +[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}} +[Workspaces]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.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 Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}} +[What is a Workspace?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc" >}} +[What is an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/left-panel.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/left-panel.md new file mode 100644 index 000000000..93ebde5a7 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/left-panel.md @@ -0,0 +1,78 @@ +--- +title: "Left Panel" +linkTitle: "Left Panel" +description: "Browse, search and use available blocks." +weight: 20 +--- + +# {{% param title %}} + +## Summary + +The Left Panel shows the Palettes containing [blocks][What is a Block?] that can be used to construct a [flow][What is a Flow?] and is automatically opened when working in Edit or Debug Edit modes. + +## Anatomy + +{{< figure src="/images/Flow Editor - Left Panel.png" title="Left Panel" >}} + +The Palettes group blocks with similar themes, and many of the blocks in a palette look similar but perform slightly different functions; the actual function that a block performs is shown in text, next to the block icon. + +## Actions + +### Open/Close the Panel + +The Left Panel can be manually opened or closed at any time using the open/close handles. It can also be resized by dragging the handle left or right. + +### Collapse/Expand Palette Groups + +To collapse or expand all palette groups, click the relevant {{< image src="/images/Flow Editor - Collapse All.png" >}} or {{< image src="/images/Flow Editor - Expand All.png" >}} icon at the top of the Left Panel. Each palette group may be collapsed or expanded independently by clicking on the {{< image src="/images/Flow Editor - Collapse Palette.png" >}} or {{< image src="/images/Flow Editor - Expand Palette.png" >}} icon to the right of the group name. + +### View Blocks + +To view the blocks contained in the Palettes, click on the {{< image src="/images/Flow Editor - Expand Palette.png" >}} icon to the right of the palette group to expand the group and show the blocks it contains, or alternatively, click the {{< image src="/images/Flow Editor - Expand All.png" >}} icon at the top of the Left Panel to expand all the palette groups. + +See the [View Blocks in the Palette][View Blocks in the Palette tutorial] tutorial for a step-by-step guide. + +### Search for a Block + +To search for a block by name, start typing into the search box. All the blocks that start with the same search characters will be displayed; the more characters entered, the more refined the search will be, displaying fewer block options. The search is a fuzzy search, which means that even misspelt block names should identify the intended matching blocks. + +See the [Searching the Palette for a Block][Searching the Palette for a Block tutorial] tutorial for a step-by-step guide. + +### Place a Block on a Workspace + +To place a block from the palette onto a [workspace][What is a Workspace?], left-click on the block in the palette and drag it onto the Workspace. + +See the [Placing a Block from the Palette onto a Workspace][Placing a Block from the Palette onto a Workspace tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* If the developer has [`View`][View] permissions, it is still possible to drag a block from the Palettes onto a Workspace. Once placed on the Workspace, it is not possible to delete the block unless [`Edit`][Edit] permissions are assigned to the developer, or the browser is refreshed. + +## See Also + +### Related Concepts + +* [Blocks][] +* [Flows][] +* [Workspaces][] + +### Related Tutorials + +* [View Blocks in the Palette][View Blocks in the Palette tutorial] +* [Searching the Palette for a Block][Searching the Palette for a Block tutorial] +* [Placing a Block from the Palette onto a Workspace][Placing a Block from the Palette onto a Workspace tutorial] + +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Edit]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Placing a Block from the Palette onto a Workspace tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.LeftPanel.PlaceBlocks" >}} +[Searching the Palette for a Block tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.LeftPanel.SearchBlocks" >}} +[View Blocks in the Palette tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.LeftPanel.ViewBlocks" >}} +[View]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.View" >}} +[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" >}} +[Workspaces]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.Workspaces" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel.md new file mode 100644 index 000000000..768ce4165 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel.md @@ -0,0 +1,208 @@ +--- +title: "Main Panel" +linkTitle: "Main Panel" +description: "View, edit and debug flows." +weight: 30 +--- + +# {{% param title %}} + +## Summary + +The Main Panel is used when viewing, editing and debugging [flows][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Main Panel.png" title="Main Panel" >}} + +At the top of the Main Panel is the [Main Toolbar][], which displays a number of icons that perform actions on the selected flow, and the current editor mode. Below are the currently selected flow’s opened [workspaces][] and any associated [blocks][What is a Block?]. + +### Main Toolbar + +To the left of the Main Toolbar, there are several icons that perform different actions on the currently selected flow. The icons displayed and their actions depend on the current editor mode. + +To the right of the Main Toolbar the current editor mode is displayed, and can have the following values: + +* View – the user only has [`View`][View] permissions on the flow and cannot edit it. +* Edit – the user has [`Edit`][Edit] permissions and can add or delete blocks from the flow’s workspaces and change the block’s [properties][What is a Block Property?]. +* Debug - the flow is being debugged in the Flow Editor. +* Debug Edit – edits may be made to the flow that is being debugged and paused without losing any values that have been assigned to the [variables][What is a Variable?]. + +### Workspaces + +A [workspace][What is a Workspace?] is an object that contains a canvas, onto which blocks, drawn from the Palettes may be placed and connected to define the logic of a flow. Every flow has a top-level workspace, from where the flow [execution][What is an Execution?] will start; additional workspace blocks may be added from the Palettes to direct the flow execution to execute the logic contained in that workspace. + +The canvas of the flow’s top-level workspace is always present in the Main Panel, along with any of the flow’s additional workspaces that have been opened. The canvas will automatically increase in size as blocks are added or moved as necessary. If the workspace becomes too large to be viewed in its entirety in the Main Panel, scroll bars will be automatically added. + +To the bottom left of each workspace are a set of 4 overlaid zoom controls: + +* {{< image src="/images/Flow Editor - Shrink Wrap.png" >}} Shrink Wrap to reduce the size of the workspace canvas and remove unnecessary white space. +* {{< image src="/images/Flow Editor - Reset Zoom.png" >}} Reset Zoom to undo any zoom in or zoom out actions that has been performed. +* {{< image src="/images/Flow Editor - Zoom In.png" >}} Zoom In +* {{< image src="/images/Flow Editor - Zoom Out.png" >}} Zoom Out + +#### Workspace Toolbar + +At the top of each workspace, a workspace Toolbar displays the workspace name and a {{< image src="/images/Flow Editor - Close Flow.png" >}} icon to close that workspace. + +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][]. + +## Actions + +### 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. + +See the [Undo and Redo Changes][Undo and Redo Changes tutorial] tutorial for a step-by-step guide. + +### 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. + +See the [Undo and Redo Changes][Undo and Redo Changes tutorial] tutorial for a step-by-step guide. + +### 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 + +Available in Editor Modes: `View`, `Edit`, `Debug` + +The {{< image src="/images/Flow Editor - Execution Options.png" >}} dropdown enables the developer to change the options that are used when debugging the flow in the Flow Editor. One, multiple or no options can be selected: + +* `Show execution on workspace` - Displays an icon on the workspace, identifying the position of the flow being debugged, enabling the flow developer to track the execution progress. +* `Break on exception` - causes the flow execution to be paused if an [exception][What is an Exception?] occurs. + +See the [Start an Execution][Start an Execution tutorial] tutorial for a step-by-step guide. + +### 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 + +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 + +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 + +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 + +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 + +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 + +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 + +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. + +## Remarks + +### Known Limitations + +None + +## See Also + +### Related Concepts + +* [Blocks][] +* [Exceptions][] +* [Executions][] +* [Flows][] +* [Variables][] +* [Workspaces][Workspace Fundamentals] + +### 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]: {{< ref "#main-toolbar" >}} +[workspaces]: {{< ref "#workspaces" >}} + +[Compare Flow with Master Version tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainPanel.CompareMaster" >}} +[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" >}} +[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" >}} +[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" >}} + +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[breadcrumb trail]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.NavigationBar.BreadcrumbTrail" >}} +[Edit]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}} +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} +[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}} +[Executions in Development]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment.MainDoc" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}} +[Navigation Bar]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.NavigationBar.MainDoc" >}} +[View]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.View" >}} +[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 Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.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" >}} +[Workspace Fundamentals]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/navigation-bar.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/navigation-bar.md new file mode 100644 index 000000000..abf453f11 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/navigation-bar.md @@ -0,0 +1,150 @@ +--- +title: "Navigation Bar" +linkTitle: "Navigation Bar" +description: "Navigate between open flows and workspaces." +weight: 10 +--- + +# {{% param title %}} + +## Summary + +The Navigation Bar is at the top of the page and provides information about the currently selected [workspace][What is a Workspace?], navigation between simultaneously opened [flows][What is a Flow?], and access to online help. + +## Anatomy + +{{< figure src="/images/Flow Editor - Navigation Bar.png" title="Navigation Bar" >}} + +The Navigation bar consists of 6 elements: + +* [Recently Used Workspaces][] +* [Breadcrumb Trail][] +* [User Principle Name][] +* [Help][] +* [Navigation][] +* [Close Flow][] + +### Recently Used Workspaces + +Recently Used Workspaces displays the user's last 10 opened workspaces in a drop down menu to allow quick navigation to any of these workspaces. + +### Breadcrumb Trail + +The Breadcrumb Trail shows the hierarchy of all the open workspaces of the flow being viewed. At the left is the flow itself; an asterisk (*) after the flow name indicates that there are unsaved changes. Then follows a list of the open hierarchical workspace names, with the most deeply nested workspace at the right. The currently selected workspace is identified by its name being highlighted by a darker background. + +{{% alert title="Note" %}}The breadcrumb trail only shows the names of the workspaces, as set on the workspace menu bar, not the workspace description as set in the workspace Description property.{{% /alert %}} + +### User Principle Name + +The User Principle Name identifies the current user logged in to Gateway. + +### Help + +The help icon opens the Product Portal, online documentation for {{% ctx %}}. + +### Navigation + +The Navigation sections consists of 2 navigation methods: + +* [Quick Navigation][]. +* [Sequential Navigation][]. + +#### Quick Navigation + +Quick Navigation allows navigation between all open flows from a vertical, scrollable list. + +#### Sequential Navigation + +Sequential Navigation allows navigation to the previous or next open flow. + +### Close Flow + +Closes the Flow Editor for the current flow. + +## Actions + +### Using Recently Used Workspaces + +Clicking on the {{< image src="/images/Flow Editor - Recently Used Workspaces.png" >}} icon will display a list of the last 10 opened workspaces for the current user. Clicking on one of the list items will display that workspace in the [Main Panel][] opening it if it is not already open. + +### Using the Breadcrumb Trail + +Clicking on any part of the Breadcrumb Trail will change the focus of the [Main Panel][] to the workspace selected. + +After each workspace name there is a drop down menu that displays all workspaces available for the workspace that the dropdown was initiated for. + +### Open Help + +Clicking on the {{< image src="/images/Flow Editor - Help.png" >}} icon, will open the Product Portal in a new browser tab automatically selecting the section relevant to the {{% ctx %}} version being used. + +See the [Accessing Help][Accessing Help tutorial] tutorial for a step-by-step guide. + +### Quick Navigation between Open Flows + +Clicking on the {{< image src="/images/Flow Editor - Quick Navigation.png" >}} icon will replace the [Right Panel][] with a ‘filmstrip’ depicting a pictorial representation of all open flows in a vertical, scrollable list. + +To navigate to an alternative open flow, click on the flow image in the filmstrip; the open flow will then be visible in the [Main Panel][]. + +Clicking on the Quick Navigation icon when the filmstrip is visible will close the Quick Navigation feature. The Quick Navigation feature will also be closed if a [block][What is a Block?] on the flow being viewed is selected, causing the block's [properties][What is a Block Property?] to be displayed in the [Right Panel][]. + +See the [Quick Navigation Between Open Flows][Quick Navigation Between Open Flows tutorial] tutorial for a step-by-step guide. + +### Sequential Navigation between Open Flows + +Clicking on the {{< image src="/images/Flow Editor - Previous Flow.png" >}} (Previous Flow) or {{< image src="/images/Flow Editor - Next Flow.png" >}} (Next Flow) icons allows sequential navigation between open flows. + +If the first opened flow is being viewed, then the Previous Flow icon will be greyed out and unavailable. Similarly, if the last opened flow is being viewed, then the Next Flow icon will be greyed out and unavailable. If only one flow is open then both icons will be greyed out and unavailable. + +See the [Sequential Navigation Between Open Flows][Sequential Navigation Between Open Flows tutorial] tutorial for a step-by-step guide. + +### Close Flow + +Clicking on the {{< image src="/images/Flow Editor - Close Flow.png" >}} icon will attempt to close the currently selected open flow. If there are unsaved changes to the flow, a pop-up dialog will appear, inviting you to save your changes before closing the flow. + +See the [Close Flow][Close Flow tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +None + +## See Also + +### Related Concepts + +* [Blocks][] +* [Flows][] +* [Workspaces][Workspaces] + +### Related Tutorials + +* [Accessing Help][Accessing Help tutorial] +* [Quick Navigation Between Open Flows][Quick Navigation Between Open Flows tutorial] +* [Sequential Navigation Between Open Flows][Sequential Navigation Between Open Flows tutorial] +* [Close Flow][Close Flow tutorial] + +[Recently Used Workspaces]: {{< ref "#recently-used-workspaces" >}} +[Breadcrumb Trail]: {{< ref "#breadcrumb-trail" >}} +[Close Flow]: {{< ref "#close-flow" >}} +[Help]: {{< ref "#help" >}} +[Navigation]: {{< ref "#navigation" >}} +[Quick Navigation]: {{< ref "#quick-navigation" >}} +[Sequential Navigation]: {{< ref "#sequential-navigation" >}} +[User Principle Name]: {{< ref "#user-principle-name" >}} + +[Accessing Help tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.NavigationBar.AccessHelp" >}} +[Quick Navigation Between Open Flows tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.NavigationBar.QuickNavigation" >}} +[Sequential Navigation Between Open Flows tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.NavigationBar.SequentialNavigation" >}} +[Close Flow tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.NavigationBar.CloseFlow" >}} + +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Main Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.MainDoc" >}} +[Navigation Bar tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.NavigationBar.MainDoc" >}} +[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}} +[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 Workspace?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc" >}} +[Workspaces]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/overview.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/overview.md new file mode 100644 index 000000000..470559c51 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/overview.md @@ -0,0 +1,113 @@ +--- +title: "Overview" +linkTitle: "Overview" +description: "Summary and anatomy of the Flow Editor." +weight: 1 +--- + +# {{% param title %}} + +## Summary + +The Flow Editor page allows you to view, edit and debug [flows][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor.png" title="Flow Editor" >}} + +The Flow Editor page shows the [Navigation Bar][NavBar] at the top and the [Main Panel][Main] towards the centre of the page; to the left, right and bottom of the [Main Panel][Main], additional panels are automatically displayed, dependent on the activity currently being undertaken or the panel tab selected. + +Each of the [Left][], [Right][] and [Bottom][] panels may be manually opened or closed, expanded or shrunk, independently as required. + +### Navigation Bar + +The [Navigation Bar][] is always visible at the top of the page and provides information about the currently selected [workspace][What is a Workspace?], navigation between simultaneously opened flows, and access to online help. + +### Left Panel + +The [Left Panel][] shows the Palettes of available [blocks][What is a Block?], which are used during flow development. It is automatically opened during Edit mode. + +### Main Panel + +The [Main Panel][] is always visible and consists of: + +* The [Main Toolbar][]. +* One or more [Workspaces][] associated with the currently selected flow. + +### Right Panel + +The [Right Panel][] consists of 2 or 3 tabs depending on the mode selected: + +* In `View`, `Edit` or `Debug Edit` mode, the following tabs are available: + + * Properties (default) - displays the [Property Editor][] showing the [properties][What is a Block Property?] of the currently selected block. + * Settings - displays the [Settings Editor][] to set the values of the [input variables][Flow Input Variable] used when debugging the flow. + +* In `Debug` mode, the following tabs are available: + + * Variables (default) - displays the [Variables Viewer][] showing the values of the [variables][What is a Variable?] when debugging the flow. + * Exceptions - displays the [Exceptions Viewer][] showing details of any [exceptions][What is an Exception?] when debugging the flow. + * Settings - displays the [Settings Editor][] to set the values of the [input variables][Flow Input Variable] used when debugging the flow. + +### Bottom Panel + +The [Bottom Panel][] consists of 3 tabs: + +* Executions (default) - displays the [Executions Grid][] listing current [executions][What is an Execution?] being debugged by the user. +* Messages - displays the [Messages Grid][] listing [issues][What is a Message?] preventing the flow from being debugged. +* Variables - displays the [Variables Grid][] enabling the management of [variables][What is a Variable?]. + +## See Also + +### Related Concepts + +* [Blocks][] +* [Exceptions][] +* [Executions][] +* [Flows][] +* [Messages][] +* [Variables][] +* [Workspaces][Workspace Fundamentals] + +### Related Tutorials + +* [Flow Editor][Flow Editor tutorial] + +[Flow Editor tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.MainDoc" >}} + +[Left]: {{< ref "#left-panel" >}} +[Main]: {{< ref "#main-panel" >}} +[Navbar]: {{< ref "#navigation-bar" >}} +[Right]: {{< ref "#right-panel" >}} +[Bottom]: {{< ref "#bottom-panel" >}} + +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Bottom Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MainDoc" >}} +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} +[Exceptions Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer.ExceptionsViewer" >}} +[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}} +[Executions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.ExecutionsGrid" >}} +[Flow Input Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Left Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.LeftPanel.MainDoc" >}} +[Main Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.MainDoc" >}} +[Main Toolbar]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.MainToolbar" >}} +[Messages]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.MainDoc" >}} +[Messages Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MessagesGrid" >}} +[Navigation Bar]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.NavigationBar.MainDoc" >}} +[Property Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.PropertyEditor" >}} +[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}} +[Settings Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.SettingsEditor" >}} +[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}} +[Variables Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.VariablesGrid" >}} +[Variables Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer.VariablesViewer" >}} +[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" >}} +[What is a Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.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.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.Workspaces" >}} +[Workspace Fundamentals]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/_index.md new file mode 100644 index 000000000..2c1d713ab --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/_index.md @@ -0,0 +1,6 @@ +--- +title: "Right Panel" +linkTitle: "Right Panel" +description: "Set the values of block properties and input variables, and view execution information when debugging flows." +weight: 40 +--- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/_index.md new file mode 100644 index 000000000..9decb2194 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/_index.md @@ -0,0 +1,6 @@ +--- +title: "Execution Viewer" +linkTitle: "Execution Viewer" +description: "View execution information when debugging a flow." +weight: 30 +--- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/exceptions-viewer.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/exceptions-viewer.md new file mode 100644 index 000000000..757b64244 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/exceptions-viewer.md @@ -0,0 +1,63 @@ +--- +title: "Exceptions Viewer" +linkTitle: "Exceptions Viewer" +description: "View details of any exceptions that occur when debugging a flow." +weight: 40 +--- + +# {{% param title %}} + +## Summary + +The Exceptions Viewer shows details of any [exceptions][What is an Exception?] when debugging the [flow][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Exceptions Viewer.png" title="Exceptions Viewer" >}} + +In addition to a detailed description of the exception, the exception may include an Inner Exception, which details a previous exception that led to this exception being raised. Some exceptions may contain multiple, nested Inner Exceptions. + +The exact format of the Exception Object depends on the exception raised. All Exception Objects have: + +* Exception Type – The type of the exception. +* Message – The description of the exception. +* HelpLink - A hyperlink to further information relating to the exception. + +## Actions + +### View Exception + +Select the Exception tab on the Right Panel to view all the exceptions raised while debugging the flow. If the [execution][What is an Execution?] is stopped, all the exception messages will be discarded. + +See the [Exceptions Viewer][Exceptions Viewer tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* The text displayed in the Exceptions Viewer cannot be copied to the clipboard. + +## See Also + +### Related Concepts + +* [Exceptions][] +* [Executions][] +* [Flows][] + +### Related Tutorials + +* [Exceptions Viewer][Exceptions Viewer tutorial] + +[Variables Viewer]: {{< ref "#variables-viewer" >}} +[Variables Details Viewer]: {{< ref "#variables-details-viewer" >}} + +[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}} +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} +[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Exceptions Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExceptionsViewer" >}} +[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}} +[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.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" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/overview.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/overview.md new file mode 100644 index 000000000..ef8c65b58 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/overview.md @@ -0,0 +1,44 @@ +--- +title: "Overview" +linkTitle: "Overview" +description: "Summary and anatomy of the Execution Viewer." +weight: 10 +--- + +# {{% param title %}} + +## Summary + +The Execution Viewer consists of two tabs to allow viewing [variable][What is a Variable?] values and details of any [exceptions][What is an Exception?] when debugging a [flow][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Execution Viewer.png" title="Execution Viewer" >}} + +The two tabs of the Execution Viewer are always available in the right panel when debugging a flow and are: + + * Variables (default) - displays the [Variables Viewer][] showing the values of the [variables][What is a Variable?] when debugging the flow. + * Exceptions - displays the [Exceptions Viewer][] showing details of any exceptions when debugging the flow. + +## See Also + +### Related Concepts + +* [Exceptions][] +* [Flows][] +* [Variables][] + +### Related Tutorials + +* [Execution Viewer][Execution Viewer tutorial] + +[Execution Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExecutionViewer" >}} + +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} +[Exceptions Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer.ExceptionsViewer" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}} +[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}} +[Variables Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer.VariablesViewer" >}} +[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 an Exception?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.WhatIsAnException.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/variables-viewer.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/variables-viewer.md new file mode 100644 index 000000000..3de6aa3e7 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/variables-viewer.md @@ -0,0 +1,85 @@ +--- +title: "Variables Viewer" +linkTitle: "Variables Viewer" +description: "View the values of variables when debugging a flow." +weight: 30 +--- + +# {{% param title %}} + +## Summary + +The Variables Viewer displays the values of the [variables][What is a Variable?] when debugging a [flow][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Variables Viewer.png" title="Variables Viewer" >}} + +The Variables Viewer consists of two sections: + +* [Variables List][] - displaying the variables in [scope][Variable Scopes] for the flow [execution][What is an Execution?] that is being debugged. +* [Variable Details Viewer][] - displaying the name, type and full value of the variable selected in the Variables List. + +### Variables List + +The Variables List, at the top of the Variables Viewer, shows the current values of variables containing basic data types, and the type and structure of collection and complex data type values. + +In addition to developer defined variables, {{% ctx %}} [built-in variables][Execution Context] will also be displayed. + +### Variable Details Viewer + +The Variable Details Viewer, at the bottom of the Variables Viewer, shows the name and data type of the variable selected in the [Variables List][] as well as it's value, in JSON format. Any collection or complex data types will be expanded to display their contents. + +It is important to note that the Variables Viewer can only display a [JSON][] representation of the variable's value. + +## Actions + +### View Variables in Variables List + +To view the variables that have been assigned a value, including a NULL value, that are currently in scope, select the execution in the [Executions Grid][] and click on the Variables tab. + +Variables that have not been assigned a value or are out of [scope][Variable Scopes] will not be displayed. + +See the [Variables Viewer][Variables Viewer tutorial] tutorial for a step-by-step guide. + +### View the Detail of a Variable + +Click on a variable in the Variables List to view the variable's name, it's data type, and value displayed in JSON format. The detail of collection and complex data types will only be expanded in JSON format in the Variable Details Viewer if the execution is paused. + +See the [Variables Viewer][Variables Viewer tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* Variables with a [Dictionary][Dictionary Tkey] data type where TKey is not the [String][] data type will have their keys displayed as the [ToString()][ToString] value for the data type. + +## See Also + +### Related Concepts + +* [Executions][] +* [Flows][] +* [Variables][] + +### Related Tutorials + +* [Variables Viewer][Variables Viewer tutorial] + +[Variables List]: {{< ref "#variables-list" >}} +[Variable Details Viewer]: {{< ref "#variable-details-viewer" >}} + +[Dictionary TKey]: {{< url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc" >}} +[Execution Context]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.ExecutionContext" >}} +[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" >}} +[JSON]: {{< url path="Cortex.Reference.Glossary.F-J.Json" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} +[ToString]: {{< url path="MSDocs.DotNet.Api.System.Object.ToString" >}} +[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}} +[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}} +[Variables Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.VariablesViewer" >}} +[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 an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/overview.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/overview.md new file mode 100644 index 000000000..eac61a820 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/overview.md @@ -0,0 +1,59 @@ +--- +title: "Overview" +linkTitle: "Overview" +description: "Summary and anatomy of the Right Panel." +weight: 10 +--- + +# {{% param title %}} + +## Summary + +The Right Panel consists of multiple tabs to allow viewing and editing of [block properties][What is a Block Property?], as well as viewing [variable][What is a Variable?] values, details of any [exceptions][What is an Exception?], and setting [input variables][Flow Input Variable] used when debugging a [flow][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Right Panel.png" title="Right Panel" >}} + +* In `View`, `Edit` or `Debug Edit` mode, the following tabs are available: + + * Properties (default) - displays the [Property Editor][] showing the properties of the currently selected [block][What is a Block?]. + * Settings - displays the [Settings Editor][] to set the values of the input variables used when debugging the flow. + +* In `Debug` mode, the following tabs are available: + + * Variables (default) - displays the [Variables Viewer][] showing the values of the [variables][What is a Variable?] when debugging the flow. + * Exceptions - displays the [Exceptions Viewer][] showing details of any exceptions when debugging the flow. + * Settings - displays the [Settings Editor][] to set the values of the input variables used when debugging the flow. + +## See Also + +### Related Concepts + +* [Blocks][] +* [Exceptions][] +* [Executions][] +* [Flows][] +* [Variables][] + +### Related Tutorials + +* [Right Panel][Right Panel tutorial] + +[Right Panel tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.MainDoc" >}} + +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} +[Exceptions Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer.ExceptionsViewer" >}} +[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}} +[Flow Input Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}} +[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.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" >}} +[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}} +[Variables Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer.VariablesViewer" >}} +[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 Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}} +[What is an Exception?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.WhatIsAnException.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/property-editor.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/property-editor.md new file mode 100644 index 000000000..bdc33b860 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/property-editor.md @@ -0,0 +1,154 @@ +--- +title: "Property Editor" +linkTitle: "Property Editor" +description: "View and edit the properties of a selected block." +weight: 20 +--- + +# {{% param title %}} + +## Summary + +The Property Editor allows viewing and editing of the [properties][What is a Block Property?] for the currently selected [block][What is a Block?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Property Editor.png" title="Property Editor" >}} + +The Property Editor is automatically opened when a block on the [workspace][What is a Workspace?] is selected; however, it may be manually opened, or closed, any time by clicking the Open/Close handle or resized by dragging the handle left or right. + +Every block has one or more properties, which can be one of the following types: + +* [Free format literal text][literaltext] +* [Input][] +* [Output][] +* [InputOutput][] + +Each property type, apart from the free format literal text, uses one or more [property editors][]. If a property can be configured by using more than one editor type, clicking on the editor symbol will cycle though the alternative editor types; if only one editor type is available the editor symbol will be greyed out. + +To the right of the property name, the ellipsis enables the developer to change the data type that this input property accepts. + +### Property Types + +#### Free Format Literal Text + +The free format literal text property is used for the description of the block. + +#### Input + +[Input properties][] supply a value to be used by a block and use either: + +* The Expression Editor {{< image src="/images/Flow Editor - Expression Editor.png" >}} +* The Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}} +* The Literal Editor {{< image src="/images/Flow Editor - Literal Editor.png" >}} + +#### Output + +[Output properties][] store a value generated by a block and use either: + +* The Expression Editor {{< image src="/images/Flow Editor - Expression Editor.png" >}} +* The Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}} + +#### InputOutput + +[InputOutput properties][] supply a value to be used by a block and then store a value generated by the block to the same variable and only use the Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}}. + +### Show Advanced Properties + +Many objects have [advanced properties][], which do not need to be configured for normal use and are normally hidden to avoid clutter. The {{< image src="/images/Flow Editor - Show Advanced Properties.png" >}} icon displays them and then changes to {{< image src="/images/Flow Editor - Hide Advanced Properties.png" >}} to hide them. + +### Add Variables + +The {{< image src="/images/Flow Editor - Add Variables.png" >}} icon enables the bulk creation of any undeclared [variables][What is a Variable?] referenced in any of the block’s properties Variable Editor. This provides for an easy way to declare new variables used by the block without having to individually create them in the [Variables Grid][]. + +### Help + +The {{< image src="/images/Flow Editor - Help.png" >}} icon opens a new browser tab displaying the relevant help documentation in the Product Portal. + +## Actions + +### Display Property Type and Data Type + +To display the Property Type and expected Data Type, hover the cursor over the Property name. + +See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step guide. + +### Change Property Editor + +Click on the icon to the left of the Property name to cycle through the available Property Editors for that property. They will cycle in the following order: + +* The Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}} +* The Expression Editor {{< image src="/images/Flow Editor - Expression Editor.png" >}} +* The Literal Editor {{< image src="/images/Flow Editor - Literal Editor.png" >}} + +{{% alert title="Note" %}}Not all properties allow use of all three Property Editors.{{% /alert %}} + +See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step guide. + +### Change Property Data Type + +Click the {{< image src="/images/Flow Editor - Change Data Type.png" >}} icon to the right of the property name to change the input property data type; the property name will change to display an editable field containing the current data type set for this property. Edit or delete the existing data type to reveal a drop-down menu of all possible data types allowable for this property; select the desired data type. + +{{% alert title="Note" %}}Not all input properties allow their data types to be changed.{{% /alert %}} + +### Show/Hide Advanced Properties + +Click the {{< image src="/images/Flow Editor - Show Advanced Properties.png" >}} icon on the Property Editor’s title bar to show the selected block's advanced properties. + +When advanced properties are visible, click the {{< image src="/images/Flow Editor - Hide Advanced Properties.png" >}} icon to hide them. + +See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step guide. + +### Add Variables + +Click the {{< image src="/images/Flow Editor - Add Variables.png" >}} icon on the Property Editor’s title bar to automatically create all uncreated variables that have been referenced in the any of the block's properties that are using the Variable Editor. + +This action will also open the Variables Grid in the [Bottom Panel][]. + +See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step guide. + +### Help + +Click the {{< image src="/images/Flow Editor - Help.png" >}} icon on the Property Editor’s title bar to open the Product Portal in a new browser tab. The new tab will display information that is relevant to this block. + +See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* The Expression Editor does not support the creation of undeclared variables using the Add Variables feature. +* Although it is possible to attempt to change the input data type for the Expression and Variable Editors, the data type of the C# expression entered into the Expression Editor or the Variable specified in the Variable Editor will define the actual data type. + +## See Also + +### Related Concepts + +* [Blocks][] +* [Variables][] +* [Workspaces][] + +### Related Tutorials + +* [Property Editor][Property Editor tutorial] + +[literaltext]: {{< ref "#free-format-literal-text" >}} +[input]: {{< ref "#input" >}} +[inputoutput]: {{< ref "#inputoutput" >}} +[output]: {{< ref "#output" >}} + +[advanced properties]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Bottom Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MainDoc" >}} +[Input properties]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput properties]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output properties]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} +[property editors]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.MainDoc" >}} +[Property Editor tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.PropertyEditor" >}} +[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 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 Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}} +[What is a Workspace?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc" >}} +[Workspaces]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/settings-editor.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/settings-editor.md new file mode 100644 index 000000000..a1d720edc --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/settings-editor.md @@ -0,0 +1,70 @@ +--- +title: "Settings Editor" +linkTitle: "Settings Editor" +description: "Set the values of input variables used when debugging a flow." +weight: 40 +--- + +# {{% param title %}} + +## Summary + +The Settings Editor enables the developer to set the values of the [input variables][Flow Input Variable] used when debugging a [flow][What is a Flow?]. + +## Anatomy + +{{< figure src="/images/Flow Editor - Settings Editor.png" title="Settings Editor" >}} + +Every input variable has a corresponding [Expression Editor][], each of which MUST be set, otherwise an [error][Messages Grid] will be raised when a flow is attempted to be debugged. + +If an input variable has been assigned a default value, the value configured in the Settings Editor will overwrite the value. If an input variable's default value is to be used, the default value must be copied into the relevant Expression Editor. Null and typed null values (e.g. `null` and `(Structure)null`) are permitted. + +When any of the `Name`, `Is Input Variable?` or `Scope` properties are changed for a variable in the [Variables Grid][], the Settings Editor will show a warning message to update the input variables. + +## Actions + +### Make a variable an Input Variable + +To make a variable an input variable, open the [Variables Grid][] by selecting on the Variables tab. Double-click on the `Is Input Variable?` property of the variable that is to be made an input variable, and tick the checkbox that appears in the field. + +See the [Settings Editor][Settings Editor tutorial] tutorial for a step-by-step guide. + +### Update Input Variables in Settings Editor + +When a new input variable is [defined][], or an existing input variable is renamed, deleted, has it's `Is Input Variable?` changed to false or has it's [scope][Variable Scopes] changed, it is necessary to update the Input Variables in the Settings Editor. To do this, click on the `Update Inputs` button on the Settings Editor. + +See the [Settings Editor][Settings Editor tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* A value must be entered for each input variable even if that variable has a default value assigned. + +## See Also + +### Related Concepts + +* [Flows][] +* [Messages][] +* [Variables][] + +### Related Tutorials + +* [Settings Editor][Settings Editor tutorial] + +[defined]: {{< ref "#make-a-variable-an-input-variable" >}} +[Variables Viewer]: {{< ref "#variables-viewer" >}} +[Variables Details Viewer]: {{< ref "#variables-details-viewer" >}} + +[Expression Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[Flow Input Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}} +[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" >}} +[Settings Editor tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.SettingsEditor" >}} +[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}} +[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" >}} diff --git a/content/en/docs/2025.3/Reference/Concepts/fundamentals/variables/variable-scopes.md b/content/en/docs/2025.3/Reference/Concepts/fundamentals/variables/variable-scopes.md index 160245078..a8258f433 100644 --- a/content/en/docs/2025.3/Reference/Concepts/fundamentals/variables/variable-scopes.md +++ b/content/en/docs/2025.3/Reference/Concepts/fundamentals/variables/variable-scopes.md @@ -16,9 +16,9 @@ When the [flow execution][execution] exits a workspace, any local-scope variable ## Accessing Variables from Other Scopes -For example, the table below shows a hierarchy of workspaces and which variables are available to each workspace due to their scope: +For example, the table below shows a hierarchy of workspaces and which variables are accessible to each workspace due to their scope: -| Workspace Name | Parent Workspace | Defined Variables | Available Variables | +| Workspace Name | Parent Workspace | Defined Variables | Accessible Variables | |----------------|------------------|-------------------|---------------------| | Top-Level Workspace | N/A | | | | ChildWorkspace1 | Top-Level Workspace | | | diff --git a/content/en/docs/2025.3/Tutorials/Administration/_index.md b/content/en/docs/2025.3/Tutorials/Administration/_index.md index 683d27a18..6cce760b9 100644 --- a/content/en/docs/2025.3/Tutorials/Administration/_index.md +++ b/content/en/docs/2025.3/Tutorials/Administration/_index.md @@ -2,6 +2,6 @@ title: "Administration" linkTitle: "Administration" description: "This section includes tutorials about administering the {{% ctx %}} platform." -weight: 40 +weight: 30 --- diff --git a/content/en/docs/2025.3/Tutorials/Development/_index.md b/content/en/docs/2025.3/Tutorials/Development/_index.md new file mode 100644 index 000000000..1ef656f29 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/_index.md @@ -0,0 +1,7 @@ +--- +title: "Development" +linkTitle: "Development" +description: "This section includes tutorials about developing flows on the {{% ctx %}} platform." +weight: 10 +--- + diff --git a/content/en/docs/2025.3/Tutorials/Development/flow-editor/_index.md b/content/en/docs/2025.3/Tutorials/Development/flow-editor/_index.md new file mode 100644 index 000000000..30fbdca42 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/flow-editor/_index.md @@ -0,0 +1,7 @@ +--- +title: "Flow Editor" +linkTitle: "Flow Editor" +description: "This section includes tutorials about viewing, editing and debugging flows on the {{% ctx %}} platform." +weight: 10 +--- + diff --git a/content/en/docs/2025.3/Tutorials/Development/flow-editor/bottom-panel.md b/content/en/docs/2025.3/Tutorials/Development/flow-editor/bottom-panel.md new file mode 100644 index 000000000..cf9e9a094 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/flow-editor/bottom-panel.md @@ -0,0 +1,51 @@ +--- +title: "Bottom Panel" +linkTitle: "Bottom Panel" +description: "This section includes tutorials about using the Bottom Panel of the Flow Editor." +weight: 50 +--- + +# {{% param title %}} + +## Executions Grid + +### Continue and Stop the Execution + +{{< scribe title="Continue_the_Execution_and_Stop_the_Execution" id="Y1VaqZLTQlaLm6bS5c_jGQ" >}} + +### Step the Execution + +{{< scribe title="Step_the_Execution" id="FYz8savqQr-w8ZGWqxnhnQ" >}} + +### Start Tracking + +{{< scribe title="Start_Tracking" id="Hi2nxtqURs2g8fo59urcOg" >}} + +### Stop Tracking and Go To + +{{< scribe title="Stop_Tracking_and_Go_To" id="VkUp_RXyQj-xEVBli-OLmA" >}} + +### Show Initial Flow First or Last + +{{< scribe title="Show_Initial_Flow_FirstLast" id="__iaRBIgSjePGD0-0Cl1ow" >}} + +## Messages Grid + +{{< scribe title="How_to_Navigate_to_Property_with_Error" id="7zwoOTsUTZW8-QTmucb8cA" >}} + +## Variables Grid + +### Create, Rename and Delete a Variable +{{< scribe title="How_to_Create_Rename_and_Delete_a_Variable" id="3Yx8TfgcSsm38KGu8C1B_w" >}} + +### Assign a Default Value to a Variable + +{{< scribe title="How_to_Assign_a_Default_Value_to_a_Variable" id="fgjoV9dbQaeZUzvRSTzrWQ" >}} + +### Define an Input or Output Variable + +{{< scribe title="How_to_Define_an_Input_or_Output_Variable" id="HG7rX8GZSfe17bf8EGqKiw" >}} + +### Modify the Scope of a Variable + +{{< scribe title="How_to_Modify_the_Scope_of_a_Variable" id="uzt2aqj0SOSCjIqwWWAdAA" >}} diff --git a/content/en/docs/2025.3/Tutorials/Development/flow-editor/left-panel.md b/content/en/docs/2025.3/Tutorials/Development/flow-editor/left-panel.md new file mode 100644 index 000000000..cacf2061a --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/flow-editor/left-panel.md @@ -0,0 +1,20 @@ +--- +title: "Left Panel" +linkTitle: "Left Panel" +description: "This section includes tutorials about using the Left Panel of the Flow Editor." +weight: 20 +--- + +# {{% param title %}} + +## View Blocks in the Palette + +{{< scribe title="View_Function_Blocks_in_the_Palette" id="XgE3OMd_T86hTPSJJPdQtQ" >}} + +## Searching the Palette for a Block + +{{< scribe title="Searching_the_Palette_for_a_Block" id="cyWAex1MSRC0RXHiOkBEsQ" >}} + +## Placing a Block from the Palette onto a Workspace + +{{< scribe title="Placing_a_Block_from_the_Palette_onto_a_Workspace" id="5XlnJvprRp6fPHd_JHA6nw" >}} diff --git a/content/en/docs/2025.3/Tutorials/Development/flow-editor/main-panel.md b/content/en/docs/2025.3/Tutorials/Development/flow-editor/main-panel.md new file mode 100644 index 000000000..116f29f02 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/flow-editor/main-panel.md @@ -0,0 +1,40 @@ +--- +title: "Main Panel" +linkTitle: "Main Panel" +description: "This section includes tutorials about using the Main Panel of the Flow Editor." +weight: 30 +--- + +# {{% param title %}} + +## Undo and Redo Changes + +{{< scribe title="Redo_and_Undo_Flow_Changes" id="iv4tSynyTdOF_KM8m-gj_A" >}} + +## Start an Execution + +{{< scribe title="Execution_Options_and_Start_an_Execution" id="eIlJucHPRPOZ_s37BAu0Jg" >}} + +## Edit Flow and Continue Debugging + +{{< scribe title="Edit_Flow_and_Continue_Debugging" id="cAkx-vH6RpWhjWpkEyePRg" >}} + +## Remove All Breakpoints + +{{< scribe title="Remove_All_Breakpoints" id="BI8BnbwETdK7fDDJYDZBuQ" >}} + +## Save and Commit Flow + +{{< scribe title="Save_and_Commit_Flow" id="YhChblBZTM-xxQUkkI-wfw" >}} + +## Get Master Version of Flow + +{{< scribe title="Get_Master_Version_of_Flow" id="2Biuxb5NTU-tZYOmMECGvA" >}} + +## Compare Flow with Master Version + +{{< scribe title="Compare_Flow_with_Master_Version" id="gtMBJZ44RHWV5vWpgMWTMw" >}} + +## Delete Flow + +{{< scribe title="Delete_a_Flow" id="1N9rmBcJSOCGQPws6fYxEw" >}} diff --git a/content/en/docs/2025.3/Tutorials/Development/flow-editor/navigation-bar.md b/content/en/docs/2025.3/Tutorials/Development/flow-editor/navigation-bar.md new file mode 100644 index 000000000..c75797063 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/flow-editor/navigation-bar.md @@ -0,0 +1,24 @@ +--- +title: "Navigation Bar" +linkTitle: "Navigation Bar" +description: "This section includes tutorials about using the Navigation Bar on the Flow Editor." +weight: 10 +--- + +# {{% param title %}} + +## Accessing Help + +{{< scribe title="Accessing_Help" id="v1d_xFr4QfaM926GSZ86cw" >}} + +## Quick Navigation Between Open Flows + +{{< scribe title="Quick_Navigation_Between_Open_Flows" id="Xls4Yx7iTNePDrqsxd9_yA" >}} + +## Sequential Navigation Between Open Flows + +{{< scribe title="Navigate_Between_Open_Flows" id="E-mrlk-2T2-X6HXIwtaAdw" >}} + +## Close Flow + +{{< scribe title="Close_a_Flow" id="vFCfyboERgarOVLQuMUhng" >}} diff --git a/content/en/docs/2025.3/Tutorials/Development/flow-editor/right-panel.md b/content/en/docs/2025.3/Tutorials/Development/flow-editor/right-panel.md new file mode 100644 index 000000000..6f91e4ff4 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Development/flow-editor/right-panel.md @@ -0,0 +1,25 @@ +--- +title: "Right Panel" +linkTitle: "Right Panel" +description: "This section includes tutorials about using the Right Panel of the Flow Editor." +weight: 40 +--- + +# {{% param title %}} + +## Property Editor +{{< scribe title="Property_Editor" id="OT-FhbkGRLqjew0CPeDKXA" >}} + +## Execution Viewer + +### Variables Viewer + +{{< scribe title="Execution_Viewer" id="sK8g3XG0Q5qG1JOpw1MBJA" >}} + +### Exceptions Viewer + +{{< scribe title="Exceptions_Viewer" id="t0YyBLq3S-6vHawaGQ0ChQ" >}} + +## Settings Editor + +{{< scribe title="Settings_Editor" id="dfeGyFFkThime4nYtRMlcw" >}} diff --git a/content/en/docs/2025.3/Tutorials/Operations/_index.md b/content/en/docs/2025.3/Tutorials/Operations/_index.md index 6d00f05d9..5d39b9c45 100644 --- a/content/en/docs/2025.3/Tutorials/Operations/_index.md +++ b/content/en/docs/2025.3/Tutorials/Operations/_index.md @@ -2,6 +2,6 @@ title: "Operations" linkTitle: "Operations" description: "This section includes tutorials about operating the {{% ctx %}} platform." -weight: 40 +weight: 20 --- diff --git a/content/static/2025.3/images/Flow Editor - Add Variables.png b/content/static/2025.3/images/Flow Editor - Add Variables.png new file mode 100644 index 000000000..a80809f70 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Add Variables.png differ diff --git a/content/static/2025.3/images/Flow Editor - Bottom Panel.png b/content/static/2025.3/images/Flow Editor - Bottom Panel.png new file mode 100644 index 000000000..98f6e5259 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Bottom Panel.png differ diff --git a/content/static/2025.3/images/Flow Editor - Change Data Type.png b/content/static/2025.3/images/Flow Editor - Change Data Type.png new file mode 100644 index 000000000..216245f87 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Change Data Type.png differ diff --git a/content/static/2025.3/images/Flow Editor - Close Flow.png b/content/static/2025.3/images/Flow Editor - Close Flow.png new file mode 100644 index 000000000..51e7825bf Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Close Flow.png differ diff --git a/content/static/2025.3/images/Flow Editor - Collapse All.png b/content/static/2025.3/images/Flow Editor - Collapse All.png new file mode 100644 index 000000000..06887f6b7 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Collapse All.png differ diff --git a/content/static/2025.3/images/Flow Editor - Collapse Palette.png b/content/static/2025.3/images/Flow Editor - Collapse Palette.png new file mode 100644 index 000000000..e4310c864 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Collapse Palette.png differ diff --git a/content/static/2025.3/images/Flow Editor - Commit.png b/content/static/2025.3/images/Flow Editor - Commit.png new file mode 100644 index 000000000..b93d4febf Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Commit.png differ diff --git a/content/static/2025.3/images/Flow Editor - Compare with Master.png b/content/static/2025.3/images/Flow Editor - Compare with Master.png new file mode 100644 index 000000000..dea96abe8 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Compare with Master.png differ diff --git a/content/static/2025.3/images/Flow Editor - Continue Debugging.png b/content/static/2025.3/images/Flow Editor - Continue Debugging.png new file mode 100644 index 000000000..710cdd6db Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Continue Debugging.png differ diff --git a/content/static/2025.3/images/Flow Editor - Continue Execution.png b/content/static/2025.3/images/Flow Editor - Continue Execution.png new file mode 100644 index 000000000..e479d2175 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Continue Execution.png differ diff --git a/content/static/2025.3/images/Flow Editor - Delete Flow.png b/content/static/2025.3/images/Flow Editor - Delete Flow.png new file mode 100644 index 000000000..74f31b28b Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Delete Flow.png differ diff --git a/content/static/2025.3/images/Flow Editor - Disable Filtering.png b/content/static/2025.3/images/Flow Editor - Disable Filtering.png new file mode 100644 index 000000000..091b5d09d Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Disable Filtering.png differ diff --git a/content/static/2025.3/images/Flow Editor - Edit Flow.png b/content/static/2025.3/images/Flow Editor - Edit Flow.png new file mode 100644 index 000000000..268240931 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Edit Flow.png differ diff --git a/content/static/2025.3/images/Flow Editor - Enable Filtering.png b/content/static/2025.3/images/Flow Editor - Enable Filtering.png new file mode 100644 index 000000000..a2f72c1b2 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Enable Filtering.png differ diff --git a/content/static/2025.3/images/Flow Editor - Exceptions Viewer.png b/content/static/2025.3/images/Flow Editor - Exceptions Viewer.png new file mode 100644 index 000000000..7360279e9 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Exceptions Viewer.png differ diff --git a/content/static/2025.3/images/Flow Editor - Execution Options.png b/content/static/2025.3/images/Flow Editor - Execution Options.png new file mode 100644 index 000000000..c6207bd5b Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Execution Options.png differ diff --git a/content/static/2025.3/images/Flow Editor - Execution Viewer.png b/content/static/2025.3/images/Flow Editor - Execution Viewer.png new file mode 100644 index 000000000..9ea217336 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Execution Viewer.png differ diff --git a/content/static/2025.3/images/Flow Editor - Executions Grid.png b/content/static/2025.3/images/Flow Editor - Executions Grid.png new file mode 100644 index 000000000..0348f2ef0 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Executions Grid.png differ diff --git a/content/static/2025.3/images/Flow Editor - Expand All.png b/content/static/2025.3/images/Flow Editor - Expand All.png new file mode 100644 index 000000000..208b2f15d Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Expand All.png differ diff --git a/content/static/2025.3/images/Flow Editor - Expand Palette.png b/content/static/2025.3/images/Flow Editor - Expand Palette.png new file mode 100644 index 000000000..dd693909b Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Expand Palette.png differ diff --git a/content/static/2025.3/images/Flow Editor - Expression Editor.png b/content/static/2025.3/images/Flow Editor - Expression Editor.png new file mode 100644 index 000000000..f6e1e0f5a Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Expression Editor.png differ diff --git a/content/static/2025.3/images/Flow Editor - Get Master.png b/content/static/2025.3/images/Flow Editor - Get Master.png new file mode 100644 index 000000000..41e39f9d5 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Get Master.png differ diff --git a/content/static/2025.3/images/Flow Editor - Go To.png b/content/static/2025.3/images/Flow Editor - Go To.png new file mode 100644 index 000000000..6997c7cc9 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Go To.png differ diff --git a/content/static/2025.3/images/Flow Editor - Help.png b/content/static/2025.3/images/Flow Editor - Help.png new file mode 100644 index 000000000..9f8d4bfec Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Help.png differ diff --git a/content/static/2025.3/images/Flow Editor - Hide Advanced Properties.png b/content/static/2025.3/images/Flow Editor - Hide Advanced Properties.png new file mode 100644 index 000000000..953ea1945 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Hide Advanced Properties.png differ diff --git a/content/static/2025.3/images/Flow Editor - Hide Filters.png b/content/static/2025.3/images/Flow Editor - Hide Filters.png new file mode 100644 index 000000000..049d5dde3 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Hide Filters.png differ diff --git a/content/static/2025.3/images/Flow Editor - Left Panel.png b/content/static/2025.3/images/Flow Editor - Left Panel.png new file mode 100644 index 000000000..4626249ba Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Left Panel.png differ diff --git a/content/static/2025.3/images/Flow Editor - Literal Editor.png b/content/static/2025.3/images/Flow Editor - Literal Editor.png new file mode 100644 index 000000000..02b0b79fa Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Literal Editor.png differ diff --git a/content/static/2025.3/images/Flow Editor - Main Panel.png b/content/static/2025.3/images/Flow Editor - Main Panel.png new file mode 100644 index 000000000..0bdc0e668 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Main Panel.png differ diff --git a/content/static/2025.3/images/Flow Editor - Messages Grid.png b/content/static/2025.3/images/Flow Editor - Messages Grid.png new file mode 100644 index 000000000..37b7d1ad0 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Messages Grid.png differ diff --git a/content/static/2025.3/images/Flow Editor - Navigation Bar.png b/content/static/2025.3/images/Flow Editor - Navigation Bar.png new file mode 100644 index 000000000..26ec87c0c Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Navigation Bar.png differ diff --git a/content/static/2025.3/images/Flow Editor - Next Flow.png b/content/static/2025.3/images/Flow Editor - Next Flow.png new file mode 100644 index 000000000..f83340789 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Next Flow.png differ diff --git a/content/static/2025.3/images/Flow Editor - Pause Execution.png b/content/static/2025.3/images/Flow Editor - Pause Execution.png new file mode 100644 index 000000000..97be953f1 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Pause Execution.png differ diff --git a/content/static/2025.3/images/Flow Editor - Previous Flow.png b/content/static/2025.3/images/Flow Editor - Previous Flow.png new file mode 100644 index 000000000..dbcd1aadf Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Previous Flow.png differ diff --git a/content/static/2025.3/images/Flow Editor - Property Editor.png b/content/static/2025.3/images/Flow Editor - Property Editor.png new file mode 100644 index 000000000..9a8908e49 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Property Editor.png differ diff --git a/content/static/2025.3/images/Flow Editor - Quick Navigation.png b/content/static/2025.3/images/Flow Editor - Quick Navigation.png new file mode 100644 index 000000000..84228e5f8 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Quick Navigation.png differ diff --git a/content/static/2025.3/images/Flow Editor - Recently Used Workspaces.png b/content/static/2025.3/images/Flow Editor - Recently Used Workspaces.png new file mode 100644 index 000000000..940716e50 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Recently Used Workspaces.png differ diff --git a/content/static/2025.3/images/Flow Editor - Redo.png b/content/static/2025.3/images/Flow Editor - Redo.png new file mode 100644 index 000000000..28e483340 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Redo.png differ diff --git a/content/static/2025.3/images/Flow Editor - Remove Breakpoints.png b/content/static/2025.3/images/Flow Editor - Remove Breakpoints.png new file mode 100644 index 000000000..911fd2770 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Remove Breakpoints.png differ diff --git a/content/static/2025.3/images/Flow Editor - Reset Zoom.png b/content/static/2025.3/images/Flow Editor - Reset Zoom.png new file mode 100644 index 000000000..912adbaee Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Reset Zoom.png differ diff --git a/content/static/2025.3/images/Flow Editor - Right Panel.png b/content/static/2025.3/images/Flow Editor - Right Panel.png new file mode 100644 index 000000000..fff6beb9c Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Right Panel.png differ diff --git a/content/static/2025.3/images/Flow Editor - Save.png b/content/static/2025.3/images/Flow Editor - Save.png new file mode 100644 index 000000000..e7e35cc40 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Save.png differ diff --git a/content/static/2025.3/images/Flow Editor - Settings Editor.png b/content/static/2025.3/images/Flow Editor - Settings Editor.png new file mode 100644 index 000000000..575f4188b Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Settings Editor.png differ diff --git a/content/static/2025.3/images/Flow Editor - Show Advanced Properties.png b/content/static/2025.3/images/Flow Editor - Show Advanced Properties.png new file mode 100644 index 000000000..7f20c11e5 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Show Advanced Properties.png differ diff --git a/content/static/2025.3/images/Flow Editor - Show Filters.png b/content/static/2025.3/images/Flow Editor - Show Filters.png new file mode 100644 index 000000000..456112e72 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Show Filters.png differ diff --git a/content/static/2025.3/images/Flow Editor - Show First.png b/content/static/2025.3/images/Flow Editor - Show First.png new file mode 100644 index 000000000..5a69c9a38 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Show First.png differ diff --git a/content/static/2025.3/images/Flow Editor - Show Last.png b/content/static/2025.3/images/Flow Editor - Show Last.png new file mode 100644 index 000000000..3fc9983a1 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Show Last.png differ diff --git a/content/static/2025.3/images/Flow Editor - Shrink Wrap.png b/content/static/2025.3/images/Flow Editor - Shrink Wrap.png new file mode 100644 index 000000000..d4b5573b3 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Shrink Wrap.png differ diff --git a/content/static/2025.3/images/Flow Editor - Sort Variables.png b/content/static/2025.3/images/Flow Editor - Sort Variables.png new file mode 100644 index 000000000..798f8c58d Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Sort Variables.png differ diff --git a/content/static/2025.3/images/Flow Editor - Start Execution.png b/content/static/2025.3/images/Flow Editor - Start Execution.png new file mode 100644 index 000000000..c264895b2 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Start Execution.png differ diff --git a/content/static/2025.3/images/Flow Editor - Start Tracking.png b/content/static/2025.3/images/Flow Editor - Start Tracking.png new file mode 100644 index 000000000..9812c8fa5 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Start Tracking.png differ diff --git a/content/static/2025.3/images/Flow Editor - Step Execution.png b/content/static/2025.3/images/Flow Editor - Step Execution.png new file mode 100644 index 000000000..2a6a6e5ec Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Step Execution.png differ diff --git a/content/static/2025.3/images/Flow Editor - Stop Execution.png b/content/static/2025.3/images/Flow Editor - Stop Execution.png new file mode 100644 index 000000000..d9bb1cde3 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Stop Execution.png differ diff --git a/content/static/2025.3/images/Flow Editor - Stop Tracking.png b/content/static/2025.3/images/Flow Editor - Stop Tracking.png new file mode 100644 index 000000000..bc52d4049 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Stop Tracking.png differ diff --git a/content/static/2025.3/images/Flow Editor - Undo.png b/content/static/2025.3/images/Flow Editor - Undo.png new file mode 100644 index 000000000..2232224b9 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Undo.png differ diff --git a/content/static/2025.3/images/Flow Editor - Variable Editor.png b/content/static/2025.3/images/Flow Editor - Variable Editor.png new file mode 100644 index 000000000..d699eeecd Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Variable Editor.png differ diff --git a/content/static/2025.3/images/Flow Editor - Variables Grid.png b/content/static/2025.3/images/Flow Editor - Variables Grid.png new file mode 100644 index 000000000..84deb5a4c Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Variables Grid.png differ diff --git a/content/static/2025.3/images/Flow Editor - Variables Viewer.png b/content/static/2025.3/images/Flow Editor - Variables Viewer.png new file mode 100644 index 000000000..23fd4b7fc Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Variables Viewer.png differ diff --git a/content/static/2025.3/images/Flow Editor - Zoom In.png b/content/static/2025.3/images/Flow Editor - Zoom In.png new file mode 100644 index 000000000..509348f4a Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Zoom In.png differ diff --git a/content/static/2025.3/images/Flow Editor - Zoom Out.png b/content/static/2025.3/images/Flow Editor - Zoom Out.png new file mode 100644 index 000000000..b6c5dd56a Binary files /dev/null and b/content/static/2025.3/images/Flow Editor - Zoom Out.png differ diff --git a/content/static/2025.3/images/Flow Editor.png b/content/static/2025.3/images/Flow Editor.png new file mode 100644 index 000000000..d90e0db50 Binary files /dev/null and b/content/static/2025.3/images/Flow Editor.png differ diff --git a/data/urls.toml b/data/urls.toml index 7d6f00942..d6f56f311 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -959,8 +959,38 @@ [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation] MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-authorisation/" Edit = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-authorisation/#edit" + View = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-authorisation/#view" [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport] MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-import/" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel" + ExecutionsGrid = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/executions-grid" + MessagesGrid = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/messages-grid" + VariablesGrid = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/bottom-panel/variables-grid" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.LeftPanel] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/left-panel" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel" + ExecutionOptions = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel/#execution-options" + MainToolbar = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel/#main-toolbar" + Workspaces = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel/#workspaces" + WorkspaceToolbar = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/main-panel/#workspace-toolbar" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.NavigationBar] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/navigation-bar" + BreadcrumbTrail = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/navigation-bar/#breadcrumb-trail" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel" + PropertyEditor = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/property-editor" + SettingsEditor = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/settings-editor" + [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer" + ExceptionsViewer = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/exceptions-viewer" + VariablesViewer = "/docs/guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer/variables-viewer" + [Cortex.Reference] MainDoc = "/docs/reference/" [Cortex.Reference.Apis] @@ -1789,6 +1819,7 @@ VariableEditor = "/docs/reference/concepts/fundamentals/variables/using-variables/#variable-editor" [Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes] MainDoc = "/docs/reference/concepts/fundamentals/variables/variable-scopes/" + Accessible = "/docs/reference/concepts/fundamentals/variables/variable-scopes/#accessing-variables-from-other-scopes" [Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable] MainDoc = "/docs/reference/concepts/fundamentals/variables/what-is-a-variable/" FlowInputVariable = "/docs/reference/concepts/fundamentals/variables/what-is-a-variable/#flow-input-variable" @@ -2815,7 +2846,51 @@ [Cortex.Tutorials.Administration.VersionControl] MainDoc = "/docs/tutorials/administration/version-control" UseVersionControl = "/docs/tutorials/administration/version-control/#use-version-control" - [Cortex.Tutorials.Operations] + [Cortex.Tutorials.Development] + MainDoc = "/docs/tutorials/development" + [Cortex.Tutorials.Development.FlowEditor] + MainDoc = "/docs/tutorials/development/flow-editor" + [Cortex.Tutorials.Development.FlowEditor.BottomPanel] + MainDoc = "/docs/tutorials/development/flow-editor/bottom-panel" + AssignDefaultVariableValue = "/docs/tutorials/development/flow-editor/bottom-panel/#assign-a-default-value-to-a-variable" + ContinueStopExecution = "/docs/tutorials/development/flow-editor/bottom-panel/#continue-and-stop-the-execution" + CreateRenameDeleteVariable = "/docs/tutorials/development/flow-editor/bottom-panel/#create-rename-and-delete-a-variable" + DefineInputOutputVariable = "/docs/tutorials/development/flow-editor/bottom-panel/#define-an-input-or-output-variable" + MessagesGrid = "/docs/tutorials/development/flow-editor/bottom-panel/#messages-grid" + ModifyVariableScope = "/docs/tutorials/development/flow-editor/bottom-panel/#modify-the-scope-of-a-variable" + ShowFirstLast = "/docs/tutorials/development/flow-editor/bottom-panel/#show-initial-flow-first-or-last" + StartTracking = "/docs/tutorials/development/flow-editor/bottom-panel/#start-tracking" + StepExecution = "/docs/tutorials/development/flow-editor/bottom-panel/#step-the-execution" + StopTrackingGoTo = "/docs/tutorials/development/flow-editor/bottom-panel/#stop-tracking-and-go-to" + [Cortex.Tutorials.Development.FlowEditor.LeftPanel] + MainDoc = "/docs/tutorials/development/flow-editor/left-panel" + PlaceBlocks = "/docs/tutorials/development/flow-editor/left-panel/#placing-a-block-from-the-palette-onto-a-workspace" + SearchBlocks = "/docs/tutorials/development/flow-editor/left-panel/#searching-the-palette-for-a-block" + ViewBlocks = "/docs/tutorials/development/flow-editor/left-panel/#view-blocks-in-the-palette" + [Cortex.Tutorials.Development.FlowEditor.MainPanel] + MainDoc = "/docs/tutorials/development/flow-editor/main-panel" + CompareMaster = "/docs/tutorials/development/flow-editor/main-panel/#compare-flow-with-master-version" + DeleteFlow = "/docs/tutorials/development/flow-editor/main-panel/#delete-flow" + EditFlow = "/docs/tutorials/development/flow-editor/main-panel/#edit-flow-and-continue-debugging" + GetMaster = "/docs/tutorials/development/flow-editor/main-panel/#get-master-version-of-flow" + RemoveBreakpoints = "/docs/tutorials/development/flow-editor/main-panel/#remove-all-breakpoints" + SaveCommit = "/docs/tutorials/development/flow-editor/main-panel/#save-and-commit-flow" + StartExecution = "/docs/tutorials/development/flow-editor/main-panel/#start-an-execution" + UndoRedo = "/docs/tutorials/development/flow-editor/main-panel/#undo-and-redo-changes" + [Cortex.Tutorials.Development.FlowEditor.NavigationBar] + MainDoc = "/docs/tutorials/development/flow-editor/navigation-bar" + SequentialNavigation = "/docs/tutorials/development/flow-editor/navigation-bar/#sequential-navigation-between-open-flows" + QuickNavigation = "/docs/tutorials/development/flow-editor/navigation-bar/#quick-navigation-between-open-flows" + AccessHelp = "/docs/tutorials/development/flow-editor/navigation-bar/#accessing-help" + CloseFlow = "/docs/tutorials/development/flow-editor/navigation-bar/#close-flow" + [Cortex.Tutorials.Development.FlowEditor.RightPanel] + MainDoc = "/docs/tutorials/development/flow-editor/right-panel" + ExceptionsViewer = "/docs/tutorials/development/flow-editor/right-panel/#exceptions-viewer" + ExecutionViewer = "/docs/tutorials/development/flow-editor/right-panel/#execution-viewer" + VariablesViewer = "/docs/tutorials/development/flow-editor/right-panel/#variables-viewer" + PropertyEditor = "/docs/tutorials/development/flow-editor/right-panel/#property-editor" + SettingsEditor = "/docs/tutorials/development/flow-editor/right-panel/#settings-editor" + [Cortex.Tutorials.Operations] MainDoc = "/docs/tutorials/Operations" [Cortex.Tutorials.Operations.Overview] MainDoc = "/docs/tutorials/Operations/overview"