Skip to content

Commit

Permalink
Add documentation for RuntimeTranslationException and InvalidDefaultV…
Browse files Browse the repository at this point in the history
…aluesException
  • Loading branch information
cortex-av authored Apr 24, 2024
1 parent d67e08b commit a37c263
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "InvalidDefaultValuesException"
linkTitle: "InvalidDefaultValuesException"
description: "The exception thrown if an exception occurs when initialising the default value for a variable."
---

# {{% param title %}}

<p class="namespace">(Cortex.Exceptions.Flows.Execution.InvalidDefaultValuesException)</p>
{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}

## Description

The exception thrown if an exception occurs when initialising the default value for a variable.

## Reasons

### Invalid Default Variable Value

The default value provided for a variable is invalid.

#### Message Format

```json
"Failed to initialise variables due to invalid default values. Please see the 'Variables' property for details on why each variable threw."
```

#### How to fix

Ensure that the variables shown in the `Variables` property have valid default values, by fixing the inner exception for each variable shown.

## Remarks

### Known Limitations

None

## See Also

### External Documentation

None
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "RuntimeTranslationException"
linkTitle: "RuntimeTranslationException"
description: "The exception thrown when a block is found to have errors within its properties while executing a flow."
---

# {{% param title %}}

<p class="namespace">(Cortex.Exceptions.Flows.Execution.RuntimeTranslationException)</p>
{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}

## Description

The exception thrown when a block is found to have errors within its properties while executing a flow.
## Reasons

### Block has errors during flow execution

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.

#### Message Format

```json
"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."
```

#### How to fix

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).

## Remarks

### Known Limitations

None

## See Also

### External Documentation

None

[WhatIsAMessage]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc">}}
[SetNextBlockToExecute]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment.SetNextBlockToExecute">}}
[Start Flow block]: {{<url path = "Cortex.Reference.Blocks.Flows.StartFlow.StartFlow.MainDoc">}}
3 changes: 3 additions & 0 deletions data/urls.toml
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,9 @@
[Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment]
MainDoc = "/docs/reference/concepts/fundamentals/executions/executions-in-development"
ValidatingAFlow = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#validating-a-flow"
EditAndContinueAnExecution = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#edit-and-continue-an-execution"
InteractingWithAnExecution = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#interacting-with-an-execution"
SetNextBlockToExecute = "/docs/reference/concepts/fundamentals/executions/executions-in-development/#set-next-block-to-execute"
[Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInProduction]
MainDoc = "/docs/reference/concepts/fundamentals/executions/executions-in-production"
ValidatingAFlow = "/docs/reference/concepts/fundamentals/executions/executions-in-production/#validating-a-flow"
Expand Down

0 comments on commit a37c263

Please sign in to comment.