Skip to content

Commit a37c263

Browse files
authored
Add documentation for RuntimeTranslationException and InvalidDefaultValuesException
1 parent d67e08b commit a37c263

File tree

3 files changed

+90
-0
lines changed

3 files changed

+90
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "InvalidDefaultValuesException"
3+
linkTitle: "InvalidDefaultValuesException"
4+
description: "The exception thrown if an exception occurs when initialising the default value for a variable."
5+
---
6+
7+
# {{% param title %}}
8+
9+
<p class="namespace">(Cortex.Exceptions.Flows.Execution.InvalidDefaultValuesException)</p>
10+
{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}
11+
12+
## Description
13+
14+
The exception thrown if an exception occurs when initialising the default value for a variable.
15+
16+
## Reasons
17+
18+
### Invalid Default Variable Value
19+
20+
The default value provided for a variable is invalid.
21+
22+
#### Message Format
23+
24+
```json
25+
"Failed to initialise variables due to invalid default values. Please see the 'Variables' property for details on why each variable threw."
26+
```
27+
28+
#### How to fix
29+
30+
Ensure that the variables shown in the `Variables` property have valid default values, by fixing the inner exception for each variable shown.
31+
32+
## Remarks
33+
34+
### Known Limitations
35+
36+
None
37+
38+
## See Also
39+
40+
### External Documentation
41+
42+
None
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "RuntimeTranslationException"
3+
linkTitle: "RuntimeTranslationException"
4+
description: "The exception thrown when a block is found to have errors within its properties while executing a flow."
5+
---
6+
7+
# {{% param title %}}
8+
9+
<p class="namespace">(Cortex.Exceptions.Flows.Execution.RuntimeTranslationException)</p>
10+
{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}
11+
12+
## Description
13+
14+
The exception thrown when a block is found to have errors within its properties while executing a flow.
15+
## Reasons
16+
17+
### Block has errors during flow execution
18+
19+
A block was found to have errors within its properties during a flow execution. These errors would normally appear as a [Message][WhatIsAMessage], but were not caught when the flow execution was started. This can occur when debugging a flow and [setting the next block to execute][SetNextBlockToExecute] to a block that has errors within its properties, and has no path from the [Start Flow][Start Flow block] block.
20+
21+
#### Message Format
22+
23+
```json
24+
"The block could not be executed because there are errors within its properties. Note that this was not caught when the flow was started either because there is no path from the start of the flow to this block, or the property values in the block."
25+
```
26+
27+
#### How to fix
28+
29+
Ensure that the errors in the properties within the block which caused this exception to be thrown, as seen within the `FailedTranslationSummary` property of this exception, are fixed (e.g. ensure that all variables referenced in the block properties are declared and initialised as expected).
30+
31+
## Remarks
32+
33+
### Known Limitations
34+
35+
None
36+
37+
## See Also
38+
39+
### External Documentation
40+
41+
None
42+
43+
[WhatIsAMessage]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc">}}
44+
[SetNextBlockToExecute]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment.SetNextBlockToExecute">}}
45+
[Start Flow block]: {{<url path = "Cortex.Reference.Blocks.Flows.StartFlow.StartFlow.MainDoc">}}

data/urls.toml

+3
Original file line numberDiff line numberDiff line change
@@ -1220,6 +1220,9 @@
12201220
[Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment]
12211221
MainDoc = "/docs/reference/concepts/fundamentals/executions/executions-in-development"
12221222
ValidatingAFlow = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#validating-a-flow"
1223+
EditAndContinueAnExecution = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#edit-and-continue-an-execution"
1224+
InteractingWithAnExecution = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#interacting-with-an-execution"
1225+
SetNextBlockToExecute = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#set-next-block-to-execute"
12231226
[Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInProduction]
12241227
MainDoc = "/docs/reference/concepts/fundamentals/executions/executions-in-production"
12251228
ValidatingAFlow = "/docs/reference/concepts/fundamentals/executions/executions-in-production/#validating-a-flow"

0 commit comments

Comments
 (0)