Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Guides/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Guides"
linkTitle: "Guides"
description: "This section includes all guides for the {{% ctx %}} Innovation platform."
description: "This section includes all guides for the {{% ctx %}} platform."
weight: 10
---
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Guides/cortex-gateway/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CORTEX Gateway"
linkTitle: "CORTEX Gateway"
description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} Innovation platform."
description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} platform."
weight: 1
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Packages"
linkTitle: "Packages"
description: "Create and Manage {{% ctx %}} Innovation Packages"
description: "Create and Manage {{% ctx %}} Packages"
---

{{< workinprogress >}}
6 changes: 3 additions & 3 deletions content/en/docs/2025.1/Guides/cortex-innovation/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CORTEX Innovation"
linkTitle: "CORTEX Innovation"
description: "The {{% ctx %}} Innovation platform."
title: "CORTEX Applications"
linkTitle: "CORTEX Applications"
description: "The Service Fabric applications hosting the services within the {{% ctx %}} platform."
weight: 300
---
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "CORTEX Interaction Portal"
linkTitle: "CORTEX Interaction Portal"
description: "A web application that provides Human-in-the-Loop capabilities to the {{% ctx %}} Innovation platform."
description: "A web application that provides Human-in-the-Loop capabilities to the {{% ctx %}} platform."
weight: 400
---

* {{< filelink src="/pdf/Cortex Interaction Portal User Guide.pdf" name="CORTEX Interaction Portal User Guide" >}}
* {{< filelink src="/pdf/Cortex Interaction Portal Developer Guide.pdf" name="CORTEX Interaction Portal Developer Guide" >}}
* {{< filelink src="/pdf/Cortex Interaction Portal Merging Guide.pdf" name="CORTEX Interaction Portal Merging Guide" >}}
* {{< filelink src="/pdf/CORTEX Interaction Portal User Guide.pdf" name="CORTEX Interaction Portal User Guide" >}}
* {{< filelink src="/pdf/CORTEX Interaction Portal Developer Guide.pdf" name="CORTEX Interaction Portal Developer Guide" >}}
* {{< filelink src="/pdf/CORTEX Interaction Portal Merging Guide.pdf" name="CORTEX Interaction Portal Merging Guide" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 30

# {{% param title %}}

This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}} Innovation.
This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}}.

## Make Installation Artefacts Available on all Servers

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Upgrade"
linkTitle: "Upgrade"
description: "Instructions to upgrade {{% ctx %}} Innovation across multiple on-premise servers with high availability (HA)."
description: "Instructions to upgrade {{% ctx %}} across multiple on-premise servers with high availability (HA)."
weight: 40
---

This guide describes how to upgrade {{% ctx %}} Innovation. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.
This guide describes how to upgrade {{% ctx %}}. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.

[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeCortex.2024.11to2025.1.MultipleServerWithHA.PreUpgrade" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 30

# {{% param title %}}

This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}} Innovation.
This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}}.

## Make Installation Artefacts Available

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Upgrade"
linkTitle: "Upgrade"
description: "Instructions to upgrade {{% ctx %}} Innovation on a single on-premise server without high availability (HA)."
description: "Instructions to upgrade {{% ctx %}} on a single on-premise server without high availability (HA)."
weight: 40
---

This guide describes how to upgrade {{% ctx %}} Innovation. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.
This guide describes how to upgrade {{% ctx %}}. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.

[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeCortex.2024.11to2025.1.SingleServerWithoutHA.PreUpgrade" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide describes how to upgrade the default dashboards that are provided for

## Download the Default Dashboards

1. Download [Grafana.Dashboards.zip][] archive containing the {{% ctx %}} Innovation default dashboards.
1. Download [Grafana.Dashboards.zip][] archive containing the {{% ctx %}} default dashboards.
1. Extract the content of the downloaded archive to a suitable location.

## Import New Dashboards
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CORTEX Innovation"
linkTitle: "CORTEX Innovation"
description: "This section includes all reference documentation for the APIs exposed by the {{% ctx %}} Innovation platform."
title: "CORTEX"
linkTitle: "CORTEX"
description: "This section includes all reference documentation for the APIs exposed by the {{% ctx %}} platform."
weight: 300
---
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ The flow being run is `ExampleFlow`. This flow sets the value of an [Output][] v

<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.
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 a {{% ctx %}} install.

#### Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ The exceptions thrown by the block can be found below:

### Configuring Logging

Log settings exist for the following {{% ctx %}} Innovation Services:
Log settings exist for the following {{% ctx %}} Services:

| Service | Default File Location | Description |
|----------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -318,7 +318,7 @@ Please note that if the appsetting.json file cannot be found for one of the serv

### Anatomy of a Log

The format of the logs written by this block are the same as the logs written by the rest of the {{% ctx %}} Innovation Services. This is to ensure logging is consistent and done one way within {{% ctx %}}. Hopefully this will make it easier to work with logging, and also make it easier to gain a holistic picture into what has happened to a flow execution throughout its entire lifecycle (i.e. from initial request to returning the response to the caller), rather than just what happens inside of the flow.
The format of the logs written by this block are the same as the logs written by the rest of the {{% ctx %}} Services. This is to ensure logging is consistent and done one way within {{% ctx %}}. Hopefully this will make it easier to work with logging, and also make it easier to gain a holistic picture into what has happened to a flow execution throughout its entire lifecycle (i.e. from initial request to returning the response to the caller), rather than just what happens inside of the flow.

An example log can be found below:

Expand Down Expand Up @@ -469,7 +469,7 @@ A list of each of the log's properties and an accompanying description can be fo
| `Event.Tags.Custom` | Contains custom tags generated by the automation solution running on the {{% ctx %}} platform. |
| `Event.Tags.Custom.$type` | The .NET data type used to represent the custom tags data. This can be ignored and is an artefact of the underlying implementation. |
| `Event.Tags.$type` | The .NET data type used to represent the tags data. This can be ignored and is an artefact of the underlying implementation. |
| `Event.Correlation` | Contains details that can be used to correlate related events. E.g. The act of starting a new flow execution may result in multiple {{% ctx %}} Innovation Services processing the event. As a result, each service may write its own logs, and additionally the flow developer may also write out multiple logs during the flow execution. The Correlation details allow all of these logs to easily be correlated back together when performing log analysis and reporting to gain a full picture of everything that happened. |
| `Event.Correlation` | Contains details that can be used to correlate related events. E.g. The act of starting a new flow execution may result in multiple {{% ctx %}} Services processing the event. As a result, each service may write its own logs, and additionally the flow developer may also write out multiple logs during the flow execution. The Correlation details allow all of these logs to easily be correlated back together when performing log analysis and reporting to gain a full picture of everything that happened. |
| `Event.Correlation.TraceId` | ID common to all related logs, so they can be easily correlated together. |
| `Event.Correlation.SpanId` | Unique ID for each log, so tools like [Grafana][] can display a call stack, showing each step that occurred when processing an event. |
| `Event.Correlation.ParentSpanId` | The ID of the step that called this step of processing, so tools like [Grafana][] can display a call stack, showing each step that occurred when processing an event. |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Reference/Concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Concepts"
linkTitle: "Concepts"
description: "This section includes all reference documentation for concepts required to use {{% ctx %}} Innovation."
description: "This section includes all reference documentation for concepts required to use {{% ctx %}}."
weight: 1
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Fundamentals"
linkTitle: "Fundamentals"
description: "Fundamental concepts when working with {{% ctx %}} Innovation."
description: "Fundamental concepts when working with {{% ctx %}}."
weight: 1
---
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A [flow][] may trigger the execution of another [flow][].
A [flow][] can be called from another [flow][] in the following ways:

- Using the [Run Flow][] block to trigger the execution of another flow directly
- Using the [Execute HTTP Request][] block to trigger a flow through the API Gateway service (this should only be used to call [flows][flow] published in a separate {{% ctx %}} Innovation platform)
- Using the [Execute HTTP Request][] block to trigger a flow through the API Gateway service (this should only be used to call [flows][flow] published in a separate {{% ctx %}} platform)

### Input Variables

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Working With..."
linkTitle: "Working With..."
description: "This section includes all reference documentation for concepts required to use {{% ctx %}} Innovation."
description: "This section includes all reference documentation for concepts required to use {{% ctx %}}."
weight: 2
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Reference"
linkTitle: "Reference"
description: "This section includes all reference documentation for the {{% ctx %}} Innovation platform."
description: "This section includes all reference documentation for the {{% ctx %}} platform."
weight: 100
---
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Reference/logs/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Logs"
linkTitle: "Logs"
description: "This section includes all reference documentation for the logs generated by the {{% ctx %}} Innovation platform."
description: "This section includes all reference documentation for the logs generated by the {{% ctx %}} platform."
weight: 10
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CORTEX Innovation"
linkTitle: "CORTEX Innovation"
description: "This section includes all reference documentation for the logs generated by the {{% ctx %}} Innovation platform."
title: "CORTEX"
linkTitle: "CORTEX"
description: "This section includes all reference documentation for the logs generated by the {{% ctx %}} platform."
weight: 300
---
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Reference/messages/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Messages"
linkTitle: "Messages"
description: "This section includes all reference documentation for messages generated by the {{% ctx %}} Innovation platform."
description: "This section includes all reference documentation for messages generated by the {{% ctx %}} platform."
weight: 10
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Reference/observability/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Observability"
linkTitle: "Observability"
description: "This section includes all reference documentation for the Observability platform for {{% ctx %}} Innovation."
description: "This section includes all reference documentation for the Observability platform for {{% ctx %}}."
weight: 10
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Grafana"
linkTitle: "Grafana"
description: "This section includes all reference documentation for the Grafana Observability platform for {{% ctx %}} Innovation."
description: "This section includes all reference documentation for the Grafana Observability platform for {{% ctx %}}."
weight: 10
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Dashboards"
linkTitle: "Dashboards"
description: "This section includes all reference documentation for the {{% ctx %}} Innovation default set of Grafana dashboards."
description: "This section includes all reference documentation for the {{% ctx %}} default set of Grafana dashboards."
weight: 10
---
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 10

## Description

This dashboard provides the information required to analyse the flow execution requests within the {{% ctx %}} Innovation platform. It will display data based on the [Time Range][] that has been specified.
This dashboard provides the information required to analyse the flow execution requests within the {{% ctx %}} platform. It will display data based on the [Time Range][] that has been specified.

At the top of the page there is a dashboard description. This provides information about what the dashboard is reporting and what each of the filters are. The description is always collapsed by default.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 20

## Description

This dashboard provides the information required to analyse the health of the {{% ctx %}} Innovation platform. It will display data based on the [Time Range][] that has been specified.
This dashboard provides the information required to analyse the health of the {{% ctx %}} platform. It will display data based on the [Time Range][] that has been specified.

At the top of the page there is a dashboard description. This provides information about what the dashboard is reporting and what each of the filters are. The description is always collapsed by default.

Expand Down Expand Up @@ -118,13 +118,13 @@ This tile displays the mean duration for requests during the specified [time ran

## Availability Section

This section displays the availability of the {{% ctx %}} Innovation platform and consists of 1 panel.
This section displays the availability of the {{% ctx %}} platform and consists of 1 panel.

{{< figure src="/images/editable/Platform Health - Availability.png">}}

### Availability

This graph displays the availability of the {{% ctx %}} Innovation Platform during the specified [time range][] by calculating successful requests / total requests. Successful requests are all requests that do not result in an unknown or 5xx HTTP response. 4xx responses are considered successful in this scenario.
This graph displays the availability of the {{% ctx %}} Platform during the specified [time range][] by calculating successful requests / total requests. Successful requests are all requests that do not result in an unknown or 5xx HTTP response. 4xx responses are considered successful in this scenario.

Each data point value is calculated by aggregating requests based on the Interval filter. If there is no data for the previous interval, the line will be [broken](#breaks-in-graph-lines) as the availability is not known at the time.

Expand All @@ -140,7 +140,7 @@ This graph is configured to start the availability axis at 80%. However, if the

## Requests Section

This section provides information regarding the history of the requests processed by the {{% ctx %}} Innovation platform for the specified [time range][] and consists of 2 panels.
This section provides information regarding the history of the requests processed by the {{% ctx %}} platform for the specified [time range][] and consists of 2 panels.

{{< figure src="/images/editable/Platform Health - Requests.png">}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Installation"
linkTitle: "Installation"
description: "Information on troubleshooting {{% ctx %}} Innovation installations."
description: "Information on troubleshooting {{% ctx %}} installations."
---

# {{% param title %}}
Expand Down Expand Up @@ -161,11 +161,11 @@ To work around this error, either uninstall the platform and reinstall it using

## Troubleshooting issues after installation {#ts-after-installation}

### {{% ctx %}} Innovation features not visible in {{% ctx %}} Gateway {#ts-no-innovation}
### {{% ctx %}} features not visible in {{% ctx %}} Gateway {#ts-no-innovation}

Check that the `Feature Flags` Guid in the `CortexGateway.SetParameters.xml` file used for installing {{% ctx %}} Gateway is correct. If it is not, update it and reinstall {{% ctx %}} Gateway or update the value in the `web.config` file and restart the website. If the value is correct, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance.

### {{% ctx %}} Innovation blocks not visible in {{% ctx %}} Studio {#ts-no-blocks}
### {{% ctx %}} blocks not visible in {{% ctx %}} Studio {#ts-no-blocks}

#### Application Pool user does not have Modify rights to the Roaming folder

Expand Down Expand Up @@ -268,7 +268,7 @@ If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX

### Managing RabbitMQ

There may be times when the logs provided by {{% ctx %}} Innovation Services and the errors displayed in Service Fabric Explorer are not enough to debug an issue that is occurring on the system. This can be due to RabbitMQ being a state where it can’t send messages between services.
There may be times when the logs provided by {{% ctx %}} Services and the errors displayed in Service Fabric Explorer are not enough to debug an issue that is occurring on the system. This can be due to RabbitMQ being a state where it can’t send messages between services.

To check that RabbitMQ is working as expected, remote desktop to an Application Server and navigate to `https://app-server1.domain.com:15671`, replacing `app-server1.domain.com` with the FQDN of one of the Application Servers. Sign in with username 'administrator' and the RabbitMQ password provided during the Application Server installation. The following should be displayed in the overview tab for a healthy cluster:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Upgrade"
linkTitle: "Upgrade"
description: "Information on troubleshooting {{% ctx %}} Innovation upgrades."
description: "Information on troubleshooting {{% ctx %}} upgrades."
---

# {{% param title %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Tutorials/Administration/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Administration"
linkTitle: "Administration"
description: "This section includes tutorials about administering the {{% ctx %}} Innovation platform."
description: "This section includes tutorials about administering the {{% ctx %}} platform."
weight: 40
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Tutorials/Development/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Development"
linkTitle: "Development"
description: "This section includes tutorials about developing automation using the {{% ctx %}} Innovation platform."
description: "This section includes tutorials about developing automation using the {{% ctx %}} platform."
weight: 30
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/2025.1/Tutorials/Installation/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Installation"
linkTitle: "Installation"
description: "This section includes tutorials about installing the {{% ctx %}} Innovation platform."
description: "This section includes tutorials about installing the {{% ctx %}} platform."
weight: 10
---

Expand Down
Loading
Loading