Skip to content

Commit c62f504

Browse files
cortex-jkcortex-jk
authored
Merge 2024.5 Documentation
1 parent a37c263 commit c62f504

File tree

1,223 files changed

+82615
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,223 files changed

+82615
-11
lines changed

‎.htmltest.yml

+3
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,13 @@ IgnoreURLs:
2222
- "http://www.mimekit.net/docs/.*"
2323
- "https://nssm.cc/"
2424
- "https://code.visualstudio.com/"
25+
- "https://blogs.oracle.com/.*"
2526
IgnoreDirs:
2627
- "docs/?.*/_print/"
2728
- "docs/?.*/_shared/"
2829
- "docs/2022.9/?.*/"
2930
- "docs/2023.3/?.*/"
3031
- "docs/2023.5/?.*/"
3132
- "docs/2023.7/?.*/"
33+
- "docs/2023.9/?.*/"
34+
- "docs/2023.11/?.*/"

‎.vscode/settings.json

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{
2+
}

‎config/_default/config.toml

+6-1
Original file line numberDiff line numberDiff line change
@@ -204,11 +204,16 @@ enable = true
204204
weight = 10
205205

206206
# Releases menu
207+
[[params.versions]]
208+
version = "2024.5"
209+
url = "/docs/2024.5/"
210+
dotNetVersion = "net-6.0"
211+
latest = true
212+
207213
[[params.versions]]
208214
version = "2024.3"
209215
url = "/docs/2024.3/"
210216
dotNetVersion = "net-6.0"
211-
latest = true
212217

213218
[[params.versions]]
214219
version = "2024.1"

‎content/en/blog/releases/2024.X/2024.3.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ Affected Components:
529529
This Product Portal includes updates related to:
530530

531531
* The [improved blocks][Improved Blocks] and data types
532-
* [Exceptions][] and [Data Types][] that were marked as Work In Progess
532+
* [Exceptions][] and [Data Types][] that were marked as Work In Progress
533533
* The [improved installation][]
534534

535535
Also, new documentation has been added to reflect the new [platform upgrade process][Upgrade Instructions].

‎content/en/blog/releases/2024.X/2024.5.md

+462
Large diffs are not rendered by default.

‎content/en/docs/2024.1/Reference/Exceptions/flows/execution/invalid-default-values-exception.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "InvalidDefaultValuesException"
3+
linkTitle: "InvalidDefaultValuesException"
4+
description: "The exception thrown if an exception occurs when initialising the default value for a variable."
5+
---
6+
7+
# {{% param title %}}
8+
9+
<p class="namespace">(Cortex.Exceptions.Flows.Execution.InvalidDefaultValuesException)</p>
10+
{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}
11+
12+
## Description
13+
14+
The exception thrown if an exception occurs when initialising the default value for a variable.
15+
16+
## Reasons
17+
18+
### Invalid Default Variable Value
19+
20+
The default value provided for a variable is invalid.
21+
22+
#### Message Format
23+
24+
```json
25+
"Failed to initialise variables due to invalid default values. Please see the 'Variables' property for details on why each variable threw."
26+
```
27+
28+
#### How to fix
29+
30+
Ensure that the variables shown in the `Variables` property have valid default values, by fixing the inner exception for each variable shown.
31+
32+
## Remarks
33+
34+
### Known Limitations
35+
36+
None
37+
38+
## See Also
39+
40+
### External Documentation
41+
42+
None

‎content/en/docs/2024.1/Reference/Exceptions/flows/execution/runtime-translation-exception.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "RuntimeTranslationException"
3+
linkTitle: "RuntimeTranslationException"
4+
description: "The exception thrown when a block is found to have errors within its properties while executing a flow."
5+
---
6+
7+
# {{% param title %}}
8+
9+
<p class="namespace">(Cortex.Exceptions.Flows.Execution.RuntimeTranslationException)</p>
10+
{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}
11+
12+
## Description
13+
14+
The exception thrown when a block is found to have errors within its properties while executing a flow.
15+
## Reasons
16+
17+
### Block has errors during flow execution
18+
19+
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.
20+
21+
#### Message Format
22+
23+
```json
24+
"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."
25+
```
26+
27+
#### How to fix
28+
29+
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).
30+
31+
## Remarks
32+
33+
### Known Limitations
34+
35+
None
36+
37+
## See Also
38+
39+
### External Documentation
40+
41+
None
42+
43+
[WhatIsAMessage]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc">}}
44+
[SetNextBlockToExecute]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment.SetNextBlockToExecute">}}
45+
[Start Flow block]: {{<url path = "Cortex.Reference.Blocks.Flows.StartFlow.StartFlow.MainDoc">}}

‎content/en/docs/2024.3/Guides/upgrade-cortex/2024.1-to-2024.3/single-server-without-ha/_index.md

-6
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,3 @@ linkTitle: "Single Server - Without HA"
44
description: "Upgrade instructions for a single on-premise server without high availability (HA)."
55
weight: 500
66
---
7-
8-
{{% pageinfo %}}
9-
Single server upgrades without HA are not recommended for the following scenarios:
10-
11-
* Production upgrades that are required to scale and support HA
12-
{{% /pageinfo %}}

‎content/en/docs/2024.3/Guides/upgrade-cortex/2024.1-to-2024.3/single-server-without-ha/upgrade-web-application-server.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.1 to 2024.3. P
1111

1212
## Make Installation Artefacts Available
1313

14-
{{< section "/install-web-application-server/make-installation-artefacts-available.md">}}
14+
1. Copy the following artefacts to a folder on the machine:
15+
16+
* Cortex Innovation 2024.3 - Gateway.zip
17+
* Cortex Innovation 2024.3 - Web App Server Install Scripts.zip
18+
19+
1. Extract the `Cortex Innovation 2024.3 - Web App Server Install Scripts.zip` zip file to a folder with the same name.
1520

1621
## Configure Upgrade Script
1722

‎content/en/docs/2024.3/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: "2024.3"
33
linkTitle: "2024.3"
44
description: "Product documentation for the {{% ctx %}} automation platform, including guides, tutorials and reference documentation."
5-
weight: 994
5+
weight: 993
66
---

‎content/en/docs/2024.5/FAQs/_index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "FAQs"
3+
linkTitle: "FAQs"
4+
description: "Answers to our most frequently asked questions."
5+
weight: 10000
6+
---
7+
8+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Guides"
3+
linkTitle: "Guides"
4+
description: "This section includes all guides for the {{% ctx %}} Innovation platform."
5+
weight: 10
6+
---

‎content/en/docs/2024.5/Guides/cortex-gateway/_index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "CORTEX Gateway"
3+
linkTitle: "CORTEX Gateway"
4+
description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} Innovation platform."
5+
weight: 1
6+
---
7+
8+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/help/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Help"
3+
linkTitle: "Help"
4+
description: "System level help"
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/help/cortex-release-notes.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Release Notes"
3+
linkTitle: "Release Notes"
4+
description: "Release notes for all currently available {{% ctx %}} Versions."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "CORTEX Gateway Management"
3+
linkTitle: "CORTEX Gateway Management"
4+
description: "{{% ctx %}} Gateway and Studio Management tools and settings"
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/ldap-authorisation.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "LDAP Authorisation"
3+
linkTitle: "LDAP Authorisation"
4+
description: "Configure RBAC by assining roles to security groups."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/ldap-connection.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "LDAP Connection"
3+
linkTitle: "LDAP Connection"
4+
description: "Connect to an Active Directory using LDAP."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/license-consumption.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "License Consumption"
3+
linkTitle: "License Consumption"
4+
description: "Review current license consumption of flows in master."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/packages.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Packages"
3+
linkTitle: "Packages"
4+
description: "Create and Manage {{% ctx %}} Innovation Packages"
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/studio-authorisation.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Studio Authorisation"
3+
linkTitle: "Studio Authorisation"
4+
description: "Assign access rights to flows based on security groups."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/studio-export.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Studio Export"
3+
linkTitle: "Studio Export"
4+
description: "Create {{% ctx %}} Studio Packages by exporting flows."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/studio-hierarchy.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Studio Hierarchy"
3+
linkTitle: "Studio Hierarchy"
4+
description: "Manage the location of flows in the Flow Hierarchy."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/studio-import.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Studio Import"
3+
linkTitle: "Studio Import"
4+
description: "Import {{% ctx %}} Studio Packages."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/settings/version-control.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Version Control"
3+
linkTitle: "Version Control"
4+
description: "High level view of flows out of sync with master. Allow for mass Commit or Get Master"
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-gateway/welcome-page/_index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Welcome Page"
3+
linkTitle: "Welcome Page"
4+
description: "Welcome Page"
5+
---
6+
7+
{{< workinprogress >}}
8+
9+
## Summary
10+
11+
## Recently Edited Flows
12+
13+
TODO: Summary, Screenshots

‎content/en/docs/2024.5/Guides/cortex-innovation/_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "CORTEX Innovation"
3+
linkTitle: "CORTEX Innovation"
4+
description: "The {{% ctx %}} Innovation platform."
5+
weight: 300
6+
---

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Core Application"
3+
linkTitle: "Core Application"
4+
description: "The Core Application."
5+
weight: 1
6+
---

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Services"
3+
linkTitle: "Services"
4+
description: "The Core Application Services."
5+
weight: 1
6+
---

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/api-gateway-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "API Gateway Service"
3+
linkTitle: "API Gateway Service"
4+
description: "The API Gateway Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/authorisation-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Authorisation Service"
3+
linkTitle: "Authorisation Service"
4+
description: "The Authorisation Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/concurrency-management-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Concurrency Management Service"
3+
linkTitle: "Concurrency Management Service"
4+
description: "The Concurrency Management Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/configuration-management-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Configuration Management Service"
3+
linkTitle: "Configuration Management Service"
4+
description: "The Configuration Management Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/data-storage-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Data Storage Service"
3+
linkTitle: "Data Storage Service"
4+
description: "The Data Storage Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/execution-management-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Execution Management Service"
3+
linkTitle: "Execution Management Service"
4+
description: "The Execution Management Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/licence-management-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Licence Management Service"
3+
linkTitle: "Licence Management Service"
4+
description: "The Licence Management Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/package-management-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Package Management Service"
3+
linkTitle: "Package Management Service"
4+
description: "The Package Management Service."
5+
---
6+
7+
{{< workinprogress >}}

‎content/en/docs/2024.5/Guides/cortex-innovation/core-application/services/provisioning-service/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Provisioning Service"
3+
linkTitle: "Provisioning Service"
4+
description: "The Provisioning Service."
5+
---
6+
7+
{{< workinprogress >}}

0 commit comments

Comments
 (0)