Skip to content

Commit

Permalink
Merge branch 'feature/16199-add-documentation' of https://github.com/…
Browse files Browse the repository at this point in the history
…CortexIntelligentAutomation/docs into feature/16199-add-documentation
  • Loading branch information
cortex-sg committed Feb 26, 2024
2 parents c6beb2b + cb64f52 commit 54fc608
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,34 @@ description: "The exception thrown when trying to modify a read-only list."
# {{% param title %}}

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

## Description

The exception thrown when trying to modify a read-only list.

## Reasons

### Attempting to modify a read-only list

> Lists deriving from [IList][]&lt;[T][]&gt; have the option to be read-only.
There was an attempt to modify a read-only list.

##### Message Format

The format of the exception message is as follows:

```json
"The value of '<property-display-name>' cannot be modified.
This is because the value of '<property-display-name>' is read-only.
"The value of '<property-name>' cannot be modified.
This is because the value of '<property-name>' is read-only.
See the CannotModifyReadOnlyListException help page for more information on how to fix this."
```

where:

* `<property-name>` is the name for the property that contains the read-only list.

## How to fix

If the list was written directly into the block property using an [expression][], use a list type that is not read-only, such as [List][]&lt;[T][]&gt;.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CommandException"
linkTitle: "CommandException"
description: "Exception thrown when any command execution has resulted in an exception being thrown."
description: "The exception thrown when any command execution has resulted in an exception being thrown."
---

# {{% param title %}}
Expand All @@ -10,7 +10,7 @@ description: "Exception thrown when any command execution has resulted in an exc

## Description

Exception thrown when any command execution has resulted in an exception being thrown.
The exception thrown when any command execution has resulted in an exception being thrown.

## Reasons

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: "The exception thrown when an invalid connection string is used."

## Description

Exception thrown when an invalid connection string is used.
The exception thrown when an invalid connection string is used.

## Reasons

Expand All @@ -34,7 +34,7 @@ where:

#### How to fix

Ensure that a valid connection string is provided.
Ensure that a valid connection string is provided for the data source being connected to; see [connectionstrings.com][ConnectionStrings] for valid examples.

## Remarks

Expand All @@ -46,7 +46,7 @@ None

### External Documentation

* [Connection Strings][ConnectionStrings]
* [connectionstrings.com][ConnectionStrings]

[Start Flow]: {{< url path="Cortex.Reference.Blocks.Flows.StartFlow.StartFlow.MainDoc" >}}
[End Flow]: {{< url path="Cortex.Reference.Blocks.Flows.EndFlow.EndFlow.MainDoc" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The exception thrown when a property that requires a [nullable][Nullable] value

### Invalid data type for property provided

The data type provided for the property is one that does not allow null values, e.g. [Int32][], [Boolean][], [Char][] etc.
The data type provided for the property is one that does not allow null values, e.g. [Int32][], [Boolean][], [Char][], etc.

#### Message Format

Expand Down Expand Up @@ -62,9 +62,9 @@ None
[Char]: {{<url path="Cortex.Reference.DataTypes.Text.Char.MainDoc">}}
[Guid]: {{<url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc">}}
[Int32]: {{<url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc">}}
[Nullable]: {{<url path="Cortex.Reference.DataTypes.Other.Nullable.MainDoc">}}
[String]: {{<url path="Cortex.Reference.DataTypes.Text.String.MainDoc">}}

[Nullable]: {{<url path="Cortex.Reference.Concepts.Fundamentals.DataTypes.NullAndNullableTypes.MainDoc">}}
[WhatIsABlock]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc">}}
[WhatIsAnExecution]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc">}}
[WhatIsAFlow]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc">}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ The execution is attempting to perform a non-read operation on a read-only [IDic
The format of the exception message is as follows:

```json
"'<property-display-name>' cannot be because it's read-only.
"'<dictionary>' cannot be modified because it's read-only.
Please click the HelpLink for more information on how to fix this."
```

where:

* `<property-display-name>` is the display name of the affected read-only dictionary.
* `<dictionary>` is the name of the property containing the read-only dictionary.

#### How to fix

Expand All @@ -54,8 +54,8 @@ None

### External Documentation

* [Dictionary][MS Dictionary]
* [IDictionary][MS IDictionary]
* [System.Collections.Generic.Dictionary<TKey,TItem>][MS Dictionary]
* [System.Collections.Generic.IDictionary<TKey,TItem>][MS IDictionary]

[Dictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc">}}
[IDictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc">}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Please click the HelpLink for more information on how to fix this."
where:

* `<key>` is the key that is not present.
* `<dictionary>` is the empty [dictionary][IDictionary] that is being accessed.
* `<dictionary>` is the name of the property containing the empty [dictionary][IDictionary] that is being accessed.

#### How to fix

Expand All @@ -53,11 +53,11 @@ Please click the HelpLink for more information on how to fix this."
where:

* `<key>` is the key that is not present.
* `<dictionary>` is the [dictionary][IDictionary] that is being accessed.
* `<dictionary>` is the name of the property containing the [dictionary][IDictionary] that is being accessed.

#### How to fix

Ensure that the key is correct and is present in the [dictionary][IDictionary].
Ensure that the key is correct and is present in the [dictionary][IDictionary], for example by using the [Contains Item With Key][Contains Item With Key Block] block.

## Remarks

Expand All @@ -69,8 +69,10 @@ None

### External Documentation

* [Dictionary][MS Dictionary]
* [IDictionary][MS IDictionary]
* [System.Collection.Generics.Dictionary<TKey,TItem>][MS Dictionary]
* [System.Collection.Generics.IDictionary<TKey,TItem>][MS IDictionary]

[Contains Item With Key Block]: {{<url path="Cortex.Reference.Blocks.Dictionaries.ContainsItem.ContainsItemWithKey.MainDoc">}}

[Dictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc">}}
[IDictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc">}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ Please click the HelpLink for more information on how to fix this."
where:

* `<key>` is the key being used to add an item.
* `<dictionary>` is the [dictionary][IDictionary] to which the item is trying to be added.
* `<dictionary>` is the name of the property containing the [dictionary][IDictionary] to which the item is trying to be added.

#### How to fix

Ensure that the key is not a duplicate of an already existing key in the [dictionary][IDictionary].
Ensure that the key is not a duplicate of an already existing key in the [dictionary][IDictionary], for example by using the [Contains Item With Key][Contains Item With Key Block] block.

## Remarks

Expand All @@ -47,8 +47,10 @@ None

### External Documentation

* [Dictionary][MS Dictionary]
* [IDictionary][MS IDictionary]
* [System.Collections.Generic.Dictionary<TKey,TItem>][MS Dictionary]
* [System.Collections.Generic.IDictionary<TKey,TItem>][MS IDictionary]

[Contains Item With Key Block]: {{<url path="Cortex.Reference.Blocks.Dictionaries.ContainsItem.ContainsItemWithKey.MainDoc">}}

[Dictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc">}}
[IDictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc">}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Please click the HelpLink for more information on how to fix this."

where:

* `<dictionary>` is the dictionary being accessed.
* `<dictionary>` is the name of the property containing [dictionary][IDictionary] being accessed.
* `<keys>` is the list of keys that were not present in the [dictionary][IDictionary]. In this case it should be all keys provided.

#### How to fix
Expand All @@ -54,12 +54,12 @@ Please click the HelpLink for more information on how to fix this."

where:

* `<dictionary>` is the [dictionary][IDictionary] being accessed.
* `<dictionary>` is the name of the property containing [dictionary][IDictionary] being accessed.
* `<keys>` is the list of keys that were not present in the [dictionary][IDictionary].

#### How to fix

Ensure that the keys provided are valid and correct, and ensure that the [dictionary][IDictionary] contains these keys.
Ensure that the [dictionary][IDictionary] contains the key, for example by using the [Contains Item With Key][Contains Item With Key Block] block.

## Remarks

Expand All @@ -71,8 +71,10 @@ None

### External Documentation

* [Dictionary][MS Dictionary]
* [IDictionary][MS IDictionary]
* [System.Collections.Generic.Dictionary<TKey,TItem>][MS Dictionary]
* [System.Collections.Generic.IDictionary<TKey,TItem>][MS IDictionary]

[Contains Item With Key Block]: {{<url path="Cortex.Reference.Blocks.Dictionaries.ContainsItem.ContainsItemWithKey.MainDoc">}}

[Dictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc">}}
[IDictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc">}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,11 +166,7 @@ None
[Workspaces]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.MainDoc">}}

[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
[TimePeriod]: {{< url path="Cortex.Reference.DataTypes.DateAndTime.TimePeriod.MainDoc" >}}

[Guid]: {{<url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc">}}
[TimePeriod]: {{< url path="Cortex.Reference.DataTypes.DateAndTime.TimePeriod.MainDoc" >}}

[WhatIsABlock]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Blocks.WhatIsABlock.MainDoc">}}
[WhatIsAnExecution]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Executions.WhatIsAnExecution.MainDoc">}}
[WhatIsAFlow]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Flows.WhatIsAFlow.MainDoc">}}
[WhatIsAWorkspace]: {{<url path="Cortex.Reference.Concepts.Fundamentals.Workspaces.WhatIsAWorkspace.MainDoc">}}
[Guid]: {{<url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc">}}

0 comments on commit 54fc608

Please sign in to comment.