Skip to content

Commit 1210ca6

Browse files
author
Donna-Marie Smith
committed
Changes following further PO Review
1 parent fe6fc08 commit 1210ca6

File tree

5 files changed

+29
-23
lines changed

5 files changed

+29
-23
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Execution Viewer"
33
linkTitle: "Execution Viewer"
4-
description: "TODO"
4+
description: "View execution information when debugging a flow."
55
weight: 30
66
---

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,34 @@ The Exceptions Viewer shows details of any [exceptions][What is an Exception?] w
1515

1616
{{< figure src="/images/Flow Editor - Exceptions Viewer.png" title="Exceptions Viewer" >}}
1717

18-
In addition to a detailed description of the exception, the exception message may include an `Inner Exception`, which details the exception associated with a previous exception that led to this exception to be raised. Some exceptions may contain multiple, nested layers of `Inner Exception` messages.
18+
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.
1919

2020
The exact format of the Exception Object depends on the exception raised. All Exception Objects have:
2121

22-
* Exception Type – Machine readable exception type
23-
* Message – Human readable exception message.
24-
25-
The exception message may also contain a help hyperlink, which links to further information relating to this exception.
22+
* Exception Type – The type of the exception.
23+
* Message – The description of the exception.
24+
* HelpLink - A hyperlink to further information relating to the exception.
2625

2726
## Actions
2827

2928
### View Exception
3029

31-
Select the Exception tab on the Right Panel to view all the exceptions raised while debugging the flow. If the execution is stopped, all the exception messages will be discarded.
30+
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.
3231

3332
See the [Exceptions Viewer][Exceptions Viewer tutorial] tutorial for a step-by-step guide.
3433

3534
## Remarks
3635

3736
### Known Limitations
3837

39-
* The text displayed in the Exceptions Viewer cannot be copied to the clipboard to then insert into a text editor.
38+
* The text displayed in the Exceptions Viewer cannot be copied to the clipboard.
4039

4140
## See Also
4241

4342
### Related Concepts
4443

4544
* [Exceptions][]
45+
* [Executions][]
4646
* [Flows][]
4747

4848
### Related Tutorials
@@ -54,8 +54,10 @@ See the [Exceptions Viewer][Exceptions Viewer tutorial] tutorial for a step-by-s
5454

5555
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
5656
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
57+
[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
5758
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
5859
[Exceptions Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExceptionsViewer" >}}
5960
[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}}
6061
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
6162
[What is an Exception?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.WhatIsAnException.MainDoc" >}}
63+
[What is an Execution?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc" >}}

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,23 @@ It is important to note that the Variables Viewer can only display a [JSON][] re
3636

3737
### View Variables in Variables List
3838

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][].
39+
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.
4040

4141
Variables that have not been assigned a value or are out of [scope][Variable Scopes] will not be displayed.
4242

4343
See the [Variables Viewer][Variables Viewer tutorial] tutorial for a step-by-step guide.
4444

45-
### View the Detail of the Value in a Variable
45+
### View the Detail of a Variable
4646

47-
Click on a variable in the Variables List 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.
47+
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.
4848

4949
See the [Variables Viewer][Variables Viewer tutorial] tutorial for a step-by-step guide.
5050

5151
## Remarks
5252

5353
### Known Limitations
5454

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.
55+
* Variables with a [Dictionary<TKey, TValue>][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.
5956

6057
## See Also
6158

@@ -72,11 +69,14 @@ See the [Variables Viewer][Variables Viewer tutorial] tutorial for a step-by-ste
7269
[Variables List]: {{< ref "#variables-list" >}}
7370
[Variable Details Viewer]: {{< ref "#variable-details-viewer" >}}
7471

75-
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
72+
[Dictionary TKey]: {{< url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc" >}}
7673
[Execution Context]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.ExecutionContext" >}}
7774
[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
75+
[Executions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.ExecutionsGrid" >}}
7876
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
7977
[JSON]: {{< url path="Cortex.Reference.Glossary.F-J.Json" >}}
78+
[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
79+
[ToString]: {{< url path="MSDocs.DotNet.Api.System.Object.ToString" >}}
8080
[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}}
8181
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
8282
[Variables Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.VariablesViewer" >}}

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,49 +15,53 @@ The Settings Editor enables the developer to set the values of the [input variab
1515

1616
{{< figure src="/images/Flow Editor - Settings Editor.png" title="Settings Editor" >}}
1717

18-
Each Input variable corresponds to an Expression Editor in the Settings Editor, each of which MUST be set, otherwise an error will be raised by the parser when a flow is attempted to be debugged.
18+
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.
1919

20-
If an input variable has been assigned a default value, the value configured in Settings Editor will overwrite the value assigned to the respective input variable. 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 are allowed in the Settings Editor if required.
20+
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.
2121

22-
When the `Is Input Variable?` property is changed for a variable in the [Variables Grid][], the Settings Editor will show a warning message to update the input variables in the Settings Editor.
22+
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.
2323

2424
## Actions
2525

2626
### Make a variable an Input Variable
2727

28-
To make a variable an Input Variable, open the Variables Grid (Bottom Panel) by selecting on the Variables tab. Double-click on the Is Input Variable? field of the variable that is to be made an Input Variable, and tick the checkbox that appears in the field.
28+
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.
2929

3030
See the [Settings Editor][Settings Editor tutorial] tutorial for a step-by-step guide.
3131

3232
### Update Input Variables in Settings Editor
3333

34-
When a new Input Variable is defined, or an existing Input Variable removed, 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.
34+
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.
3535

3636
See the [Settings Editor][Settings Editor tutorial] tutorial for a step-by-step guide.
3737

3838
## Remarks
3939

4040
### Known Limitations
4141

42-
* A value must be entered for each Input variable even if that variable has a Default Value assigned.
42+
* A value must be entered for each input variable even if that variable has a default value assigned.
4343

4444
## See Also
4545

4646
### Related Concepts
4747

4848
* [Flows][]
49+
* [Messages][]
4950
* [Variables][]
5051

5152
### Related Tutorials
5253

5354
* [Settings Editor][Settings Editor tutorial]
5455

56+
[defined]: {{< ref "#make-a-variable-an-input-variable" >}}
5557
[Variables Viewer]: {{< ref "#variables-viewer" >}}
5658
[Variables Details Viewer]: {{< ref "#variables-details-viewer" >}}
5759

60+
[Expression Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
5861
[Flow Input Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}}
5962
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
60-
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
63+
[Messages]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Messages.MainDoc" >}}
64+
[Messages Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MessagesGrid" >}}
6165
[Settings Editor tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.SettingsEditor" >}}
6266
[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}}
6367
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
2.89 KB
Loading

0 commit comments

Comments
 (0)