Merge 2024.5 Documentation

.htmltest.yml

@@ -22,10 +22,13 @@ IgnoreURLs:
 - "http://www.mimekit.net/docs/.*"
 - "https://nssm.cc/"
 - "https://code.visualstudio.com/"
+- "https://blogs.oracle.com/.*"
 IgnoreDirs:
 - "docs/?.*/_print/"
 - "docs/?.*/_shared/"
 - "docs/2022.9/?.*/"
 - "docs/2023.3/?.*/"
 - "docs/2023.5/?.*/"
 - "docs/2023.7/?.*/"
+- "docs/2023.9/?.*/"
+- "docs/2023.11/?.*/"

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

config/_default/config.toml

@@ -204,11 +204,16 @@ enable = true
 	weight = 10
 
 # Releases menu
+[[params.versions]]
+	version = "2024.5"
+	url = "/docs/2024.5/"
+	dotNetVersion = "net-6.0"
+	latest = true
+
 [[params.versions]]
 	version = "2024.3"
 	url = "/docs/2024.3/"
 	dotNetVersion = "net-6.0"
-	latest = true
 
 [[params.versions]]
 	version = "2024.1"

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

@@ -529,7 +529,7 @@ Affected Components:
 This Product Portal includes updates related to:
 
 * The [improved blocks][Improved Blocks] and data types
-* [Exceptions][] and [Data Types][] that were marked as Work In Progess
+* [Exceptions][] and [Data Types][] that were marked as Work In Progress
 * The [improved installation][]
 
 Also, new documentation has been added to reflect the new [platform upgrade process][Upgrade Instructions].

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

@@ -0,0 +1,42 @@
+---
+title: "InvalidDefaultValuesException"
+linkTitle: "InvalidDefaultValuesException"
+description: "The exception thrown if an exception occurs when initialising the default value for a variable."
+---
+
+# {{% param title %}}
+
+<p class="namespace">(Cortex.Exceptions.Flows.Execution.InvalidDefaultValuesException)</p>
+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}
+
+## Description
+
+The exception thrown if an exception occurs when initialising the default value for a variable.
+
+## Reasons
+
+### Invalid Default Variable Value
+
+The default value provided for a variable is invalid.
+
+#### Message Format
+
+```json
+"Failed to initialise variables due to invalid default values. Please see the 'Variables' property for details on why each variable threw."
+```
+
+#### How to fix
+
+Ensure that the variables shown in the `Variables` property have valid default values, by fixing the inner exception for each variable shown.
+
+## Remarks
+
+### Known Limitations
+
+None
+
+## See Also
+
+### External Documentation
+
+None

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

@@ -0,0 +1,45 @@
+---
+title: "RuntimeTranslationException"
+linkTitle: "RuntimeTranslationException"
+description: "The exception thrown when a block is found to have errors within its properties while executing a flow."
+---
+
+# {{% param title %}}
+
+<p class="namespace">(Cortex.Exceptions.Flows.Execution.RuntimeTranslationException)</p>
+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}}
+
+## Description
+
+The exception thrown when a block is found to have errors within its properties while executing a flow.
+## Reasons
+
+### Block has errors during flow execution
+
+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.
+
+#### Message Format
+
+```json
+"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."
+```
+
+#### How to fix
+
+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).
+
+## Remarks
+
+### Known Limitations
+
+None
+
+## See Also
+
+### External Documentation
+
+None
+
+[WhatIsAMessage]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Messages.WhatIsAMessage.MainDoc">}}
+[SetNextBlockToExecute]: {{<url path = "Cortex.Reference.Concepts.Fundamentals.Executions.ExecutionsInDevelopment.SetNextBlockToExecute">}}
+[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

@@ -4,9 +4,3 @@ linkTitle: "Single Server - Without HA"
 description: "Upgrade instructions for a single on-premise server without high availability (HA)."
 weight: 500
 ---
-
-{{% pageinfo %}}
-Single server upgrades without HA are not recommended for the following scenarios:
-
-* Production upgrades that are required to scale and support HA
-{{% /pageinfo %}}

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

@@ -11,7 +11,12 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.1 to 2024.3. P
 
 ## Make Installation Artefacts Available
 
-{{< section "/install-web-application-server/make-installation-artefacts-available.md">}}
+1. Copy the following artefacts to a folder on the machine:
+
+   * Cortex Innovation 2024.3 - Gateway.zip
+   * Cortex Innovation 2024.3 - Web App Server Install Scripts.zip
+
+1. Extract the `Cortex Innovation 2024.3 - Web App Server Install Scripts.zip` zip file to a folder with the same name.
 
 ## Configure Upgrade Script
 

content/en/docs/2024.3/_index.md

@@ -2,5 +2,5 @@
 title: "2024.3"
 linkTitle: "2024.3"
 description: "Product documentation for the {{% ctx %}} automation platform, including guides, tutorials and reference documentation."
-weight: 994
+weight: 993
 ---

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

@@ -0,0 +1,8 @@
+---
+title: "FAQs"
+linkTitle: "FAQs"
+description: "Answers to our most frequently asked questions."
+weight: 10000
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,6 @@
+---
+title: "Guides"
+linkTitle: "Guides"
+description: "This section includes all guides for the {{% ctx %}} Innovation platform."
+weight: 10
+---

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

@@ -0,0 +1,8 @@
+---
+title: "CORTEX Gateway"
+linkTitle: "CORTEX Gateway"
+description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} Innovation platform."
+weight: 1
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Help"
+linkTitle: "Help"
+description: "System level help"
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Release Notes"
+linkTitle: "Release Notes"
+description: "Release notes for all currently available {{% ctx %}} Versions."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "CORTEX Gateway Management"
+linkTitle: "CORTEX Gateway Management"
+description: "{{% ctx %}} Gateway and Studio Management tools and settings"
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "LDAP Authorisation"
+linkTitle: "LDAP Authorisation"
+description: "Configure RBAC by assining roles to security groups."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "LDAP Connection"
+linkTitle: "LDAP Connection"
+description: "Connect to an Active Directory using LDAP."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "License Consumption"
+linkTitle: "License Consumption"
+description: "Review current license consumption of flows in master."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Packages"
+linkTitle: "Packages"
+description: "Create and Manage {{% ctx %}} Innovation Packages"
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Studio Authorisation"
+linkTitle: "Studio Authorisation"
+description: "Assign access rights to flows based on security groups."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Studio Export"
+linkTitle: "Studio Export"
+description: "Create {{% ctx %}} Studio Packages by exporting flows."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Studio Hierarchy"
+linkTitle: "Studio Hierarchy"
+description: "Manage the location of flows in the Flow Hierarchy."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Studio Import"
+linkTitle: "Studio Import"
+description: "Import {{% ctx %}} Studio Packages."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Version Control"
+linkTitle: "Version Control"
+description: "High level view of flows out of sync with master. Allow for mass Commit or Get Master"
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,13 @@
+---
+title: "Welcome Page"
+linkTitle: "Welcome Page"
+description: "Welcome Page"
+---
+
+{{< workinprogress >}}
+
+## Summary
+
+## Recently Edited Flows
+
+TODO: Summary, Screenshots

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

@@ -0,0 +1,6 @@
+---
+title: "CORTEX Innovation"
+linkTitle: "CORTEX Innovation"
+description: "The {{% ctx %}} Innovation platform."
+weight: 300
+---

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

@@ -0,0 +1,6 @@
+---
+title: "Core Application"
+linkTitle: "Core Application"
+description: "The Core Application."
+weight: 1
+---

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

@@ -0,0 +1,6 @@
+---
+title: "Services"
+linkTitle: "Services"
+description: "The Core Application Services."
+weight: 1
+---

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

@@ -0,0 +1,7 @@
+---
+title: "API Gateway Service"
+linkTitle: "API Gateway Service"
+description: "The API Gateway Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Authorisation Service"
+linkTitle: "Authorisation Service"
+description: "The Authorisation Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Concurrency Management Service"
+linkTitle: "Concurrency Management Service"
+description: "The Concurrency Management Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Configuration Management Service"
+linkTitle: "Configuration Management Service"
+description: "The Configuration Management Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Data Storage Service"
+linkTitle: "Data Storage Service"
+description: "The Data Storage Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Execution Management Service"
+linkTitle: "Execution Management Service"
+description: "The Execution Management Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Licence Management Service"
+linkTitle: "Licence Management Service"
+description: "The Licence Management Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Package Management Service"
+linkTitle: "Package Management Service"
+description: "The Package Management Service."
+---
+
+{{< workinprogress >}}

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

@@ -0,0 +1,7 @@
+---
+title: "Provisioning Service"
+linkTitle: "Provisioning Service"
+description: "The Provisioning Service."
+---
+
+{{< workinprogress >}}