Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge 2023.9 Documentation #64

Merged
merged 13 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 7 additions & 2 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -200,15 +200,20 @@ enable = true
[[menu.main]]
identifier = 'documentation'
name = 'Documentation'
url = '/docs/2023.7'
url = '/docs/2023.9'
weight = 10

# Releases menu
[[params.versions]]
version = "2023.9"
url = "/docs/2023.9/"
dotNetVersion = "net-6.0"
latest = true

[[params.versions]]
version = "2023.7"
url = "/docs/2023.7/"
dotNetVersion = "net-6.0"
latest = true

[[params.versions]]
version = "2023.5"
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/releases/2023.X/2023.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,8 @@ Any changes to these forecasts will be announced via the [News channel][].

[Blocks]: {{< url path="Cortex.Reference.Blocks.MainDoc" version="2023.7" >}}
[Data Storage]: {{< url path="Cortex.Reference.Blocks.DataStorage.MainDoc" version="2023.7" >}}
[Create Collection]: {{< url path="Cortex.Reference.Blocks.DataStorage.CreateCollection.CreateCollectionBLock.MainDoc" version="2023.7" >}}
[Delete Collection]: {{< url path="Cortex.Reference.Blocks.DataStorage.DeleteCollection.DeleteCollectionBLock.MainDoc" version="2023.7" >}}
[Create Collection]: {{< url path="Cortex.Reference.Blocks.DataStorage.CreateCollection.CreateCollectionBlock.MainDoc" version="2023.7" >}}
[Delete Collection]: {{< url path="Cortex.Reference.Blocks.DataStorage.DeleteCollection.DeleteCollectionBlock.MainDoc" version="2023.7" >}}
[Delete Data with Key]: {{< url path="Cortex.Reference.Blocks.DataStorage.DeleteData.DeleteDataWithKeyBlock.MainDoc" version="2023.7" >}}
[Read Data with Key]: {{< url path="Cortex.Reference.Blocks.DataStorage.ReadData.ReadDataWithKeyBlock.MainDoc" version="2023.7" >}}
[Write Data with Key]: {{< url path="Cortex.Reference.Blocks.DataStorage.WriteData.WriteDataWithKeyBlock.MainDoc" version="2023.7" >}}
Expand Down
331 changes: 331 additions & 0 deletions content/en/blog/releases/2023.X/2023.9.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ The exceptions thrown by the block can be found below:
| | Thrown when the [Host][ServerDetails Host] within the [ServerDetails][] within the [PowerShell Session Details][PowerShell Session Details Property] is empty. |
| | Thrown when the [Username][UserCredentials Username] in the [Credentials][] within the [PowerShell Session Details][PowerShell Session Details Property] is empty. |
| | Thrown when the [Password][UserCredentials Password] in the [Credentials][] within the [PowerShell Session Details][PowerShell Session Details Property] is empty. |
| [PropertyEmptyException][] | Thrown when the [Port][ServerDetails Port] within the [ServerDetails][] within the [PowerShell Session Details][PowerShell Session Details Property] is below `1` or above `65535`. |
| [PropertyValueOutOfRangeException][] | Thrown when the [Port][ServerDetails Port] within the [ServerDetails][] within the [PowerShell Session Details][PowerShell Session Details Property] is below `1` or above `65535`. |

## Remarks

Expand Down Expand Up @@ -381,6 +381,7 @@ None
[PSRemotingException]: {{< url path="Cortex.Reference.Exceptions.PowerShell.PSRemotingException.MainDoc" >}}
[PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}}
[PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}}
[PropertyValueOutOfRangeException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyValueOutOfRangeException.MainDoc" >}}

[Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.VariableEditor.MainDoc" >}}
[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,49 @@ Note that as the [Headers][Headers Response] contains a key of `Content-Type` wi

### Calling another Flow

TODO
Note: This example does not follow the base [Uri][] or [API][] as specified [above][Examples Base]; but instead uses the [Uri][] of the [Cortex API Gateway][]. The [Uri][] to send this HTTP request to has the following form: `https://<server>:8722/api/<tenant>/<system>/flows/<flowName>/executions/`.

<br>

This example will send a [POST][] request to the [Uri][] of a [Flow][] within a [published package][Publish Package] using [HTTP 1.1][HTTP11] and run the [Flow][], using Basic authentication which requires [Http Credentials][Http Credentials Property] to be a [UserCredentials][]. This example is similar in functionality to the [Run Flow][] block.

<br>

The flow being run is `ExampleFlow`. This flow sets the value of an [Output][] variable `ExampleOutput` to `"I love We Are CORTEX"`. This flow is in a published, non-default package `ExamplePackage`.

<br>

This example will send this request to `https://server.domain.com:8722/api/default/default/flows/ExampleFlow/executions?packageName=ExamplePackage`, where `server.domain.com` is the FQDN of the server hosting an Innovation install.

#### Properties

| Property | Value | Notes |
|--------------------|---------------------------|------------------------------------------|
| [Http Request][Http Request Property] | `($)HttpRequest`, with value `{"QueryStringParameters": {"packageName": "ExamplePackage"}, "Verb": "RequestVerb.POST", "ContentType": "application/json", "Body": {}, "Uri": "https://server.domain.com:8722/api/default/default/flows/ExampleFlow/executions", "Headers": null, "HttpVersion": "HttpRequestVersion.HTTP11"}`<br><br>In this example `($)HttpRequest` has been set up using the following [Expression][]:<br><br>`new HttpRequest(uri: "https://server.domain.com:8722/api/default/default/flows/ExampleFlow/executions", queryParameters: new Dictionary<string,string>({"packageName","ExamplePackage"}), verb: RequestVerb.POST, contentType: "application/json", headers: null, body: "{}", httpVersion: HttpRequestVersion.HTTP11)` | `($)HttpRequest` is a variable of type [HttpRequest][]<br><br> In this example, the `queryParameters` [Advanced][] property is an [IDictionary<string, string>][IDictionary] with two valid keys, `"packageName"` and `"packageVersion"`. `"packageName"` must be specified as the package of the published flow if it is not the default package.`"packageVersion"` may be included to refer to a specific version of a published package if it is not the default version. |
| [Http Credentials][Http Credentials Property] | `($)HttpCredentials`, with value `{"Username": "username", "Password":"encryptedPassword"}`<br><br>In this example, `($)HttpCredentials` has been set up using the following [Expression][]:<br><br>`new UserCredentials(username: "username", password: "encryptedPassword")` | `($)HttpCredentials` is a variable of type [UserCredentials][]<br><br>The [Password][] property in the [UserCredentials][] must be encrypted, for more information on how to encrypt the [password][Password], see [EncryptedText][]. |
| [Http Response][Http Response Property] | `($)HttpResponse`, with no value | `($)HttpResponse` will be set to the type [HttpResponse][] |

#### Results

Executing a [POST][] [HttpRequest][] to `https://server.domain.com:8722/api/default/default/flows/ExampleFlow/executions?packageName=ExamplePackage` results in the variable `($)HttpResponse` being updated to the following:
```json
{
"ResponseBody": {
"ExampleOutput": "I love We Are CORTEX"
},
"ErrorMessage": null,
"Headers": {
"Date": "2023-10-04T14:17:40+00:00",
"Server": "Kestrel",
"Cache-Control": "no-store, must-revalidate, no-cache",
"X-Content-Type-Options": "nosniff",
"api-supported-versions": "1.0",
"Content-Length": 36,
"Content-Type": "application/json; charset=utf-8"
},
"StatusCode": "HttpStatusCode.OK (200)"
}
```

***

Expand Down Expand Up @@ -398,10 +440,12 @@ The exceptions thrown by the block can be found below:

None

[Examples Base]: {{< ref "#examples" >}}
[Http Request Property]: {{< ref "#http-request" >}}
[Http Credentials Property]: {{< ref "#http-credentials" >}}
[Http Response Property]: {{< ref "#http-response" >}}

[IDictionary]: {{< url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc" >}}
[UserCredentials]: {{< url path="Cortex.Reference.DataTypes.Credentials.UserCredentials.MainDoc" >}}
[Username]: {{< url path="Cortex.Reference.DataTypes.Credentials.UserCredentials.Username" >}}
[Password]: {{< url path="Cortex.Reference.DataTypes.Credentials.UserCredentials.Password" >}}
Expand Down Expand Up @@ -467,3 +511,8 @@ None
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}

[API]: {{< url path="Cortex.Reference.Glossary.A-E.API" >}}
[Flow]:{{< url path="Cortex.Reference.Glossary.F-J.Flow">}}

[Cortex API Gateway]: {{< url path="Cortex.Guides.ApiGatewayService.MainDoc" >}}
[Publish Package]: {{< url path="Cortex.Guides.Gateway.Settings.Packages.MainDoc" >}}
[Run Flow]: {{< url path="Cortex.Reference.Blocks.Flows.RunFlow.RunFlow.MainDoc">}}
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,8 @@ None
* [Set Item At Index][]
* [Set Items At Index][]
* [Set Items At Indexes][]
* PowerShell
* [Execute PowerShell Script][]
* Schedules
* [Wait For Duration][]
* Text
Expand Down Expand Up @@ -324,6 +326,8 @@ None
[Set Items At Index]: {{< url path="Cortex.Reference.Blocks.Lists.SetItem.SetItemsAtIndex.MainDoc" >}}
[Set Items At Indexes]: {{< url path="Cortex.Reference.Blocks.Lists.SetItem.SetItemsAtIndexes.MainDoc" >}}

[Execute PowerShell Script]: {{< url path="Cortex.Reference.Blocks.PowerShell.ExecutePowerShellScript.ExecutePowerShellScript.MainDoc" >}}

[Wait For Duration]: {{< url path="Cortex.Reference.Blocks.Schedules.WaitFor.WaitForDuration.MainDoc" >}}

[Add Text After Index]: {{< url path="Cortex.Reference.Blocks.Text.AddText.AddTextAfterIndex.MainDoc" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ Self-signed certificates should be generated using OpenSSL which is bundled in t
stateOrProvinceName_default = Hampshire
localityName_default = Southampton
0.organizationName_default = Cortex Ltd
organizationalUnitName_default = Cortex
emailAddress_default = [email protected]
organizationalUnitName_default = We Are CORTEX
emailAddress_default = [email protected]
[ v3_ca ]
# Extensions for a typical CA (`man x509v3_config`).
subjectKeyIdentifier = hash
Expand Down Expand Up @@ -179,8 +179,8 @@ Self-signed certificates should be generated using OpenSSL which is bundled in t
stateOrProvinceName_default = Hampshire
localityName_default = Southampton
0.organizationName_default = Cortex Ltd
organizationalUnitName_default = Cortex
emailAddress_default = [email protected]
organizationalUnitName_default = We Are CORTEX
emailAddress_default = [email protected]
[ v3_req ]
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
Expand All @@ -198,8 +198,8 @@ Self-signed certificates should be generated using OpenSSL which is bundled in t
Each DNS name or IP address entry must be suffixed with `.N` where `N` is the unique index of the DNS name or IP address entry; see below for examples:
| Resource URL | Configuration to add |
|---------------------------------------|-----------------------------------|
| `https://cortex.co.uk/gateway` | `DNS.1 = cortex.co.uk` |
| `https://internal.cortex.co.uk/gateway` | `DNS.2 = internal.cortex.co.uk` |
| `https://wearecortex.com/gateway` | `DNS.1 = wearecortex.com` |
| `https://internal.wearecortex.com/gateway` | `DNS.2 = internal.wearecortex.com` |
| `https://10.0.0.0/gateway` | `IP.1 = 10.0.0.0` |
| `https://192.168.1.100/gateway` | `IP.2 = 192.168.1.100` |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ Self-signed certificates should be generated using OpenSSL which is bundled in t
stateOrProvinceName_default = Hampshire
localityName_default = Southampton
0.organizationName_default = Cortex Ltd
organizationalUnitName_default = Cortex
emailAddress_default = [email protected]
organizationalUnitName_default = We Are CORTEX
emailAddress_default = [email protected]
[ v3_ca ]
# Extensions for a typical CA (`man x509v3_config`).
subjectKeyIdentifier = hash
Expand Down Expand Up @@ -176,8 +176,8 @@ Self-signed certificates should be generated using OpenSSL which is bundled in t
stateOrProvinceName_default = Hampshire
localityName_default = Southampton
0.organizationName_default = Cortex Ltd
organizationalUnitName_default = Cortex
emailAddress_default = [email protected]
organizationalUnitName_default = We Are CORTEX
emailAddress_default = [email protected]
[ v3_req ]
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
Expand All @@ -195,8 +195,8 @@ Self-signed certificates should be generated using OpenSSL which is bundled in t
Each DNS name or IP address entry must be suffixed with `.N` where `N` is the unique index of the DNS name or IP address entry; see below for examples:
| Resource URL | Configuration to add |
|---------------------------------------|-----------------------------------|
| `https://cortex.co.uk/gateway` | `DNS.1 = cortex.co.uk` |
| `https://internal.cortex.co.uk/gateway` | `DNS.2 = internal.cortex.co.uk` |
| `https://wearecortex.com/gateway` | `DNS.1 = wearecortex.com` |
| `https://internal.wearecortex.com/gateway` | `DNS.2 = internal.wearecortex.com` |
| `https://10.0.0.0/gateway` | `IP.1 = 10.0.0.0` |
| `https://192.168.1.100/gateway` | `IP.2 = 192.168.1.100` |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ The exceptions thrown by the block can be found below:
| | Thrown when the [Host][ServerDetails Host] within the [ServerDetails][] within the [PowerShell Session Details][PowerShell Session Details Property] is empty. |
| | Thrown when the [Username][UserCredentials Username] in the [Credentials][] within the [PowerShell Session Details][PowerShell Session Details Property] is empty. |
| | Thrown when the [Password][UserCredentials Password] in the [Credentials][] within the [PowerShell Session Details][PowerShell Session Details Property] is empty. |
| [PropertyEmptyException][] | Thrown when the [Port][ServerDetails Port] within the [ServerDetails][] within the [PowerShell Session Details][PowerShell Session Details Property] is below `1` or above `65535`. |
| [PropertyValueOutOfRangeException][] | Thrown when the [Port][ServerDetails Port] within the [ServerDetails][] within the [PowerShell Session Details][PowerShell Session Details Property] is below `1` or above `65535`. |

## Remarks

Expand Down Expand Up @@ -381,6 +381,7 @@ None
[PSRemotingException]: {{< url path="Cortex.Reference.Exceptions.PowerShell.PSRemotingException.MainDoc" >}}
[PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}}
[PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}}
[PropertyValueOutOfRangeException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyValueOutOfRangeException.MainDoc" >}}

[Variable]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.VariableEditor.MainDoc" >}}
[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
Expand Down
Loading
Loading