Skip to content

Commit eeba691

Browse files
author
Donna-Marie Smith
committed
Added Initial Content for Settings Editor
1 parent 99d13c1 commit eeba691

3 files changed

Lines changed: 57 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: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ It is important to note that the Execution Viewer can only display a JSON repres
3636

3737
### View Variables in Variables Viewer
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][Variable Scopes], simply select the execution of interest and click on the Variables tab on the [Right Panel][].
4040

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

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

@@ -74,6 +74,7 @@ See the [Execution Viewer][Execution Viewer tutorial] tutorial for a step-by-ste
7474
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
7575
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
7676
[Execution Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExecutionViewer" >}}
77+
[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}}
7778
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
7879
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
7980
[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/settings-editor.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,57 @@ linkTitle: "Settings Editor"
44
description: "TODO"
55
weight: 40
66
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
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?].
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Settings Editor.png" title="Settings Editor" >}}
17+
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.
19+
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.
21+
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.
23+
24+
## Actions
25+
26+
### Make a variable an Input Variable
27+
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.
29+
30+
### Update Input Variables in Settings Editor
31+
32+
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.
33+
34+
## Remarks
35+
36+
### Known Limitations
37+
38+
* A value must be entered for each Input variable even if that variable has a Default Value assigned.
39+
40+
## See Also
41+
42+
### Related Concepts
43+
44+
* [Flows][]
45+
* [Variables][]
46+
47+
### Related Tutorials
48+
49+
* [Execution Viewer][Execution Viewer tutorial]
50+
51+
[Variables Viewer]: {{< ref "#variables-viewer" >}}
52+
[Variables Details Viewer]: {{< ref "#variables-details-viewer" >}}
53+
54+
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
55+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
56+
[Execution Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExecutionViewer" >}}
57+
[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}}
58+
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
59+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
60+
[What is a Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}}
129 KB
Loading

0 commit comments

Comments
 (0)