Skip to content

Commit 7e718a9

Browse files
author
Donna-Marie Smith
committed
Initial content of Exceptions Viewer added
1 parent eeba691 commit 7e718a9

13 files changed

Lines changed: 69 additions & 13 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Bottom Panel"
33
linkTitle: "Bottom Panel"
4-
description: "TODO"
4+
description: "Manage Variables and view debug execution information."
55
weight: 50
66
---

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Left Panel"
33
linkTitle: "Left Panel"
4-
description: "TODO"
4+
description: "Develop flows using the Palettes."
55
weight: 20
66
---
77

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: "Main Panel"
33
linkTitle: "Main Panel"
4-
description: "TODO"
4+
description: "Develop, test and debug flows in the Flow Editor."
55
weight: 30
66
---
77

88
# {{% param title %}}
99

1010
## Summary
1111

12-
The Main Panel is used when developing, testing, and debugging flows.
12+
The Main Panel is used when developing, testing, and debugging flows.
1313

1414
## Anatomy
1515

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Navigation Bar"
33
linkTitle: "Navigation Bar"
4-
description: "TODO"
4+
description: "Navigate between open flows in the Flow Editor."
55
weight: 10
66
---
77

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Right Panel"
33
linkTitle: "Right Panel"
4-
description: "TODO"
4+
description: "Set the values of input variables and view execution information when debugging flows."
55
weight: 40
66
---
Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,61 @@
11
---
22
title: "Exceptions Viewer"
33
linkTitle: "Exceptions Viewer"
4-
description: "TODO"
4+
description: "View details of any exceptions during flow debugging."
55
weight: 50
66
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Exceptions Viewer shows details of any [exceptions][What is an Exception?] when debugging the [flow][What is a Flow?].
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Flow Editor - Exceptions Viewer.png" title="Exceptions Viewer" >}}
17+
18+
In addition to the 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.
19+
20+
The exact format of the Exception Object depends on the exception raised. All Exception Objects have:
21+
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.
26+
27+
## Actions
28+
29+
### View Exception
30+
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.
32+
33+
See the [Exceptions Viewer][Exceptions Viewer tutorial] tutorial for a step-by-step guide.
34+
35+
## Remarks
36+
37+
### Known Limitations
38+
39+
* The text displayed in the Exceptions Viewer cannot be copied to the clipboard to then insert into a text editor.
40+
41+
## See Also
42+
43+
### Related Concepts
44+
45+
* [Exceptions][]
46+
* [Flows][]
47+
48+
### Related Tutorials
49+
50+
* [Exceptions Viewer][Exceptions Viewer tutorial]
51+
52+
[Variables Viewer]: {{< ref "#variables-viewer" >}}
53+
[Variables Details Viewer]: {{< ref "#variables-details-viewer" >}}
54+
55+
[Right Panel]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.RightPanel.MainDoc" >}}
56+
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
57+
[Flows]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.MainDoc" >}}
58+
[Exceptions Viewer tutorial]: {{< url path="Cortex.Tutorials.Development.FlowEditor.RightPanel.ExceptionsViewer" >}}
59+
[Variable Scopes]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.VariableScopes.MainDoc" >}}
60+
[What is a Flow?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc" >}}
61+
[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/execution-viewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Execution Viewer"
33
linkTitle: "Execution Viewer"
4-
description: "TODO"
4+
description: "View the values of variables when debugging a flow."
55
weight: 30
66
---
77

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: "Overview"
33
linkTitle: "Overview"
4-
description: "TODO"
4+
description: "Summary and Anatomy of the Right Panel."
55
weight: 10
66
---
77

88
# {{% param title %}}
99

1010
## Summary
11-
TODO
12-
The Right Panel consists tabs to allow ...
11+
12+
The Right Panel consists of multiple tabs to allow the setting of values of [input variables][Flow Input Variable], viewing [block properties][What is a Block Property?] and the values of [variables][What is a Variable?] used when debugging.
1313

1414
## Anatomy
1515

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Property Editor"
33
linkTitle: "Property Editor"
4-
description: "TODO"
4+
description: "View the properties of a block selected in the Main Panel."
55
weight: 20
66
---
77

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Settings Editor"
33
linkTitle: "Settings Editor"
4-
description: "TODO"
4+
description: "View the values of input variables."
55
weight: 40
66
---
77

0 commit comments

Comments
 (0)