Skip to content
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
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ IgnoreDirs:
- "docs/2024.3/?.*/"
- "docs/2024.5/?.*/"
- "docs/2024.7/?.*/"
- "docs/2024.9/?.*/"
- "docs/2024.11/?.*/"
- "docs/2025.1/?.*/"
- "docs/2025.5/?.*/"
10 changes: 8 additions & 2 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -203,16 +203,22 @@ enable = true
[[menu.main]]
identifier = 'documentation'
name = 'Documentation'
url = '/docs/2026.3'
url = '/docs/2026.9'
weight = 10

# Releases menu
[[params.versions]]
version = "2026.9"
url = "/docs/2026.9/"
dotNetVersion = "net-8.0"
inSupport = true
latest = true

[[params.versions]]
version = "2026.3"
url = "/docs/2026.3/"
dotNetVersion = "net-8.0"
inSupport = true
latest = true

[[params.versions]]
version = "2025.9"
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/2026.9/FAQs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "FAQs"
linkTitle: "FAQs"
description: "Answers to our most frequently asked questions."
weight: 10000
---
20 changes: 20 additions & 0 deletions content/en/docs/2026.9/FAQs/change-logging-levels/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "How do I change the Logging Level?"
linkTitle: "How do I change the Logging Level?"
description: "Instructions on how to change the {{% ctx %}} Logging Level."
weight: 1000
---

{{% ctx %}} Logging Levels are set to `Error` by default for most services. However, levels can be changed whilst {{% ctx %}} is running by sending REST calls to the {{% ctx %}} API Gateway service.

{{% alert title="Note" %}}
Although the Logging Level for the {{% ctx %}} API Gateway service can be increased, it will still always log all API calls regardless of Logging Level configured.
{{% / alert %}}

If increasing the Logging Level, particularly if increasing for everything or for Block Logging, we recommend that this is done only when required. Increasing log levels will lead to an increase in disk usage and disk writes, which can impact the performance of the {{% ctx %}} platform if not monitored.

Whilst increased Logging Levels are in place, we would recommend closely monitoring system performance and disk space usage.

All REST calls to update Logging Levels use Basic Auth and can be made using REST clients such as [Postman][] or using scripts such as PowerShell.

[Postman]: {{< url path="Postman.Downloads.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: "Change All Logging Levels"
linkTitle: "Change All Logging Levels"
description: "Instructions on how to change the Logging Level for All Logging."
weight: 10
---

# {{% param title %}}

To change the Logging Level for all services, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.

1. Run Windows PowerShell ISE as Administrator.
1. Copy the following script into the PowerShell window:

``` powershell
$serverFQDN = "server.domain.com"
$APIGatewayPort = 8722
$loglevel = 4
$user = "BasicAuthUser"

$securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString

$ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass)
try {
$plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr)

$authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass")
$base64AuthInfo = [Convert]::ToBase64String($authBytes)
}
finally {
[Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr)

$plainPass = $null
Remove-Variable -Name plainPass -Force
}

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Basic $base64AuthInfo")
$path = "applications/logging"
$body = @"
$loglevel
"@

$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body
$response
```

1. Configure the following variables:
* `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722)
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
* `$user` – {{% ctx %}} API Gateway Basic Auth Username

1. Execute the script, entering the Basic Auth User's password when prompted.
1. Confirm success response:

If the call was successful, there should be no errors and the following response should be received

``` powershell
LogLevel was successfully configured.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "Change Block Logging Level"
linkTitle: "Change Block Logging Level"
description: "Instructions on how to change the Logging Level for Block Logging."
weight: 5
---

# {{% param title %}}

Block Logging in {{% ctx %}} logs the following Block Properties by default regardless of the log level configured:

* Execute Data Command
* Command > commandText
* Command > parameters
* Execute Http Request
* Http Request
* Http Response
* Execute Soap Request
* Soap Request
* Soap Response
* Execute PowerShell Script
* Script
* Parameters
* Outputs
* Records
* Execute Ssh Command
* Command
* Response
* Ssh Logs

To change the Logging Level for Block Logging so that every block is logged when executed, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.

1. Run Windows PowerShell ISE as Administrator.
1. Copy the following script into the PowerShell window:

``` powershell
$serverFQDN = "server.domain.com"
$APIGatewayPort = 8722
$loglevel = 4
$user = "BasicAuthUser"

$securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString

$ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass)
try {
$plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr)

$authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass")
$base64AuthInfo = [Convert]::ToBase64String($authBytes)
}
finally {
[Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr)

$plainPass = $null
Remove-Variable -Name plainPass -Force
}

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Basic $base64AuthInfo")
$path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/workspaces/blocks/logging"
$body = @"
$loglevel
"@

$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body
$response
```

1. Configure the following variables:
* `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722)
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
* `$user` – {{% ctx %}} API Gateway Basic Auth Username

1. Execute the script, entering the Basic Auth User's password when prompted.
1. Confirm success response:

If the call was successful, there should be no errors and the following response should be received

``` powershell
LogLevel was successfully configured.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: "Change Flow Logging Level"
linkTitle: "Change Flow Logging Level"
description: "Instructions on how to change the Logging Level for Flow Logging."
weight: 1
---

# {{% param title %}}

To change the Logging Level for Flow Logging, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.

1. Run Windows PowerShell ISE as Administrator.
1. Copy the following script into the PowerShell window:

``` powershell
$serverFQDN = "server.domain.com"
$APIGatewayPort = 8722
$loglevel = 4
$user = "BasicAuthUser"

$securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString

$ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass)
try {
$plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr)

$authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass")
$base64AuthInfo = [Convert]::ToBase64String($authBytes)
}
finally {
[Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr)

$plainPass = $null
Remove-Variable -Name plainPass -Force
}

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Basic $base64AuthInfo")
$path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/logging"
$body = @"
$loglevel
"@

$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body
$response
```

1. Configure the following variables:
* `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722)
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
* `$user` – {{% ctx %}} API Gateway Basic Auth Username

1. Execute the script, entering the Basic Auth User's password when prompted.
1. Confirm success response:

If the call was successful, there should be no errors and the following response should be received

``` powershell
LogLevel was successfully configured.
```
6 changes: 6 additions & 0 deletions content/en/docs/2026.9/FAQs/check-cluster-health/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "How do I check cluster health?"
linkTitle: "How do I check cluster health?"
description: "Instructions on how to check the health of your cluster."
weight: 100
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Multiple Server with HA"
linkTitle: "Multiple Server with HA"
description: "Instructions on how to check the health of your multiple server cluster."
weight: 1
---

# Check Cluster Health

## Import Client Certificate

In order to access the [Service Fabric Explorer][] to check the health of the cluster, it is necessary for the client certificate specified during the [installation of {{% ctx %}}][Configure Installation Script] to be imported in to the current user store on the machine it is being accessed from.

Instructions on how to do this can be found [here][Import Client Certificate].

## View Cluster Health

1. Open a web browser.
1. {{< section "/install-application-server/multi-server/check-application-services.md">}}

[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}
[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}}
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Single Server without HA"
linkTitle: "Single Server without HA"
description: "Instructions on how to check the health of your single server cluster."
weight: 2
---

# Check Cluster Health

## Import Client Certificate

In order to access the [Service Fabric Explorer][] to check the health of the cluster, it is necessary for the client certificate specified during the [installation of {{% ctx %}}][Configure Installation Script] to be imported in to the current user store on the machine it is being accessed from.

Instructions on how to do this can be found [here][Import Client Certificate].

## View Cluster Health

1. Open a web browser.
1. {{< section "/install-application-server/single-server/check-application-services.md">}}

[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}}
[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.SingleServer" >}}
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}
8 changes: 8 additions & 0 deletions content/en/docs/2026.9/FAQs/configure-code-analyser/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "How do I configure the code analyser?"
linkTitle: "How do I configure the code analyser?"
description: "Instructions on how to configure the code analyser to allow flows to be run."
weight: 200
---

{{< section "/configure-code-analyser/configure-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Multiple Server With HA"
linkTitle: "Multiple Server With HA"
description: "Instructions on how to configure the code analyser on a multiple server cluster."
weight: 10
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "How do I disable the code analyser on a multiple server cluster?"
linkTitle: "How do I disable the code analyser on a multiple server cluster?"
description: "Instructions on how to disable the code analyser on a multiple server cluster."
weight: 20
---

# Disable Code Analyser

{{< section "/configure-code-analyser/multi-server/disable-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "How do I enable the code analyser on a multiple server cluster?"
linkTitle: "How do I enable the code analyser on a multiple server cluster?"
description: "Instructions on how to enable the code analyser on a multiple server cluster."
weight: 10
---

# Enable Code Analyser

{{< section "/configure-code-analyser/multi-server/enable-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Single Server Without HA"
linkTitle: "Single Server Without HA"
description: "Instructions on how to configure the code analyser on a single server cluster."
weight: 20
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "How do I disable the code analyser on a single server cluster?"
linkTitle: "How do I disable the code analyser on a single server cluster?"
description: "Instructions on how to disable the code analyser on a single server cluster."
weight: 20
---

# Disable Code Analyser

{{< section "/configure-code-analyser/single-server/disable-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "How do I enable the code analyser on a single server cluster?"
linkTitle: "How do I enable the code analyser on a single server cluster?"
description: "Instructions on how to enable the code analyser on a single server cluster."
weight: 10
---

# Enable Code Analyser

{{< section "/configure-code-analyser/single-server/enable-code-analyser.md" >}}
Loading
Loading