Skip to content

Commit 99d13c1

Browse files
author
Donna-Marie Smith
committed
Added Initial Execution Viewer Content
1 parent 49d55f6 commit 99d13c1

4 files changed

Lines changed: 81 additions & 2 deletions

File tree

content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/execution-viewer.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,76 @@ linkTitle: "Execution Viewer"
44
description: "TODO"
55
weight: 30
66
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Execution Viewer displays the values of the [variables][What is a Variable?] when debugging a [flow][What is a Flow?].
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Execution Viewer.png" title="Execution Viewer" >}}
17+
18+
The Execution Viewer consists of two sections:
19+
20+
* [Variables Viewer][] - displaying the variables configured for the flow being debugged.
21+
* [Variables Details Viewer][] - displaying the value of the variable selected in the Variables Viewer.
22+
23+
### Variables Viewer
24+
25+
The Variables Viewer, at the top of the Execution Viewer, shows the current values of variables containing basic variable types, and the type and structure of collection and complex data type values.
26+
27+
In addition to developer defined variables, system defined variables will also be displayed.
28+
29+
### Variables Details Viewer
30+
31+
The Variables Details Viewer, at the bottom of the Execution Viewer, shows the name and data type of a variable selected in the [Variables Viewer][] as well as it's value, in JSON format. Any collection or complex data types will be expanded to display their contents.
32+
33+
It is important to note that the Execution Viewer can only display a JSON representation of Objects and that an object's methods are not displayed.
34+
35+
## Actions
36+
37+
### View Variables in Variables Viewer
38+
39+
To view the variables that have been assigned a value, including a NULL value, that are currently in scope, simply select the execution of interest and click on the Variables tab on the [Right Panel][].
40+
41+
Variables that have not been assigned a value or are out of scope will not be displayed.
42+
43+
See the [Execution Viewer][Execution Viewer tutorial] tutorial for a step-by-step guide.
44+
45+
### View the Detail of the Value in a Variable
46+
47+
Click on a variable in the Variables Viewer to view the detail of a value, displayed in JSON format, contained in a variable. The detail of collection and complex data types will only the expanded in JSON form in the Variables Details Viewer if the execution is paused.
48+
49+
See the [Execution Viewer][Execution Viewer tutorial] tutorial for a step-by-step guide.
50+
51+
## Remarks
52+
53+
### Known Limitations
54+
55+
* The Variables Details Viewer only display the JSON representation of the selected value.
56+
* Dictionaries with keys of data types other than String will be displayed as a String value.
57+
* The methods of objects will not be displayed.
58+
* The Variables Details Viewer will only show the expanded contents of collection and complex data types when the execution is paused.
59+
60+
## See Also
61+
62+
### Related Concepts
63+
64+
* [Flows][]
65+
* [Variables][]
66+
67+
### Related Tutorials
68+
69+
* [Execution Viewer][Execution Viewer tutorial]
70+
71+
[Variables Viewer]: {{< ref "#variables-viewer" >}}
72+
[Variables Details Viewer]: {{< ref "#variables-details-viewer" >}}
73+
74+
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
75+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
76+
[Execution Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExecutionViewer" >}}
77+
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
78+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
79+
[What is a Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}}

content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/dev/flow-editor/right-panel/property-editor.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 20
99

1010
## Summary
1111

12-
The Property Editor allows for the configuration of the [properties][What is a Block Property?] associated with the [block][What is a Block?] selected in the [Main Panel][].
12+
The Property Editor displays the [properties][What is a Block Property?] of the currently selected [block][What is a Block?].
1313

1414
## Anatomy
1515

@@ -105,6 +105,12 @@ Click the {{< image src="/images/Flow Editor - Help.png" >}} icon on the Propert
105105

106106
See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step guide.
107107

108+
## Remarks
109+
110+
### Known Limitations
111+
112+
* The Expression Editor does not support the creation of undeclared variables using the Add Variables feature.
113+
108114
## See Also
109115

110116
### Related Concepts
@@ -124,7 +130,6 @@ See the [Property Editor][Property Editor tutorial] tutorial for a step-by-step
124130

125131
[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
126132
[Bottom Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MainDoc" >}}
127-
[Main Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.MainPanel.MainDoc" >}}
128133
[Property Editor tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.PropertyEditor" >}}
129134
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
130135
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
160 KB
Loading

data/urls.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2857,6 +2857,7 @@
28572857
CloseFlow = "/docs/tutorials/development/flow-editor/navigation-bar/#close-flow"
28582858
[Cortex.Tutorials.Development.FlowEditor.RightPanel]
28592859
MainDoc = "/docs/tutorials/development/flow-editor/right-panel"
2860+
ExecutionViewer = "/docs/tutorials/development/flow-editor/right-panel/#execution-viewer"
28602861
PropertyEditor = "/docs/tutorials/development/flow-editor/right-panel/#property-editor"
28612862
[Cortex.Tutorials.Operations]
28622863
MainDoc = "/docs/tutorials/Operations"

0 commit comments

Comments
 (0)