Skip to content

Commit 9aa5931

Browse files
author
Donna-Marie Smith
committed
Started adding Right Panel content
1 parent b5f3fc0 commit 9aa5931

11 files changed

Lines changed: 149 additions & 2 deletions

File tree

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Flow Editor page allows you to view, edit and debug [flows][What is a Flow?]
1515

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

18-
The 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.
18+
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.
1919

2020
Each of the [Left][], [Right][] and [Bottom][] panels may be manually opened or closed, expanded or shrunk, independently as required.
2121

@@ -82,7 +82,6 @@ The [Bottom Panel][] consists of 3 tabs:
8282
[Bottom]: {{< ref "#bottom-panel" >}}
8383

8484
[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
85-
[Block Properties]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.MainDoc" >}}
8685
[Bottom Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.MainDoc" >}}
8786
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
8887
[Exceptions Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExceptionsViewer" >}}

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

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,56 @@ linkTitle: "Overview"
44
description: "TODO"
55
weight: 10
66
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
TODO
12+
The Right Panel consists tabs to allow ...
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Right Panel.png" title="Right Panel" >}}
17+
18+
* In `View`, `Edit` or `Debug Edit` mode, the following tabs are available:
19+
20+
* Properties (default) - displays the [Property Editor][] showing the [properties][What is a Block Property?] of the currently selected [block][What is a Block?].
21+
* Settings - displays the [Settings Editor][] to set the values of the [input variables][Flow Input Variable] used when debugging the [flow][What is a Flow?].
22+
23+
* In `Debug` mode, the following tabs are available:
24+
25+
* Variables (default) - displays the [Execution Viewer][] showing the values of the [variables][What is a Variable?] when debugging the [flow][What is a Flow?].
26+
* Exceptions - displays the [Exceptions Viewer][] showing details of any [exceptions][What is an Exception?] when debugging the [flow][What is a Flow?].
27+
* Settings - displays the [Settings Editor][] to set the values of the [input variables][Flow Input Variable] used when debugging the [flow][What is a Flow?].
28+
29+
## See Also
30+
31+
### Related Concepts
32+
33+
* [Blocks][]
34+
* [Exceptions][]
35+
* [Executions][]
36+
* [Flows][]
37+
* [Variables][]
38+
39+
### Related Tutorials
40+
41+
* [Right Panel][Right Panel tutorial]
42+
43+
[Right Panel tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.MainDoc" >}}
44+
45+
[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}}
46+
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
47+
[Exceptions Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExceptionsViewer" >}}
48+
[Execution Viewer]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.ExecutionViewer" >}}
49+
[Executions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Executions.MainDoc" >}}
50+
[Flow Input Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}}
51+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
52+
[Property Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.PropertyEditor" >}}
53+
[Settings Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.SettingsEditor" >}}
54+
[Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.MainDoc" >}}
55+
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
56+
[What is a Block Property?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.MainDoc" >}}
57+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
58+
[What is a Variable?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.MainDoc" >}}
59+
[What is an Exception?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.WhatIsAnException.MainDoc" >}}

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

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,96 @@ linkTitle: "Property Editor"
44
description: "TODO"
55
weight: 20
66
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Property Editor allows for the configuration of the properties associated with the block selected in the Main Panel.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Property Editor.png" title="Property Editor" >}}
17+
18+
The Property Editor is automatically opened when a [block][What is 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.
19+
20+
Every object has one or more properties, which can be one of the following types:
21+
22+
* [Free format literal text][literaltext]
23+
* [input][]
24+
* [output][]
25+
* [inputoutput][]
26+
27+
Each property, 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.
28+
29+
### Property Types
30+
31+
#### Free Format Literal Text
32+
33+
The free format literal text property is used for the description of the block.
34+
35+
#### input
36+
37+
`input` type properties supply a value to be used by a functional block and use either:
38+
39+
* The Expression Editor {{< image src="/images/Flow Editor - Expression Editor.png" >}}
40+
* The Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}}
41+
* The Literal Editor {{< image src="/images/Flow Editor - Literal Editor.png" >}}
42+
43+
#### output
44+
45+
`output` type properties store a value generated by a functional block and use either:
46+
47+
* The Expression Editor {{< image src="/images/Flow Editor - Expression Editor.png" >}}
48+
* The Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}}
49+
50+
#### inputoutput
51+
52+
`inputoutput` type properties supply a value to be used by a functional block and then store a value generated by the functional block to the same variable and only use the Variable Editor {{< image src="/images/Flow Editor - Variable Editor.png" >}}.
53+
54+
### Show Advanced Properties
55+
56+
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 toggles whether these are visible or not.
57+
58+
### Add Variables
59+
60+
The {{< image src="/images/Flow Editor - Add Variables.png" >}} icon enables the bulk creation of any undeclared variables referenced in any of the [block’s properties][What is a Block Property?] Variable Editor. This provides for an easy way to declare new variables used by the object without having to individually create them in the Variables Grid.
61+
62+
### Help
63+
64+
The {{< image src="/images/Flow Editor - Help.png" >}} icon opens a new browser tab displaying the relevant help documentation in the Product Portal.
65+
66+
## Actions
67+
68+
### Display Property Type and Data Type
69+
70+
To display the Property Type and expected Data Type, hover the cursor over the Property name.
71+
72+
### Change Property Editor
73+
74+
Click on the icon to the left of the Property name to cycle through the available Property Editors for that property: Variable Editor -> Expression Editor -> Literal Editor.
75+
76+
Note: Not all Properties allow use of all three Property Editors.
77+
78+
### Show/Hide Advanced Properties
79+
80+
Click the eye icon on the Property Editor’s title bar to toggle between showing or hiding the selected object’s Advanced Properties.
81+
82+
### Add Variables
83+
84+
Click the Plus (+) icon on the Property Editor’s title bar to automatically create all uncreated variables that have been referenced in the any of the object’s properties that are using the Variable Editor.
85+
This action will also open the Variables Grid in the Bottom Panel.
86+
87+
### Help
88+
89+
Click the question mark (?) icon on the Property Editor’s title bar to the Product Portal in a new browser tab. The new tab will display information that is relevant to this object.
90+
91+
92+
[literaltext]: {{< ref "#free-format-literal-text" >}}
93+
[input]: {{< ref "#input" >}}
94+
[inputoutput]: {{< ref "#inputoutput" >}}
95+
[output]: {{< ref "#output" >}}
96+
97+
[What is a Block?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc" >}}
98+
[What is a Block Property?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.MainDoc" >}}
99+
[What is a Workspace?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc" >}}
603 Bytes
Loading
683 Bytes
Loading
780 Bytes
Loading
391 KB
Loading
44.3 KB
Loading
470 Bytes
Loading
574 Bytes
Loading

0 commit comments

Comments
 (0)