From 4b193c3c7b4970b81c0bbce39360a8a58ff196fe Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Tue, 17 Dec 2024 16:13:41 +0000 Subject: [PATCH 01/19] Restructured Multi Server Install Documentation --- .../assign-certificate-friendly-name.md | 2 +- .../configure-debugger-installation-script.md | 6 +- .../add-innovation-only/licensing.md | 2 +- .../Grafana/try-it-out.md | 4 +- .../multiple-server-with-ha/try-it-out.md | 2 +- .../Grafana/prerequisites.md | 2 +- .../Grafana/try-it-out.md | 4 +- .../multiple-server-with-ha/_index.md | 2 +- .../multiple-server-with-ha/architecture.md | 4 +- .../installation/_index.md | 10 ++ ...ll-application-and-loadbalancer-servers.md | 27 ++---- .../install-web-application-server/_index.md | 2 +- .../perform-debugger-installation.md | 6 +- .../perform-gateway-installation.md | 20 ++-- .../prerequisites.md | 18 +--- .../{ => installation}/setup-gateway.md | 6 +- .../{ => installation}/try-it-out.md | 2 +- .../pre-installation.md | 92 +++++++++++++++++++ .../{prerequisites.md => requirements.md} | 69 +++----------- data/urls.toml | 31 ++++++- 20 files changed, 191 insertions(+), 120 deletions(-) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/install-application-and-loadbalancer-servers.md (96%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/install-web-application-server/_index.md (89%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/install-web-application-server/perform-debugger-installation.md (94%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/install-web-application-server/perform-gateway-installation.md (97%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/install-web-application-server/prerequisites.md (79%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/setup-gateway.md (98%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{ => installation}/try-it-out.md (98%) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{prerequisites.md => requirements.md} (83%) diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md index 36dd1b3f6..54f09f0af 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md @@ -8,4 +8,4 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi 1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. 1. Click `OK`. -[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index 5dc7fd819..569e27e4a 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -72,7 +72,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. Save and close `Cortex.Innovation.Install.ps1`. -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirementsNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md index 88853d480..d4a6a77e4 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md @@ -1,3 +1,3 @@ Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirementsNew" >}} diff --git a/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md index a64a07976..47c222972 100644 --- a/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md @@ -10,7 +10,7 @@ weight: 60 ## Check Dashboards are Displaying Data {{% alert title="Note" %}} -This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlow" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. +This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open an HTTP client, such as [Postman][]. Make a request with the following format: @@ -45,5 +45,5 @@ If other requests have been made then there may be more than one request visible {{% / alert %}} [Postman]: {{< url path="Postman.Downloads.MainDoc" >}} -[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} +[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} [Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md index bd73c1220..0c19737cd 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md @@ -63,4 +63,4 @@ Test the platform by creating a new flow and executing it using the following st [Troubleshooting No Innovation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoInnovation" >}} [Troubleshooting No Publish]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoPublish" >}} [Troubleshooting Root Certificate Error]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoRootCertificate" >}} -[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md index 9900a21d1..e5dcd6b8e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md @@ -157,7 +157,7 @@ A domain user which is a member of the Local Administrators group on all Applica [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Architecture" >}} [configuring Grafana to use HTTPS]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureHTTPS" >}} [Create Self-Signed Certificates]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.CreateSelfSignedCertificates" >}} -[Make Installation Artefacts Available]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.MakeInstallationArtefactsAvailable" >}} +[Make Installation Artefacts Available]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.MakeInstallationArtefactsAvailableNew" >}} [Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1.Windows" >}} [Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} [Install Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md index 59731451b..ca0551640 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md @@ -10,7 +10,7 @@ weight: 60 ## Check Dashboards are Displaying Data {{% alert title="Note" %}} -This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlow" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. +This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open an HTTP client, such as [Postman][]. Make a request with the following format: @@ -42,6 +42,6 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} +[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} [Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" >}} [Postman]: {{< url path="Postman.Downloads.MainDoc" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md index 8ada35ca1..7c744ccbc 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Multiple Server - With HA (Recommended)" linkTitle: "Multiple Server - With HA" -description: "Information about installing {{% ctx %}} Innovation across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, prerequisites and installation instructions." +description: "Information about installing {{% ctx %}} Innovation across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/architecture.md index ca58543b5..adf6f9ae7 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/architecture.md @@ -25,6 +25,6 @@ The following architecture requires 5 servers: ## Next Steps? -1. [Prerequisites][] +1. [Requirements][] -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Prerequisites" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md new file mode 100644 index 000000000..78a2ea1a0 --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Installation" +linkTitle: "Installation" +description: "Installation instructions to install {{% ctx %}} across multiple on-premise servers with high availability (HA)." +weight: 40 +--- + +This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. + +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md similarity index 96% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 257e57d0b..4e6f6daae 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -7,16 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Prerequisites for installing Innovation][] have been read before starting this installation. - -## Make Installation Artefacts Available - -1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - Block Packages.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been read before starting this installation. ## Install Microsoft .NET Framework 4.7.2 @@ -216,7 +207,7 @@ To check all necessary ports are free, follow these steps: {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| @@ -319,16 +310,16 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. [Install Web Application Server][] -[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancer" >}} -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} +[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancerNew" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusionsNew" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirementsNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServerNew" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} -[Prerequisites for installing Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Prerequisites" >}} +[Pre-Installation steps for installing {{% ctx %}}]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/_index.md similarity index 89% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/_index.md index a2bf8bace..51dcfdf54 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/_index.md @@ -7,4 +7,4 @@ weight: 40 This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServersNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md similarity index 94% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index e200454ac..abfdc791e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -55,7 +55,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Install Gateway][] -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusionsNew" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} -[web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallationNew" >}} +[web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebApplicationServerPrerequisitesNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md similarity index 97% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index 547e5e1a0..512da1c69 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -45,7 +45,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |------------------------------------------------|-------------| @@ -118,16 +118,16 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta 1. [Setup Gateway][] -[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} +[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew2" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} -[Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GetGatewayAppPoolUser" >}} -[Import Certificate Manually]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew" >}} -[Import Root Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportRootCertificate" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} +[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallationNew" >}} +[Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GetGatewayAppPoolUserNew" >}} +[Import Certificate Manually]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew2" >}} +[Import Root Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportRootCertificateNew" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirementsNew" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md similarity index 79% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md index 27525eb10..1419471d0 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md @@ -9,14 +9,6 @@ weight: 10 This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. -## Make Installation Artefacts Available - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} - ## Licensing {{< section "/install-web-application-server/add-innovation-only/licensing.md">}} @@ -58,12 +50,12 @@ For the Flow Debugger, the certificate must have the following properties: {{% alert title="Important" color="warning" %}} Multi-domain certificates, wildcard certificates, auto-generated self-signed certificates and {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="manually created self-signed certificates" >}} can be used. However, self-signed certificates are not recommended for production instances.
-It is possible to reuse the Flow Debugger certificate for {{% ctx %}} Gateway; If doing so, you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="Assign a Certificate Friendly Name" >}} after the debugger has been installed and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. +It is possible to reuse the Flow Debugger certificate for {{% ctx %}} Gateway; If doing so, you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew2" title="Assign a Certificate Friendly Name" >}} after the debugger has been installed and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. {{% /alert %}} ### Import Root Certificate -{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew" title="Import Certificate Manually" >}} {{% /alert %}} +{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew2" title="Import Certificate Manually" >}} {{% /alert %}} This step must be carried out prior to the installation otherwise the URL validation will fail. In order to import the Root Certificate, ensure that the file is in a known location on this server and complete the following steps: @@ -81,7 +73,7 @@ This step must be carried out prior to the installation otherwise the URL valida ### Import Certificate Manually -{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" title="Install Flow Debugger" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="assign a friendly name" >}}.{{% /alert %}} +{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallationNew" title="Install Flow Debugger" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew2" title="assign a friendly name" >}}.{{% /alert %}} To import the certificate manually follow the below steps: @@ -100,5 +92,5 @@ To import the certificate manually follow the below steps: [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServersNew" >}} +[Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallationNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md similarity index 98% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md index be52563aa..2f1c7c4b2 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md @@ -77,8 +77,8 @@ Log on to Gateway and run through the setup wizard: 1. [Try it out][] [Account Details]: {{< ref "#account-details" >}} -[Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} +[Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallationNew" >}} [LDAP Authorisation]: {{< ref "#ldap-authorisation" >}} [LDAP Connection]: {{< ref "#ldap-connection" >}} -[supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebBrowserRequirements" >}} -[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOut" >}} +[supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebBrowserRequirementsNew" >}} +[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out.md similarity index 98% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out.md index cbebbb92d..2a6a8be40 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out.md @@ -57,7 +57,7 @@ Test the platform by creating a new flow and executing it using the following st 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. 1. {{% ctx %}} Innovation has now been verified and is ready to use. -[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Troubleshooting Flow Not Starting]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNotStarting" >}} [Troubleshooting Flow No Blocks]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNoBlocks" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md new file mode 100644 index 000000000..eab571aaa --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md @@ -0,0 +1,92 @@ +--- +title: "Pre-Installation" +linkTitle: "Pre-Installation" +description: "Information about the steps required to be completed prior to starting the installation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. + +## Obtain a {{% ctx %}} licence file + +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. + +To get a licence file and feature identifier take the following steps: + +1. Copy the following template to a text file: + + ```text + Web Application Server + MachineID: + Fingerprint: + + Application Server 1 + MachineID: + Fingerprint: + + Application Server 2 + MachineID: + Fingerprint: + + Application Server 3 + MachineID: + Fingerprint: + + Please also include a suitable {{% ctx %}} Innovation feature identifier. + ``` + +1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. +1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the Web Application server. +1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: + + ```text + MachineID: WEBAPP-SERVER + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` + +1. Copy the output (machine identifier and fingerprint) to the `Web Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. +1. For each Application Server take the following steps: + 1. Copy `Cortex.Licensing.FingerprintGeneration.exe` to the Application server. + 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: + + ```text + MachineID: APP-SERVER1 + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` + + 1. Copy the output (machine identifier and fingerprint) to one of the `Application Server` sections of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. +1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. +1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. + +## Make Installation Artefacts Available on Application Servers + +1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - App Services.zip + * Cortex Innovation {{< version >}} - Block Packages.zip + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. + +## Make Installation Artefacts Available on Web Application Server + +{{% alert title="Note" %}} +We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. +{{% /alert %}} + +{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} + + +## Generate Encryption Key + +{{< section "/prerequisites/install-innovation-only/multi-server/encryption-requirements.md">}} + +## Next Steps? + +1. [Installation][] + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Installation" >}} +[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md similarity index 83% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md index bced5c869..6a883faec 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md @@ -1,13 +1,13 @@ --- -title: "Prerequisites" -linkTitle: "Prerequisites" -description: "Information about the prerequisites required on each server type for installation." +title: "Requirements" +linkTitle: "Requirements" +description: "Information about the requirements for each server type for installation." weight: 20 --- # {{% param title %}} -The prerequisites required for each server role (as described in [Architecture][]) are laid out in this guide. These must be considered before undertaking installation. +The requirements for each server role (as described in [Architecture][]) are laid out in this guide. These must be considered before undertaking installation. ## Hardware Requirements @@ -66,52 +66,7 @@ The installation requires IP to hostname resolution to be available. Please ensu A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. -To get a licence file and feature identifier take the following steps: - -1. Copy the following template to a text file: - - ```text - Web Application Server - MachineID: - Fingerprint: - - Application Server 1 - MachineID: - Fingerprint: - - Application Server 2 - MachineID: - Fingerprint: - - Application Server 3 - MachineID: - Fingerprint: - - Please also include a suitable {{% ctx %}} Innovation feature identifier. - ``` - -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the Web Application server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: WEBAPP-SERVER - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - -1. Copy the output (machine identifier and fingerprint) to the `Web Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. -1. For each Application Server take the following steps: - 1. Copy `Cortex.Licensing.FingerprintGeneration.exe` to the Application server. - 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: APP-SERVER1 - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - - 1. Copy the output (machine identifier and fingerprint) to one of the `Application Server` sections of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. -1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. -1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. +Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. ## Web Browser Requirements @@ -268,7 +223,10 @@ A script is provided during installation to apply these security changes: ### Encryption Requirements -{{< section "/prerequisites/install-innovation-only/multi-server/encryption-requirements.md">}} +Certain sensitive parameters required during installation (e.g. passwords) must be encrypted; other potentially sensitive parameters (e.g. usernames) can be encrypted using the [{{% ctx %}} Encryptor][CORTEX Encrypted] PowerShell module, which uses AES256. Details of whether a parameter must or should be encrypted are specified during the installation steps. + +Before encrypting parameters, it is required to generate a private key that will be used by the [{{% ctx %}} Encryptor][CORTEX Encrypted] PowerShell module. Details on how to do this are provided during the [Pre-Installation][generate encryption key] steps. + ## Alternative Load Balancer Requirements @@ -282,22 +240,23 @@ Innovation has a [gobetween][] load balancer included that isn't highly availabl ## Next Steps? -1. [Install Application Servers and Load Balancer][] +1. [Pre-Installation][] [alternative load balancer]: {{< ref "#alternative-load-balancer-requirements" >}} [Anycast]: {{< url path="Anycast.MainDoc" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Architecture" >}} [C++ Redistributable]: {{< url path="MSDownload.CPlusPlusRedistributable.2013" >}} -[Create Self-Signed Certificates]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[generate encryption key]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GenerateEncryptionKey" >}} [gobetween]: {{< url path="GoBetween.MainDoc" >}} [IIS Url Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}} [Microsoft Server 2022]: {{< url path="MSEval.WindowsServer.2022" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[obtain licence file]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ObtainLicence" >}} [Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} +[Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [TriggersService]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" >}} [web application server]: {{< ref "#web-application-server" >}} diff --git a/data/urls.toml b/data/urls.toml index a93931ba2..a08cd3f1c 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -263,8 +263,35 @@ LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#encryption-requirements" SetupGateway = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway" - TryItOut= "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out" - TryItOutPublishedFlow= "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out/#test-publishing-production-flows" + TryItOut = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out" + TryItOutPublishedFlow = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out/#test-publishing-production-flows" + MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available-on-application-servers" + ConfigureCortexGatewayInstallationScriptNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers#configure-installation-script" + InstallApplicationAndLoadBalancerServersNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers" + Installation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation" + InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server" + AssignCertificateFriendlyNameNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + GetGatewayAppPoolUserNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" + ImportCertificateManuallyNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#import-certificate-manually" + ImportRootCertificateNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#import-root-certificate" + DebuggerInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation" + GatewayInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation" + PreInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation" + ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" + GenerateEncryptionKey = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#generate-encryption-key" + Requirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements" + AltLoadBalancerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#alternative-load-balancer-requirements" + CertificateRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#certificate-requirements" + WebApplicationServerPrerequisitesNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites" + WebBrowserRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#web-browser-requirements" + AntivirusExclusionsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#antivirus-exclusions" + LicensingRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#licensing-requirements" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#encryption-requirements" + SetupGatewayNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway" + TryItOutNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out" + TryItOutPublishedFlowNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out/#test-publishing-production-flows" + [Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA] MainDoc = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/" Architecture = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/architecture" From 625a59acfcf7af9c1fa360de6eadb3adb79addb9 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 18 Dec 2024 11:39:56 +0000 Subject: [PATCH 02/19] Restructured Single Server Install and fixed broken links on Multi Server install --- .../Reference/troubleshooting/installation.md | 2 +- .../configure-installation-script.md | 6 +- .../configure-debugger-installation-script.md | 2 +- .../Grafana/try-it-out.md | 4 +- .../Grafana/try-it-out.md | 4 +- .../install-innovation-only/_index.md | 8 +- .../advanced/advanced-config-changes.md | 4 +- .../advanced/rollover-certificates.md | 4 +- .../multiple-server-with-ha/_index.md | 2 +- .../installation/_index.md | 2 +- .../prerequisites.md | 1 + .../installation/setup-gateway.md | 2 +- .../multiple-server-with-ha/requirements.md | 2 +- .../{installation => }/try-it-out.md | 0 .../single-server-without-ha/_index.md | 2 +- .../single-server-without-ha/architecture.md | 4 +- .../installation/_index.md | 10 ++ .../install-application-server.md | 13 +- .../install-web-application-server.md | 27 ++-- .../{ => installation}/setup-gateway.md | 4 +- .../pre-installation.md | 65 +++++++++ .../{prerequisites.md => requirements.md} | 51 +++---- .../single-server-without-ha/try-it-out.md | 2 +- data/urls.toml | 136 ++++++++++-------- 24 files changed, 207 insertions(+), 150 deletions(-) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{installation => }/try-it-out.md (100%) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/{ => installation}/install-application-server.md (80%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/{ => installation}/install-web-application-server.md (91%) rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/{ => installation}/setup-gateway.md (98%) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md rename content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/{prerequisites.md => requirements.md} (79%) diff --git a/content/en/docs/2025.1/Reference/troubleshooting/installation.md b/content/en/docs/2025.1/Reference/troubleshooting/installation.md index 642d399ef..4312fb2d1 100644 --- a/content/en/docs/2025.1/Reference/troubleshooting/installation.md +++ b/content/en/docs/2025.1/Reference/troubleshooting/installation.md @@ -12,7 +12,7 @@ description: "Information on troubleshooting {{% ctx %}} Innovation installation If the installation fails with `Root certificate verification failed as no root certificate has been specified.` it means that Windows has not got the trusted root installed for the provided X.509 certificate. This can be rectified by providing the path to a .pem file containing the root certificate in the `pemRootCertificatePath` property for each certificate in the `serverCertificates` and/or `adminCertificates` section of the configuration file. After adding this, the installation script can be re-run. The following steps can be taken to create a .pem file and re-run the installation (these instructions may differ slightly depending on the Certificate Authority): - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} 1. In order to find out the issuer of the certificate, if not already known, the following script can be used, replacing the password for the pfx file and certificate path as necessary: diff --git a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md index a84fafefa..fe910d640 100644 --- a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| @@ -72,6 +72,6 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. Save and close `Cortex.Innovation.Install.ps1`. -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirements" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirementsNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} \ No newline at end of file +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} \ No newline at end of file diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index 569e27e4a..892811726 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md index 47c222972..8fa150c59 100644 --- a/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md @@ -10,7 +10,7 @@ weight: 60 ## Check Dashboards are Displaying Data {{% alert title="Note" %}} -This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. +This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlow" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open an HTTP client, such as [Postman][]. Make a request with the following format: @@ -46,4 +46,4 @@ If other requests have been made then there may be more than one request visible [Postman]: {{< url path="Postman.Downloads.MainDoc" >}} [HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} -[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" >}} +[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md index ca0551640..41a48ec8f 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md @@ -10,7 +10,7 @@ weight: 60 ## Check Dashboards are Displaying Data {{% alert title="Note" %}} -This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. +This test uses the test flow published as part of testing the Innovation installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlow" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlow" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open an HTTP client, such as [Postman][]. Make a request with the following format: @@ -43,5 +43,5 @@ If other requests have been made then there may be more than one request visible {{% / alert %}} [HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} -[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" >}} +[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} [Postman]: {{< url path="Postman.Downloads.MainDoc" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md index 926f2c897..b7b0d94e3 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md @@ -1,10 +1,10 @@ --- -title: "Install Innovation Only" -linkTitle: "Install Innovation Only" -description: "Information about installing a {{% ctx %}} Innovation platform." +title: "Install CORTEX Only" +linkTitle: "Install CORTEX Only" +description: "Information about installing a {{% ctx %}} platform." weight: 10 --- {{% pageinfo %}} -{{% ctx %}} Innovation can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. +{{% ctx %}} can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. {{% /pageinfo %}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md index a89321ee5..5c264f3f0 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md @@ -101,7 +101,7 @@ Advanced configuration (such as port changes) can be undertaken by taking the fo } {{< / highlight >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Line | Description | |------|-------------| @@ -188,7 +188,7 @@ Advanced configuration (such as port changes) can be undertaken by taking the fo } {{< / highlight >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Line | Description | |------|-------------| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/rollover-certificates.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/rollover-certificates.md index 46a45d5b8..7109509b1 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/rollover-certificates.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/rollover-certificates.md @@ -65,7 +65,7 @@ If required, a separate X.509 SSL certificate can be obtained to be used by the {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| @@ -160,7 +160,7 @@ If using a single server and using the same certificates for both the Applicatio 1. Click `Close` to close the Bindings dialog. 1. Open Gateway in a browser. Click the padlock icon next to the URL. The certificate displayed should be the updated one. -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirements" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirementsNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Configure Update Certificates Script]: {{< ref "#configure-update-certificates-script" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} \ No newline at end of file diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md index 7c744ccbc..7962032e3 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Multiple Server - With HA (Recommended)" linkTitle: "Multiple Server - With HA" -description: "Information about installing {{% ctx %}} Innovation across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." +description: "Information about installing {{% ctx %}} across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md index 78a2ea1a0..455a8cd2e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md @@ -7,4 +7,4 @@ weight: 40 This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. -[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md index 1419471d0..ad1a83075 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md @@ -91,6 +91,7 @@ To import the certificate manually follow the below steps: 1. [Install Flow Debugger][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} +[gobetween]: {{< url path="GoBetween.MainDoc" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServersNew" >}} [Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallationNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md index 2f1c7c4b2..cbf5e6675 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md @@ -81,4 +81,4 @@ Log on to Gateway and run through the setup wizard: [LDAP Authorisation]: {{< ref "#ldap-authorisation" >}} [LDAP Connection]: {{< ref "#ldap-connection" >}} [supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebBrowserRequirementsNew" >}} -[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutNew" >}} +[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md index 6a883faec..5cc0e2b4e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md @@ -64,7 +64,7 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. +A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md similarity index 100% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md index a2e303100..cac1db940 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Information about installing {{% ctx %}} Innovation on a single on-premise server without high availability (HA), including: information about components, supported architectures, prerequisites and installation instructions." +description: "Information about installing {{% ctx %}} on a single on-premise server without high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 50 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/architecture.md index 07d150be4..9d4989233 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/architecture.md @@ -23,6 +23,6 @@ The following architecture requires 1 server: ## Next Steps? -1. [Prerequisites][] +1. [Requirements][] -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Prerequisites" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md new file mode 100644 index 000000000..57a519520 --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Installation" +linkTitle: "Installation" +description: "Installation instructions to install {{% ctx %}} on a single on-premise server without high availability (HA)." +weight: 40 +--- + +This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. + +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md similarity index 80% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md index bf347167f..b2005c1d8 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md @@ -7,11 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to install the Application Server components on the server. Please ensure that the [Prerequisites][] have been read before starting this installation. - -## Make Installation Artefacts Available - -{{< section "/install-application-server/make-installation-artefacts-available.md">}} +This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been read before starting this installation. ## Install Microsoft .NET Framework 4.7.2 @@ -59,6 +55,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Install Web Application Server][] -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusions" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServer" >}} -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Prerequisites" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusionsNew" >}} +[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServerNew" >}} +[Pre-Installation steps for installing {{% ctx %}}]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md similarity index 91% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md index bb4ed6d5b..08f36fa8e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md @@ -9,15 +9,6 @@ weight: 40 This guide describes how to install the Web Application Server components on the server. Please ensure that [Install Application Server][] has been completed before starting this installation. -## Make Installation Artefacts Available - -1. Copy the following artefacts to a folder on the machine: - - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. - ## Install Prerequisites ### Licensing @@ -69,12 +60,12 @@ If the user tries to navigate to an address not in the SAN list, then they will {{% alert title="Important" color="warning" %}} Standard certificates, wildcard certificates, auto-generated self-signed certificates and {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="manually created self-signed certificates" >}} can be used. However, self-signed certificates are not recommended for production instances.
-It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" title="installing the Application Server" >}}; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AssignCertificateFriendlyName" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. +It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" title="installing the Application Server" >}}; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AssignCertificateFriendlyNameNew" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. {{% /alert %}} #### Import Root Certificate -{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ImportCertificateManually" title="Import Certificate Manually" >}} {{% /alert %}} +{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ImportCertificateManuallyNew" title="Import Certificate Manually" >}} {{% /alert %}} This step must be carried out prior to the installation otherwise the URL validation will fail. In order to import the Root Certificate, ensure that the file is in a known location on this server and complete the following steps: @@ -92,7 +83,7 @@ This step must be carried out prior to the installation otherwise the URL valida #### Import Certificate Manually -{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PerformInstallation" title="Perform Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AssignCertificateFriendlyName" title="assign a friendly name" >}}.{{% /alert %}} +{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PerformInstallationNew" title="Perform Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AssignCertificateFriendlyNameNew" title="assign a friendly name" >}}.{{% /alert %}} To import the certificate manually follow the below steps: @@ -145,7 +136,7 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |------------------------------------------------|-------------| @@ -220,15 +211,15 @@ Ensure that the installation files are backed up or kept on the server, especial [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.LicensingRequirements" >}} +[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServerNew" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.LicensingRequirementsNew" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md similarity index 98% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/setup-gateway.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md index 05ea8ea2f..2e4c1deb6 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md @@ -79,6 +79,6 @@ Log on to Gateway and run through the setup wizard: [Account Details]: {{< ref "#account-details" >}} [LDAP Authorisation]: {{< ref "#ldap-authorisation" >}} [LDAP Connection]: {{< ref "#ldap-connection" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServer" >}} -[supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.WebBrowserRequirements" >}} +[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServerNew" >}} +[supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.WebBrowserRequirementsNew" >}} [Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md new file mode 100644 index 000000000..dc8b320c1 --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md @@ -0,0 +1,65 @@ +--- +title: "Pre-Installation" +linkTitle: "Pre-Installation" +description: "Information about the steps required to be completed prior to starting the installation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. + +## Obtain a {{% ctx %}} licence file + +A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. + +To get a licence file and feature identifier take the following steps: + +1. Copy the following template to a text file: + + ```text + Web Application/Application Server + MachineID: + Fingerprint: + + Please also include a suitable {{% ctx %}} feature identifier. + ``` + +1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. +1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the server. +1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: + + ```text + MachineID: SERVER + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` + +1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. +1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. +1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. + +## Make Installation Artefacts Available for Application Install + +{{< section "/install-application-server/make-installation-artefacts-available.md">}} + +## Make Installation Artefacts Available for Web Application Install + +1. Copy the following artefacts to a folder on the machine: + + * Cortex Innovation {{< version >}} - Gateway.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + +1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. + +## Generate Encryption Key + +{{< section "/prerequisites/install-innovation-only/single-server/encryption-requirements.md">}} + +## Next Steps? + +1. [Installation][] + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Installation" >}} +[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md similarity index 79% rename from content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites.md rename to content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md index 8a53074c8..295bc2da9 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md @@ -1,13 +1,13 @@ --- -title: "Prerequisites" -linkTitle: "Prerequisites" -description: "Information about the prerequisites required on each server type for installation." +title: "Requirements" +linkTitle: "Requirements" +description: "Information about the requirements required on each server type for installation." weight: 20 --- # {{% param title %}} -The prerequisites required for a single server (as described in [Architecture][]) are laid out in this guide. These must be considered before undertaking installation. +The requirements for a single server (as described in [Architecture][]) are laid out in this guide. These must be considered before undertaking installation. ## Hardware Requirements @@ -57,32 +57,9 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. +A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. -To get a licence file and feature identifier take the following steps: - -1. Copy the following template to a text file: - - ```text - Web Application/Application Server - MachineID: - Fingerprint: - - Please also include a suitable {{% ctx %}} Innovation feature identifier. - ``` - -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: SERVER - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - -1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. -1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. -1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. +Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. ## Web Browser Requirements @@ -195,7 +172,7 @@ If the user tries to navigate to an address not in the SAN list, then they will {{% alert title="Important" color="warning" %}} Standard certificates, wildcard certificates, auto-generated self-signed certificates and {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="manually created self-signed certificates" >}} can be used. However, self-signed certificates are not recommended for production instances.
-It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScript" title="installing the Application Server" >}}; If doing so, you should set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}} step to prevent overwriting. +It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" title="installing the Application Server" >}}; If doing so, you should set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} step to prevent overwriting. {{% /alert %}} More information about importing the certificate is given during installation. @@ -211,22 +188,26 @@ See [SSL Best Practices][] for a full list of the security changes which will be ### Encryption Requirements -{{< section "/prerequisites/install-innovation-only/single-server/encryption-requirements.md">}} +Certain sensitive parameters required during installation (e.g. passwords) must be encrypted; other potentially sensitive parameters (e.g. usernames) can be encrypted using the [{{% ctx %}} Encryptor][CORTEX Encrypted] PowerShell module, which uses AES256. Details of whether a parameter must or should be encrypted are specified during the installation steps. + +Before encrypting parameters, it is required to generate a private key that will be used by the [{{% ctx %}} Encryptor][CORTEX Encrypted] PowerShell module. Details on how to do this are provided during the [Pre-Installation][generate encryption key] steps. ## Next Steps? -1. [Install Application Server][] +1. [Pre-Installation][] [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Architecture" >}} [C++ Redistributable]: {{< url path="MSDownload.CPlusPlusRedistributable.2013" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Create Self-Signed Certificates]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" >}} +[generate encryption key]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.GenerateEncryptionKey" >}} [IIS URL Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} -[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} +[Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} +[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}} [Microsoft Server 2022]: {{< url path="MSEval.WindowsServer.2022" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[obtain licence file]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ObtainLicence" >}} [Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Web Deploy]: {{< url path="MSDownload.WebDeploy" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md index 90fe675a9..9e093d657 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md @@ -57,7 +57,7 @@ Test the platform by creating a new flow and executing it using the following st 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. 1. {{% ctx %}} Innovation has now been verified and is ready to use. -[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGatewayNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Troubleshooting Flow No Blocks]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNoBlocks" >}} [Troubleshooting Flow Not Starting]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNotStarting" >}} diff --git a/data/urls.toml b/data/urls.toml index a08cd3f1c..5521dbb6e 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -234,94 +234,106 @@ SSLBestPractices = "/docs/getting-started/on-premise/install-innovation-only/advanced/ssl-best-practices" [Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA] MainDoc = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/" + AltLoadBalancer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#alternative-load-balancer-requirements" + AltLoadBalancerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#alternative-load-balancer-requirements" + AntivirusExclusions = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#antivirus-exclusions" + AntivirusExclusionsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#antivirus-exclusions" Architecture = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/architecture" - MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" - InstallApplicationAndLoadBalancerServers = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers" - ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" - ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" - ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" - ConfigureFlowDebuggerInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation/#configure-installation-script" - RunInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#run-installation-script" - InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server" AssignCertificateFriendlyName = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#assign-certificate-friendly-name" AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + AssignCertificateFriendlyNameNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + CertificateRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#certificate-requirements" + CertificateRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#certificate-requirements" + ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" + ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers#configure-installation-script" + DebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" + DebuggerInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation" + EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#encryption-requirements" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#encryption-requirements" + GatewayInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" + GatewayInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation" + GenerateEncryptionKey = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#generate-encryption-key" GetGatewayAppPoolUser = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" + GetGatewayAppPoolUserNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" ImportCertificateManually = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#import-certificate-manually" ImportCertificateManuallyNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#import-certificate-manually" + ImportCertificateManuallyNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#import-certificate-manually" ImportRootCertificate = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#import-root-certificate" + ImportRootCertificateNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#import-root-certificate" + InstallApplicationAndLoadBalancerServers = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers" + InstallApplicationAndLoadBalancerServersNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers" + Installation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation" InstallGateway = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#install-gateway" - PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" + InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server" + InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server" + LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" + LicensingRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#licensing-requirements" + MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" + MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available-on-application-servers" + ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" PerformDebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-debugger-installation" - DebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" - GatewayInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" + PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" + PreInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation" Prerequisites = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites" - AltLoadBalancer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#alternative-load-balancer-requirements" - CertificateRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#certificate-requirements" - WebApplicationServerPrerequisites = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites" - WebBrowserRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#web-browser-requirements" - AntivirusExclusions = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#antivirus-exclusions" - LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" - EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#encryption-requirements" + Requirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements" SetupGateway = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway" + SetupGatewayNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway" TryItOut = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out" TryItOutPublishedFlow = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out/#test-publishing-production-flows" - MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available-on-application-servers" - ConfigureCortexGatewayInstallationScriptNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" - ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers#configure-installation-script" - InstallApplicationAndLoadBalancerServersNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers" - Installation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation" - InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server" - AssignCertificateFriendlyNameNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#assign-certificate-friendly-name" - GetGatewayAppPoolUserNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" - ImportCertificateManuallyNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#import-certificate-manually" - ImportRootCertificateNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#import-root-certificate" - DebuggerInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation" - GatewayInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation" - PreInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation" - ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" - GenerateEncryptionKey = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#generate-encryption-key" - Requirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements" - AltLoadBalancerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#alternative-load-balancer-requirements" - CertificateRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#certificate-requirements" + WebApplicationServerPrerequisites = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites" WebApplicationServerPrerequisitesNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/prerequisites" + WebBrowserRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#web-browser-requirements" WebBrowserRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#web-browser-requirements" - AntivirusExclusionsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#antivirus-exclusions" - LicensingRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#licensing-requirements" - EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#encryption-requirements" - SetupGatewayNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway" - TryItOutNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out" - TryItOutPublishedFlowNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/try-it-out/#test-publishing-production-flows" - [Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA] MainDoc = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/" + AntivirusExclusions = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#antivirus-exclusions" + AntivirusExclusionsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#antivirus-exclusions" Architecture = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/architecture" - InstallApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server" - ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server#configure-installation-script" - ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#configure-cortex-gateway-installation-script" - RunInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server#run-installation-script" - InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server" AssignCertificateFriendlyName = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#assign-certificate-friendly-name" + AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server/#assign-certificate-friendly-name" + CertificateRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#certificate-requirements" + CertificateRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#certificate-requirements" + ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server#configure-installation-script" + ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server#configure-installation-script" + EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#encryption-requirements" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#encryption-requirements" + GenerateEncryptionKey = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation#generate-encryption-key" ImportCertificateManually = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#import-certificate-manually" + ImportCertificateManuallyNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server/#import-certificate-manually" + InstallApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server" + InstallApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server" + Installation = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation" InstallGateway = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#install-gateway" + InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server" + InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server" + LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#licensing-requirements" + LicensingRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#licensing-requirements" + ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation#obtain-a-cortex-licence-file" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#perform-installation" + PerformInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server/#perform-installation" + PreInstallation = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation" Prerequisites = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites" - CertificateRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#certificate-requirements" - WebBrowserRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#web-browser-requirements" - LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#licensing-requirements" - EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#encryption-requirements" + Requirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements" SetupGateway = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/setup-gateway" + SetupGatewayNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway" TryItOut= "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out" TryItOutPublishedFlow= "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out/#test-publishing-production-flows" - AntivirusExclusions = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#antivirus-exclusions" - [Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Advanced] - AdvancedConfig = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/advanced-config-changes" - AlternativeArchitectures = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/alternative-architectures" - ApplyTDE = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/tde" - ConfigureFirewalls = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/configure-firewalls" - CreateSelfSignedCertificates = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/self-signed-certificates" - EncryptText = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/encrypt-text" - PortRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/port-requirements" - SSLBestPractices = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/ssl-best-practices" + WebBrowserRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#web-browser-requirements" + WebBrowserRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#web-browser-requirements" + [Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Advanced] + AdvancedConfig = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/advanced-config-changes" + AlternativeArchitectures = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/alternative-architectures" + ApplyTDE = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/tde" + ConfigureFirewalls = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/configure-firewalls" + CreateSelfSignedCertificates = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/self-signed-certificates" + EncryptText = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/encrypt-text" + PortRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/port-requirements" + SSLBestPractices = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/ssl-best-practices" [Cortex.GettingStarted.OnPremise.AddInnovationTo72] MainDoc = "/docs/getting-started/on-premise/add-innovation-to-72/" From cd47693b6654fe22bf2046eaaa27041d04882a58 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 18 Dec 2024 14:29:02 +0000 Subject: [PATCH 03/19] Modified structure for adding to 7.2 for multi server and removed some references to Innovation in naming for consistency --- .../assign-certificate-friendly-name.md | 2 +- .../configure-debugger-installation-script.md | 8 +- .../add-innovation-to-7.2/licensing.md | 2 +- .../on-premise/add-innovation-to-72/_index.md | 8 +- .../multiple-server-with-ha/_index.md | 2 +- .../multiple-server-with-ha/architecture.md | 8 +- .../installation/_index.md | 10 +++ ...ll-application-and-loadbalancer-servers.md | 29 +++---- .../install-web-application-server/_index.md | 2 +- .../perform-debugger-installation.md | 6 +- .../perform-gateway-installation.md | 12 +-- .../prerequisites.md | 15 +--- .../pre-installation.md | 87 +++++++++++++++++++ .../{prerequisites.md => requirements.md} | 70 +++------------ .../multiple-server-with-ha/try-it-out.md | 4 +- .../single-server-without-ha/_index.md | 2 +- .../single-server-without-ha/architecture.md | 2 +- .../install-web-application-server.md | 2 +- .../single-server-without-ha/prerequisites.md | 8 +- .../single-server-without-ha/try-it-out.md | 4 +- .../advanced/_index.md | 2 +- .../advanced/advanced-config-changes.md | 2 +- .../advanced/port-requirements.md | 6 +- .../installation/_index.md | 2 +- ...ll-application-and-loadbalancer-servers.md | 2 +- .../perform-gateway-installation.md | 2 +- .../installation/setup-gateway.md | 2 +- .../pre-installation.md | 4 +- .../multiple-server-with-ha/requirements.md | 4 +- .../multiple-server-with-ha/try-it-out.md | 4 +- .../installation/_index.md | 2 +- .../install-application-server.md | 2 +- .../install-web-application-server.md | 2 +- .../installation/setup-gateway.md | 4 +- .../single-server-without-ha/requirements.md | 4 +- .../single-server-without-ha/try-it-out.md | 4 +- data/urls.toml | 50 +++++++---- 37 files changed, 215 insertions(+), 166 deletions(-) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{ => installation}/install-application-and-loadbalancer-servers.md (96%) rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{ => installation}/install-web-application-server/_index.md (92%) rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{ => installation}/install-web-application-server/perform-debugger-installation.md (95%) rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{ => installation}/install-web-application-server/perform-gateway-installation.md (96%) rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{ => installation}/install-web-application-server/prerequisites.md (87%) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{prerequisites.md => requirements.md} (84%) diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md index e39dc70a4..961c8cb4f 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md @@ -8,4 +8,4 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi 1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. 1. Click `OK`. -[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index 76ed8a84e..84f189475 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| @@ -72,7 +72,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. Save and close `Cortex.Innovation.Install.ps1`. -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirementsNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md index 34a467ecc..4d351fe05 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md @@ -1,3 +1,3 @@ Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirements" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirementsNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md index 19d0dbf9d..183733f62 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md @@ -1,10 +1,10 @@ --- -title: "Add Innovation to a 7.2 Installation" -linkTitle: "Add Innovation to a 7.2 Installation" -description: "Information about adding {{% ctx %}} Innovation to an existing {{% ctx %}} 7.2 platform." +title: "Add CORTEX to a 7.2 Installation" +linkTitle: "Add CORTEX to a 7.2 Installation" +description: "Information about adding {{% ctx %}} to an existing {{% ctx %}} 7.2 platform." weight: 20 --- {{% pageinfo %}} -{{% ctx %}} Innovation can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. +{{% ctx %}} can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. {{% /pageinfo %}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md index b37f4309c..f31653e77 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Multiple Server - With HA (Recommended)" linkTitle: "Multiple Server - With HA" -description: "Information about adding {{% ctx %}} Innovation to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, prerequisites and installation instructions." +description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md index 8f5e24f2e..fdf024dcf 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md @@ -17,7 +17,7 @@ weight: 10 ## Possible Architectures -{{% ctx %}} Innovation and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a v7.2 installation and the only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. +{{% ctx %}} and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a v7.2 installation and the only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. ### Recommended Architecture @@ -34,8 +34,8 @@ The recommended architecture for adding Innovation to a v7.2 Dual Site, Dual Ser ## Next Steps? -1. [Prerequisites][] +1. [Requirements][] -[Hardware Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.HardwareRequirements" >}} -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Prerequisites" >}} +[Hardware Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.HardwareRequirementsNew" >}} [Recommended]: {{< ref "#recommended-architecture" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md new file mode 100644 index 000000000..612bf580a --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Installation" +linkTitle: "Installation" +description: "Installation instructions to add {{% ctx %}} to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA)." +weight: 40 +--- + +This guide describes how to add {{% ctx %}} to an existing {{% ctx %}} 7.2 platform. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. + +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md similarity index 96% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 95a70cf70..fecfad556 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -7,16 +7,7 @@ weight: 30 # {{< param title >}} -This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that [Prerequisites for adding Innovation to v7.2][] have been read before starting this installation. - -## Make Installation Artefacts Available - -1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - Block Packages.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for adding {{% ctx %}} to 7.2][] have been completed before starting this installation. ## Install Microsoft .NET Framework 4.7.2 @@ -216,7 +207,7 @@ To check all necessary ports are free, follow these steps: {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| @@ -319,17 +310,17 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. [Upgrade the Web Application Server][] -[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AltLoadBalancer" >}} -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScript" >}} +[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AltLoadBalancerNew" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusionsNew" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirementsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} -[Prerequisites for adding Innovation to v7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Prerequisites" >}} +[Pre-Installation steps for adding {{% ctx %}} to 7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} -[Upgrade the Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServer" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[Upgrade the Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServerNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/_index.md similarity index 92% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/_index.md index de8fd65f8..dcebd1816 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/_index.md @@ -7,4 +7,4 @@ weight: 40 This guide describes how to upgrade the v7.2 Web Application Server to Include Innovation. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServersNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md similarity index 95% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index dbbcf7358..a7ebdd1a3 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -55,6 +55,6 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Upgrade Gateway][] -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallation" >}} -[web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusionsNew" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallationNew" >}} +[web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.WebApplicationServerPrerequisitesNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md similarity index 96% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index 01307b5d3..3789b0a93 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -44,7 +44,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| @@ -112,13 +112,13 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov 1. [Try it out][] -[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} +[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AssignCertificateFriendlyNameNew2" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScript" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirements" >}} +[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallationNew" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirementsNew" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md similarity index 87% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md index 86643f086..7ab0af191 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/prerequisites.md @@ -9,14 +9,6 @@ weight: 10 Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. -## Make Installation Artefacts Available - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} - ## Licensing {{< section "/install-web-application-server/add-innovation-to-7.2/licensing.md">}} @@ -51,6 +43,7 @@ The Flow Debugger also requires an X.509 SSL certificate to be installed on the 1. [Install Flow Debugger][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} -[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[gobetween]: {{< url path="GoBetween.MainDoc" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServersNew" >}} +[Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallationNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md new file mode 100644 index 000000000..7736cdf58 --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md @@ -0,0 +1,87 @@ +--- +title: "Pre-Installation" +linkTitle: "Pre-Installation" +description: "Information about the steps required to be completed prior to starting the installation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. + +## Obtain a {{% ctx %}} licence file + +A valid {{% ctx %}} licence file and {{% ctx %}} with v7.2 feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. + +To get a licence file and feature identifier take the following steps: + +1. Copy the following template to a text file: + + ```text + Web Application Server + MachineID: + Fingerprint: + + Application Server 1 + MachineID: + Fingerprint: + + Application Server 2 + MachineID: + Fingerprint: + + Application Server 3 + MachineID: + Fingerprint: + + Please also include a suitable {{% ctx %}} with v7.2 feature identifier. + ``` + +1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. +1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the Web Application server. +1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: + + ```text + MachineID: WEBAPP-SERVER + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` + +1. Copy the output (machine identifier and fingerprint) to the `Web Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. +1. For each Application Server take the following steps: + 1. Copy `Cortex.Licensing.FingerprintGeneration.exe` to the Application server. + 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: + + ```text + MachineID: APP-SERVER1 + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` + + 1. Copy the output (machine identifier and fingerprint) to one of the `Application Server` sections of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. +1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. +1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. + +## Make Installation Artefacts Available on Application Servers + +1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - App Services.zip + * Cortex Innovation {{< version >}} - Block Packages.zip + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. + +## Make Installation Artefacts Available on Web Application Server + +{{% alert title="Note" %}} +We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. +{{% /alert %}} + +{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} + +## Next Steps? + +1. [Installation][] + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Installation" >}} +[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md similarity index 84% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md index dec2805bf..9f9645a96 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md @@ -1,13 +1,13 @@ --- -title: "Prerequisites" -linkTitle: "Prerequisites" -description: "Information about the prerequisites required on each server type for installation." +title: "Requirements" +linkTitle: "Requirements" +description: "Information about the requirements for each server type for installation." weight: 20 --- # {{< param title >}} -The prerequisites required for each server role (as described in [Architecture][]) are laid out in this guide. These must be considered before undertaking installation. +The requirements for each server role (as described in [Architecture][]) are laid out in this guide. These must be considered before undertaking installation. {{% alert title="Note" %}} All server roles (e.g. Load Balancer, Application Server, Web Application Server) referenced in the rest of this guide will refer to Innovation server roles unless otherwise stated. @@ -15,7 +15,6 @@ All server roles (e.g. Load Balancer, Application Server, Web Application Server ## Hardware Requirements - | Server Role | Servers Required | CPU Cores (> 2GHz) | RAM (GB) | Disk (GB) | |------------------|-----------------------|-----------------------------------|---------------|----------------------| | New Innovation Load Balancer | 1[^1] | 4+ *Recommended*
2 *Minimum* | 8+ *Recommended*
4 *Minimum* | 50+ *Recommended*
30 *Minimum*
5+ free on installation drive | @@ -86,54 +85,9 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} Innovation with v7.2 feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. - -To get a licence file and feature identifier take the following steps: - -1. Copy the following template to a text file: - - ```text - Web Application Server - MachineID: - Fingerprint: - - Application Server 1 - MachineID: - Fingerprint: - - Application Server 2 - MachineID: - Fingerprint: - - Application Server 3 - MachineID: - Fingerprint: - - Please also include a suitable {{% ctx %}} Innovation with v7.2 feature identifier. - ``` - -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the Web Application server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: WEBAPP-SERVER - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - -1. Copy the output (machine identifier and fingerprint) to the `Web Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. -1. For each Application Server take the following steps: - 1. Copy `Cortex.Licensing.FingerprintGeneration.exe` to the Application server. - 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: APP-SERVER1 - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` +A valid {{% ctx %}} licence file and {{% ctx %}} with v7.2 feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. - 1. Copy the output (machine identifier and fingerprint) to one of the `Application Server` sections of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. -1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. -1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. +Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. ## Ensure correct owner of {{% ctx %}} Gateway Repo and Website folders @@ -205,7 +159,7 @@ On the Web Application Server and each Application Server, the following Windows ### Installation User -On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} Innovation is built upon. +On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} is built upon. ### Antivirus Exclusions @@ -245,7 +199,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. +{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. @@ -333,22 +287,24 @@ Innovation has a [gobetween][] load balancer included that isn't highly availabl ## Next Steps? -1. [Install Application Servers and Load Balancer][] +1. [Pre-Installation][] [alternative load balancer]: {{< ref "#alternative-load-balancer-requirements" >}} [Anycast]: {{< url path="Anycast.MainDoc" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Architecture" >}} [C++ Redistributable]: {{< url path="MSDownload.CPlusPlusRedistributable.2013" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Create Full DB Backup]: {{< url path="MSDocs.SqlServer.CreateFullDbBackup" >}} [gobetween]: {{< url path="GoBetween.MainDoc" >}} [IIS Url Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} [Microsoft Server 2016]: {{< url path="MSEval.WindowsServer.2016" >}} [Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[obtain licence file]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ObtainLicence" >}} [Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} [Recommended Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.RecommendedArchitecture" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} [web application server]: {{< ref "#web-application-server" >}} [Web Deploy]: {{< url path="MSDownload.WebDeploy" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md index 0c19737cd..836057376 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} Innovation for the first time." +description: "Information about trying out {{% ctx %}} for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} Innovation has now been verified and is ready to use. +1. {{% ctx %}} has now been verified and is ready to use. [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Troubleshooting Flow No Blocks]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNoBlocks" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md index 24d0635d4..237025bf6 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Information about adding {{% ctx %}} Innovation to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA), including: information about components, supported architectures, prerequisites and installation instructions." +description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA), including: information about components, supported architectures, prerequisites and installation instructions." weight: 10000 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md index 62d3305f8..0ffd72232 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md @@ -13,7 +13,7 @@ weight: 10 ## Single Server Architecture -{{% ctx %}} Innovation and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a {{% ctx %}} v7.2 installation by using the existing hardware. The only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. +{{% ctx %}} and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a {{% ctx %}} v7.2 installation by using the existing hardware. The only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. The minimum architecture for adding Innovation to a v7.2 Single Site, Single Server system is as follows: diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md index 4d86fba50..224304430 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md @@ -108,7 +108,7 @@ A Friendly Name should be assigned to the certificate being used for the Cortex | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will overwrite the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will overwrite the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md index b17cb57a5..b868217e7 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md @@ -76,7 +76,7 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. +A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. To get a licence file and feature identifier take the following steps: @@ -87,7 +87,7 @@ To get a licence file and feature identifier take the following steps: MachineID: Fingerprint: - Please also include a suitable {{% ctx %}} Innovation feature identifier. + Please also include a suitable {{% ctx %}} with v7.2 feature identifier. ``` 1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. @@ -160,7 +160,7 @@ The following Windows Services must be running on the server: ### Installation User -A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} Innovation is built upon. +A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} is built upon. ### Antivirus Exclusions @@ -193,7 +193,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. +{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md index fe7368ff4..a09c21c82 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} Innovation for the first time." +description: "Information about trying out {{% ctx %}} for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the server you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} Innovation has now been verified and is ready to use. +1. {{% ctx %}} has now been verified and is ready to use. [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Troubleshooting Flow Not Starting]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNotStarting" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md index f42adde16..6492d86a9 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md @@ -1,6 +1,6 @@ --- title: "Advanced Setup" linkTitle: "Advanced Setup" -description: "Supporting information about installing {{% ctx %}} Innovation with non-default configurations." +description: "Supporting information about installing {{% ctx %}} with non-default configurations." weight: 90 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md index 5c264f3f0..09b1da8d8 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md @@ -1,7 +1,7 @@ --- title: "Advanced Application Server and Load Balancer Configuration Changes" linkTitle: "Advanced Application Server and Load Balancer Configuration Changes" -description: "Information about installing {{% ctx %}} Innovation with non-default installation values." +description: "Information about installing {{% ctx %}} with non-default installation values." --- # {{% param title %}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md index d9c2084ab..1e6d3301a 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md @@ -1,14 +1,14 @@ --- title: "Port Requirements for Application Servers and Load Balancer" linkTitle: "Port Requirements for Application Servers and Load Balancer" -description: "Information about the ports opened when installing {{% ctx %}} Innovation." +description: "Information about the ports opened when installing {{% ctx %}}." --- # {{% param title %}} -{{% ctx %}} Innovation and Microsoft Service Fabric open a range of firewall ports between the servers and specific services. Some of them are opened during installation, others are opened dynamically as needed. These are opened on Windows Firewall. If any other firewall exists between the servers, it will be necessary to configure this selection of rules on it. Most ports may be altered if another program overlaps with them, the description will say if this is not possible. +{{% ctx %}} and Microsoft Service Fabric open a range of firewall ports between the servers and specific services. Some of them are opened during installation, others are opened dynamically as needed. These are opened on Windows Firewall. If any other firewall exists between the servers, it will be necessary to configure this selection of rules on it. Most ports may be altered if another program overlaps with them, the description will say if this is not possible. -## {{% ctx %}} Innovation Ports +## {{% ctx %}} Ports | Name | Description | Default Port(s) | Protocol | Direction | |------|-------------|-----------------|----------|-----------| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md index 455a8cd2e..78a2ea1a0 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md @@ -7,4 +7,4 @@ weight: 40 This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. -[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 4e6f6daae..aa44a471c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been read before starting this installation. +This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been completed before starting this installation. ## Install Microsoft .NET Framework 4.7.2 diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index 512da1c69..6ca904d8e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -50,7 +50,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md index cbf5e6675..c44cf9869 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md @@ -57,7 +57,7 @@ Log on to Gateway and run through the setup wizard: 1. Assign access permissions to Active Directory groups: To allow users to access the various roles within Gateway, it is first necessary to assign them the appropriate access rights. - Gateway currently supports four roles, but only two are relevant for {{% ctx %}} Innovation: + Gateway currently supports four roles, but only two are relevant for {{% ctx %}}: * Admin * Studio diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md index eab571aaa..15f6e827e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md @@ -11,7 +11,7 @@ This guide describes how to perform the steps required before starting the insta ## Obtain a {{% ctx %}} licence file -A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. +A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. To get a licence file and feature identifier take the following steps: @@ -34,7 +34,7 @@ To get a licence file and feature identifier take the following steps: MachineID: Fingerprint: - Please also include a suitable {{% ctx %}} Innovation feature identifier. + Please also include a suitable {{% ctx %}} feature identifier. ``` 1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md index 5cc0e2b4e..c51a79970 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md @@ -104,7 +104,7 @@ On the Web Application Server and each Application Server, the following Windows ### Installation User -On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} Innovation is built upon. +On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} is built upon. ### IIS Application Pool User @@ -148,7 +148,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. +{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md index 2a6a8be40..c777a4e8c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} Innovation for the first time." +description: "Information about trying out {{% ctx %}} for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} Innovation has now been verified and is ready to use. +1. {{% ctx %}} has now been verified and is ready to use. [Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md index 57a519520..fa9d41676 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md @@ -7,4 +7,4 @@ weight: 40 This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. -[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md index b2005c1d8..ef7e67214 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been read before starting this installation. +This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been completed before starting this installation. ## Install Microsoft .NET Framework 4.7.2 diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md index 08f36fa8e..7584da208 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md @@ -141,7 +141,7 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the {{% ctx %}} Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md index 2e4c1deb6..a0b5777ce 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md @@ -51,13 +51,13 @@ Log on to Gateway and run through the setup wizard: {{< figure class="centre" src="/images/Gateway Setup4.png" title="LDAP Connection Screen" >}} - ### LDAP Authorisation + ### LDAP Authorisation 1. If the authorisation grid fails to load first time round, click `Retry`. 1. Assign access permissions to Active Directory groups: To allow users to access the various roles within Gateway, it is first necessary to assign them the appropriate access rights. - Gateway currently supports four roles, but only two are relevant for {{% ctx %}} Innovation: + Gateway currently supports four roles, but only two are relevant for {{% ctx %}}: * Admin * Studio diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md index 295bc2da9..706a41aa5 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md @@ -85,7 +85,7 @@ The following Windows Services must be running on the server: ### Installation User -A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} Innovation is built upon. +A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} is built upon. ### IIS Application Pool User @@ -122,7 +122,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. +{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md index 9e093d657..197626d07 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} Innovation for the first time." +description: "Information about trying out {{% ctx %}} for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the server you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} Innovation has now been verified and is ready to use. +1. {{% ctx %}} has now been verified and is ready to use. [Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGatewayNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} diff --git a/data/urls.toml b/data/urls.toml index 5521dbb6e..8e279adc5 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -336,37 +336,49 @@ SSLBestPractices = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/advanced/ssl-best-practices" [Cortex.GettingStarted.OnPremise.AddInnovationTo72] MainDoc = "/docs/getting-started/on-premise/add-innovation-to-72/" - [Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA] MainDoc = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/" - Architecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture" - RecommendedArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#recommended-architecture" - MinimumArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#minimum-architecture" + AddInnovationTo72WebApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server" + AddInnovationTo72WebApplicationServerNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server" AlternativeArchitectures = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#alternative-architectures" AltLoadBalancer = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#alternative-load-balancer-requirements" - InstallApplicationAndLoadBalancerServers = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers" - InstallWebApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server" + AltLoadBalancerNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#alternative-load-balancer-requirements" + AntivirusExclusions = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#antivirus-exclusions" + AntivirusExclusionsNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#antivirus-exclusions" + Architecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture" + AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + AssignCertificateFriendlyNameNew2 = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + CertificateRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#certificate-requirements" + CertificateRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#certificate-requirements" ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew2 = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" ConfigureInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" + ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers#configure-installation-script" DebuggerInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" - GatewayInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" - GetGatewayAppPoolUser = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" - RunInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers#run-installation-script" - AddInnovationTo72WebApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server" - UpgradeGateway = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#upgrade-gateway" - PerformInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#perform-installation" - Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites" - CertificateRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#certificate-requirements" - WebBrowserRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#web-browser-requirements" - LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#licensing-requirements" + DebuggerInstallationNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation" EncryptionRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#encryption-requirements" - TryItOut= "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out" - AntivirusExclusions = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#antivirus-exclusions" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#encryption-requirements" + GatewayInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" + GatewayInstallationNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation" HardwareRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#hardware-requirements" + HardwareRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#hardware-requirements" HardwareRequirementsAlternativeArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#alternative-architectures" - AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + InstallApplicationAndLoadBalancerServers = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers" + InstallApplicationAndLoadBalancerServersNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers" + Installation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation" + LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#licensing-requirements" + LicensingRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#licensing-requirements" + MinimumArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#minimum-architecture" + ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" + PreInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation" + Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites" + RecommendedArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#recommended-architecture" + Requirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements" + TryItOut= "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out" + UpgradeGateway = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#upgrade-gateway" WebApplicationServerPrerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites" + WebApplicationServerPrerequisitesNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/prerequisites" [Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA] MainDoc = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/" Architecture = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture" From bdeb8f645e959e1246cff5538d102e138b30bee8 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 23 Dec 2024 12:17:53 +0000 Subject: [PATCH 04/19] Restructured documentation for adding cortex to 7.2 --- .../configure-installation-script.md | 6 +- .../multiple-server-with-ha/requirements.md | 2 +- .../single-server-without-ha/_index.md | 2 +- .../single-server-without-ha/architecture.md | 10 +-- .../installation/_index.md | 10 +++ .../install-application-server.md | 12 ++-- .../install-web-application-server.md | 26 ++------ .../pre-installation.md | 62 +++++++++++++++++++ .../{prerequisites.md => requirements.md} | 39 +++--------- .../single-server-without-ha/try-it-out.md | 4 +- data/urls.toml | 34 ++++++---- 11 files changed, 124 insertions(+), 83 deletions(-) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/{ => installation}/install-application-server.md (82%) rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/{ => installation}/install-web-application-server.md (94%) create mode 100644 content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md rename content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/{prerequisites.md => requirements.md} (89%) diff --git a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md index 76ff566bf..b363138ec 100644 --- a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| @@ -72,6 +72,6 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. Save and close `Cortex.Innovation.Install.ps1`. -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.CertificateRequirements" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.CertificateRequirementsNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} \ No newline at end of file +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md index 9f9645a96..b9588efab 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md @@ -81,7 +81,7 @@ Supported versions of Active Directory are listed below: ## DNS Requirements -The installation requires IP to hostname resolution to be available. Please ensure that you have the appropriate pointer (PTR) records configured on the DNS server for all of your servers (Web, Application and Load Balancer). +The installation requires IP to hostname resolution to be available. Please ensure that you have the appropriate pointer (PTR) records configured on the DNS server for all of your servers (Web, Application and Load Balancer). ## Licensing Requirements diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md index 237025bf6..50794e002 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA), including: information about components, supported architectures, prerequisites and installation instructions." +description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10000 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md index 0ffd72232..f6c5bdf20 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md @@ -1,7 +1,7 @@ --- title: "Architecture" linkTitle: "Architecture" -description: "Information about the recommended Innovation platform architecture, including component descriptions." +description: "Information about the recommended platform architecture, including component descriptions." weight: 10 --- @@ -13,9 +13,9 @@ weight: 10 ## Single Server Architecture -{{% ctx %}} and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a {{% ctx %}} v7.2 installation by using the existing hardware. The only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. +{{% ctx %}} and {{% ctx %}} 7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. {{% ctx %}} can be added to a {{% ctx %}} v7.2 installation by using the existing hardware. The only component shared by both {{% ctx %}} and {{% ctx %}} 7.2 is {{% ctx %}} Gateway. -The minimum architecture for adding Innovation to a v7.2 Single Site, Single Server system is as follows: +The minimum architecture for adding {{% ctx %}} to a v7.2 Single Site, Single Server system is as follows: {{< figure src="/images/editable/Cortex Innovation v7.2 Single Server.png" class="centre" title="1 Server Architecture Diagram" >}} @@ -25,6 +25,6 @@ The minimum architecture for adding Innovation to a v7.2 Single Site, Single Ser ## Next Steps? -1. [Prerequisites][] +1. [Requirements][] -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Prerequisites" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md new file mode 100644 index 000000000..0714dd224 --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Installation" +linkTitle: "Installation" +description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA)." +weight: 40 +--- + +This guide describes how to add {{% ctx %}} to an existing {{% ctx %}} 7.2 platform. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. + +[PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md similarity index 82% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md index e956aa8c2..cafce2f40 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md @@ -7,11 +7,7 @@ weight: 30 # {{< param title >}} -This guide describes how to install the Application Server components on the server. Please ensure that the [Prerequisites][] have been read before starting this installation. - -## Make Installation Artefacts Available - -{{< section "/install-application-server/make-installation-artefacts-available.md">}} +This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for adding {{% ctx %}} to {{% ctx %}} 7.2][] have been completed before starting the installation.. ## Install Microsoft .NET Framework 4.7.2 @@ -59,6 +55,6 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Upgrade v7.2 Gateway to Include Innovation][] -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusions" >}} -[Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Prerequisites" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusionsNew" >}} +[Pre-Installation steps for adding {{% ctx %}} to {{% ctx %}} 7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} +[Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServerNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md similarity index 94% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md index 224304430..7aaf51d82 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md @@ -1,27 +1,13 @@ --- title: "Upgrade v7.2 Gateway to Include Innovation" linkTitle: "Upgrade v7.2 Gateway to Include Innovation" -description: "Information about upgrading v7.2 Gateway with Innovation functionality." +description: "Information about upgrading a {{% ctx %}} 7.2 Gateway with {{% ctx %}} functionality." weight: 40 --- # {{< param title >}} -This guide describes how to upgrade Gateway on v7.2 to include Innovation. Please ensure that [Install Application Server][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. - -The steps to add Innovation functionality to 7.2 are: - -1. Upgrade Gateway - -## Make Installation Artefacts Available - -1. Copy the following artefacts to a folder on the machine: - - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. +This guide describes how to upgrade Gateway on {{% ctx %}} 7.2 to include {{% ctx %}}. Please ensure that [Install Application Server][] has been completed before starting this installation. These steps assume that the {{% ctx %}} 7.2 version of Gateway and its prerequisites have already been installed. ## Install Prerequisites @@ -205,11 +191,11 @@ Ensure that the installation files are backed up or kept on the server, especial [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureInstallationScript" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServer" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.LicensingRequirements" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.EncryptionRequirements" >}} +[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServerNew" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.LicensingRequirementsNew" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.EncryptionRequirementsNew" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md new file mode 100644 index 000000000..da464965e --- /dev/null +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md @@ -0,0 +1,62 @@ +--- +title: "Pre-Installation" +linkTitle: "Pre-Installation" +description: "Information about the steps required to be completed prior to starting the installation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. + +## Obtain a {{% ctx %}} licence file + +A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. + +To get a licence file and feature identifier take the following steps: + +1. Copy the following template to a text file: + + ```text + Web Application/Application Server + MachineID: + Fingerprint: + + Please also include a suitable {{% ctx %}} with v7.2 feature identifier. + ``` + +1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. +1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the server. +1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: + + ```text + MachineID: SERVER + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` + +1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. +1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. +1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. + +## Make Installation Artefacts Available on Application Servers + +{{< section "/install-application-server/make-installation-artefacts-available.md">}} + +## Make Installation Artefacts Available on Web Application Server + +1. Copy the following artefacts to a folder on the machine: + + * Cortex Innovation {{< version >}} - Block Packages.zip + * Cortex Innovation {{< version >}} - Gateway.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + +1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. + +## Next Steps? + +1. [Installation][] + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Installation" >}} +[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md similarity index 89% rename from content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md rename to content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md index b868217e7..7eb14246b 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md @@ -1,7 +1,7 @@ --- -title: "Prerequisites" -linkTitle: "Prerequisites" -description: "Information about the prerequisites required on each server type for installation." +title: "Requirements" +linkTitle: "Requirements" +description: "Information about the requirements for each server type for installation." weight: 20 --- @@ -72,36 +72,13 @@ Supported versions of Active Directory are listed below: ## DNS Requirements -The installation requires IP to hostname resolution to be available. Please ensure that you have the appropriate pointer (PTR) records configured on the DNS server for the server. +The installation requires IP to hostname resolution to be available. Please ensure that you have the appropriate pointer (PTR) records configured on the DNS server for the server. ## Licensing Requirements A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. -To get a licence file and feature identifier take the following steps: - -1. Copy the following template to a text file: - - ```text - Web Application/Application Server - MachineID: - Fingerprint: - - Please also include a suitable {{% ctx %}} with v7.2 feature identifier. - ``` - -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: SERVER - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - -1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. -1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. -1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. +Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. ## Ensure correct owner of {{% ctx %}} Gateway Repo and Website folders @@ -251,11 +228,13 @@ See [SSL Best Practices][] for a full list of the security changes which will be [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Create Full DB Backup]: {{< url path="MSDocs.SqlServer.CreateFullDbBackup" >}} [IIS URL Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServer" >}} +[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServerNew" >}} [Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}} [Microsoft Server 2016]: {{< url path="MSEval.WindowsServer.2016" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[obtain licence file]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ObtainLicence" >}} [Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} +[Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} +[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Web Deploy]: {{< url path="MSDownload.WebDeploy" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md index a09c21c82..2b07a9e0a 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md @@ -7,7 +7,7 @@ weight: 60 # {{< param title >}} -This guide describes how to try out a new Innovation installation to make sure it is working. Please ensure that the [Gateway Upgrade][] has been completed before taking these steps. +This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that the [Gateway Upgrade][] has been completed before taking these steps. ## Test Debugging Flows @@ -63,4 +63,4 @@ Test the platform by creating a new flow and executing it using the following st [Troubleshooting No Innovation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoInnovation" >}} [Troubleshooting No Publish]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoPublish" >}} [Troubleshooting Root Certificate Error]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoRootCertificate" >}} -[Gateway Upgrade]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} +[Gateway Upgrade]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServerNew" >}} diff --git a/data/urls.toml b/data/urls.toml index 8e279adc5..c5d0310ad 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -381,22 +381,30 @@ WebApplicationServerPrerequisitesNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/prerequisites" [Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA] MainDoc = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/" - Architecture = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture" - InstallApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server" - ConfigureInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server#configure-installation-script" - ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server/#configure-cortex-gateway-installation-script" - RunInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server#run-installation-script" AddInnovationTo72WebApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server" - UpgradeGateway = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server/#upgrade-gateway" - PerformInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server/#perform-installation" - Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites" + AddInnovationTo72WebApplicationServerNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server" + AntivirusExclusions = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#antivirus-exclusions" + AntivirusExclusionsNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements#antivirus-exclusions" + Architecture = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture" CertificateRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#certificate-requirements" - WebBrowserRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#web-browser-requirements" - LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#licensing-requirements" + CertificateRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements#certificate-requirements" + ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server#configure-installation-script" + ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server#configure-installation-script" EncryptionRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#encryption-requirements" - TryItOut= "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out" - AntivirusExclusions = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#antivirus-exclusions" - HardwareRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#hardware-requirements" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements#encryption-requirements" + InstallApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server" + InstallApplicationServerNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server" + Installation = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation" + LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#licensing-requirements" + LicensingRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements#licensing-requirements" + ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation#obtain-a-cortex-licence-file" + PreInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation" + Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites" + Requirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements" + TryItOut = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out" + UpgradeGateway = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server/#upgrade-gateway" [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation] MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/" [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana] From aa226aa5abe2eeedc9fa1fdee2eb43e9efd5a8f2 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 16 Jan 2025 15:53:31 +0000 Subject: [PATCH 05/19] Made changes to include new script for making artefacts available --- .../configure-installation-script.md | 2 +- .../configure-debugger-installation-script.md | 2 +- .../add-innovation-only/licensing.md | 4 +- .../add-innovation-to-7.2/licensing.md | 4 +- .../multi-server/make-artefacts-available.md | 31 ++++++++++++ .../single-server/make-artefacts-available.md | 29 +++++++++++ .../multi-server/encryption-requirements.md | 3 +- .../perform-gateway-installation.md | 4 +- .../pre-installation.md | 47 +++++------------- .../install-web-application-server.md | 6 +-- .../advanced/encrypt-text.md | 10 ++-- ...ll-application-and-loadbalancer-servers.md | 2 +- .../perform-gateway-installation.md | 6 +-- .../pre-installation.md | 48 +++++-------------- .../install-web-application-server.md | 8 ++-- .../pre-installation.md | 25 ++++------ data/urls.toml | 8 +--- 17 files changed, 119 insertions(+), 120 deletions(-) create mode 100644 content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md create mode 100644 content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md diff --git a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md index fe910d640..464c5dbae 100644 --- a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Generate Encryption Key" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index 892811726..bec61bc74 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Generate Encryption Key" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md index d4a6a77e4..a217589be 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-only/licensing.md @@ -1,3 +1,3 @@ -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. +Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Obtain a {{% ctx %}} licence file][]. -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirementsNew" >}} +[Obtain a {{% ctx %}} licence file]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ObtainLicence" >}} diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md index 4d351fe05..e0e98879f 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md @@ -1,3 +1,3 @@ -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. +Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Obtain a {{% ctx %}} licence file][]. -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirementsNew" >}} +[Obtain a {{% ctx %}} licence file]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ObtainLicence" >}} diff --git a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md new file mode 100644 index 000000000..9a66c66f7 --- /dev/null +++ b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md @@ -0,0 +1,31 @@ +1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - App Services.zip + * Cortex Innovation {{< version >}} - Block Packages.zip + * Cortex Innovation {{< version >}} - Encryption Key Generator.zip + * Cortex Innovation {{< version >}} - Encryptor.zip + * Cortex Innovation {{< version >}} - Gateway.zip + * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers, the `WebApplicationServer` value to contain the NETBIOS names or fully qualified domain name of the Web Application Server and the `LoadBalancerServer` value to contain the NETBIOS names or fully qualified domain name of the Load Balancer Server (remove the `LoadBalancerServer` parameter if using an [alternative load balancer][]): + + ```powershell + .\Cortex.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server" -LoadBalancerServer "lb-server" + ``` + +[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancerNew" >}} diff --git a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md new file mode 100644 index 000000000..8987ae930 --- /dev/null +++ b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md @@ -0,0 +1,29 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - App Services.zip + * Cortex Innovation {{< version >}} - Block Packages.zip + * Cortex Innovation {{< version >}} - Encryption Key Generator.zip + * Cortex Innovation {{< version >}} - Encryptor.zip + * Cortex Innovation {{< version >}} - Gateway.zip + * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS names or fully qualified domain names of the Server: + + ```powershell + .\Cortex.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" + ``` diff --git a/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md b/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md index a64feafdb..a3f159c32 100644 --- a/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md +++ b/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md @@ -2,9 +2,8 @@ Certain sensitive parameters required during installation (e.g. passwords) must Before encrypting parameters, it is required to generate a private key that will be used by the [{{% ctx %}} Encryptor][CORTEX Encrypted] PowerShell module using the following steps: -Choose one of the Application Servers or the Web Application Server, and copy the `Cortex Innovation {{< version >}} - Encryption Key Generator.zip` artefacts to a folder on it: +On one of the Application Servers or on the Web Application Server: -1. Extract the `Cortex Innovation {{< version >}} - Encryption Key Generator.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. The administrator must be a domain user that is a member of the local Administrators group on the Application Servers and Web Application Server. 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Encryption Key Generator` folder using the following command, modifying the path as necessary: diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index 3789b0a93..fe85581c3 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -44,7 +44,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| @@ -119,6 +119,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallationNew" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirementsNew" >}} +[Obtain a {{% ctx %}} licence file]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ObtainLicence" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md index 7736cdf58..71c3f7d49 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md @@ -9,6 +9,10 @@ weight: 30 This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +## Make Installation Artefacts Available on all Servers + +{{< section "/pre-installation/multi-server/make-artefacts-available.md">}} + ## Obtain a {{% ctx %}} licence file A valid {{% ctx %}} licence file and {{% ctx %}} with v7.2 feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. @@ -37,46 +41,19 @@ To get a licence file and feature identifier take the following steps: Please also include a suitable {{% ctx %}} with v7.2 feature identifier. ``` -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the Web Application server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: WEBAPP-SERVER - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - -1. Copy the output (machine identifier and fingerprint) to the `Web Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. -1. For each Application Server take the following steps: - 1. Copy `Cortex.Licensing.FingerprintGeneration.exe` to the Application server. - 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: +1. On each Application Server and the Web Application Server: + 1. In a File Explorer, navigate to the Fingerprint generation folder inside the install file location, e.g. `C:\Install\Cortex Innovation {{< version >}} - Licence Fingerprint Generator Extract`. + 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a Machine ID and Fingerprint, e.g: - ```text - MachineID: APP-SERVER1 - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` + ```text + MachineID: SERVER-NAME + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` - 1. Copy the output (machine identifier and fingerprint) to one of the `Application Server` sections of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. + 1. Copy the output (Machine ID and Fingerprint) to the corresponding section of the text file created in the initial step. Note that the Machine ID can be changed to any string, provided that it is different for each server. 1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. 1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. -## Make Installation Artefacts Available on Application Servers - -1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - Block Packages.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. - -## Make Installation Artefacts Available on Web Application Server - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} - ## Next Steps? 1. [Installation][] diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md index 7aaf51d82..b46b1ef5c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md @@ -13,7 +13,7 @@ This guide describes how to upgrade Gateway on {{% ctx %}} 7.2 to include {{% ct ### Licensing -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. +Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Obtain a {{% ctx %}} licence file][]. ### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User @@ -94,7 +94,7 @@ A Friendly Name should be assigned to the certificate being used for the Cortex | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will overwrite the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will overwrite the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| @@ -195,7 +195,7 @@ Ensure that the installation files are backed up or kept on the server, especial [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServerNew" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.LicensingRequirementsNew" >}} +[Obtain a {{% ctx %}} licence file]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ObtainLicence" >}} [Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.EncryptionRequirementsNew" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/encrypt-text.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/encrypt-text.md index 42dd5fa94..790f42b15 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/encrypt-text.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/encrypt-text.md @@ -8,8 +8,8 @@ description: "Information about encrypting text using the {{% ctx %}} Encryptor. To encrypt text using the {{% ctx %}} Encryptor PowerShell module: -1. Extract the `Cortex Innovation {{< version >}} - Encryptor.zip` file to a folder with the same name. -1. Open a Windows PowerShell (x64) window as administrator. +On one of the servers specified during the Generate Encryption Key steps during the Pre-Installation: +1. Open a Windows PowerShell (x64) window as administrator. The administrator must be a domain user that is a member of the local Administrators group on the Application Servers and Web Application Server. 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Encryptor` folder using the following command, modifying the path as necessary: ```powershell @@ -22,12 +22,12 @@ To encrypt text using the {{% ctx %}} Encryptor PowerShell module: Import-Module .\Cortex.Encryptor.psd1 ``` + {{< alert title="Note:" >}}The `Import-Module` command will need to be repeated every time a new PowerShell window is used. To install the PowerShell module so that it is always available, follow the instructions laid out {{< ahref path="MSDocs.PowerShell.InstallModule" title="here" >}}.{{< /alert >}} + 1. In the Windows PowerShell (x64) window, run the following command to encrypt text, replacing `text to encrypt` with the text that you want to encrypt: ```powershell ConvertTo-EncryptedText -Text 'text to encrypt' ``` - The command will return the encrypted text, beginning with `#_`. This step can be repeated for any texts that need to be encrypted. - - {{< alert title="Note:" >}}The `Import-Module` command will need to be repeated every time a new PowerShell window is used. To install the PowerShell module so that it is always available, follow the instructions laid out {{< ahref path="MSDocs.PowerShell.InstallModule" title="here" >}}.{{< /alert >}} + The command will return the encrypted text, beginning with `#_`. This step can be repeated for any text that needs to be encrypted. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index aa44a471c..cb82f3ee3 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -207,7 +207,7 @@ To check all necessary ports are free, follow these steps: {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Generate Encryption Key" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index 6ca904d8e..4c3bd6573 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -45,12 +45,12 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" title="Generate Encryption Key" >}} steps.{{% /alert %}} | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during the Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| @@ -128,6 +128,6 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta [Import Certificate Manually]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew2" >}} [Import Root Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportRootCertificateNew" >}} [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirementsNew" >}} +[Obtain a {{% ctx %}} licence file]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ObtainLicence" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md index 15f6e827e..d7856da31 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md @@ -9,6 +9,10 @@ weight: 30 This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +## Make Installation Artefacts Available on all Servers + +{{< section "/pre-installation/multi-server/make-artefacts-available.md">}} + ## Obtain a {{% ctx %}} licence file A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. @@ -37,47 +41,19 @@ To get a licence file and feature identifier take the following steps: Please also include a suitable {{% ctx %}} feature identifier. ``` -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the Web Application server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: +1. On each Application Server and the Web Application Server: + 1. In a File Explorer, navigate to the Fingerprint generation folder inside the install file location, e.g. `C:\Install\Cortex Innovation {{< version >}} - Licence Fingerprint Generator Extract`. + 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a Machine ID and Fingerprint, e.g: - ```text - MachineID: WEBAPP-SERVER - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` + ```text + MachineID: SERVER-NAME + Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 + ``` -1. Copy the output (machine identifier and fingerprint) to the `Web Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. -1. For each Application Server take the following steps: - 1. Copy `Cortex.Licensing.FingerprintGeneration.exe` to the Application server. - 1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: - - ```text - MachineID: APP-SERVER1 - Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 - ``` - - 1. Copy the output (machine identifier and fingerprint) to one of the `Application Server` sections of the text file created in the initial step. Note that the machine identifier can be changed to any string, provided that it is different for each server. + 1. Copy the output (Machine ID and Fingerprint) to the corresponding section of the text file created in the initial step. Note that the Machine ID can be changed to any string, provided that it is different for each server. 1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. 1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. -## Make Installation Artefacts Available on Application Servers - -1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - Block Packages.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. - -## Make Installation Artefacts Available on Web Application Server - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} - - ## Generate Encryption Key {{< section "/prerequisites/install-innovation-only/multi-server/encryption-requirements.md">}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md index 7584da208..45552cf02 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md @@ -13,7 +13,7 @@ This guide describes how to install the Web Application Server components on the ### Licensing -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. +Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Obtain a {{% ctx %}} licence file][]. ### Get {{% ctx %}} Gateway Application Pool User @@ -136,12 +136,12 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirementsNew" title="Generate Encryption Key" >}} steps.{{% /alert %}} | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the {{% ctx %}} Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| @@ -220,6 +220,6 @@ Ensure that the installation files are backed up or kept on the server, especial [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} [Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServerNew" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.LicensingRequirementsNew" >}} +[Obtain a {{% ctx %}} licence file]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ObtainLicence" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md index dc8b320c1..507ba323c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md @@ -9,6 +9,10 @@ weight: 30 This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +## Make Installation Artefacts Available + +{{< section "/pre-installation/single-server/make-artefacts-available.md">}} + ## Obtain a {{% ctx %}} licence file A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. @@ -16,7 +20,7 @@ A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be proc To get a licence file and feature identifier take the following steps: 1. Copy the following template to a text file: - + ```text Web Application/Application Server MachineID: @@ -25,9 +29,8 @@ To get a licence file and feature identifier take the following steps: Please also include a suitable {{% ctx %}} feature identifier. ``` -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: +1. In a File Explorer, navigate to the Fingerprint generation folder inside the install file location, e.g. `C:\Install\Cortex Innovation {{< version >}} - Licence Fingerprint Generator Extract`. +1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a Machine ID and Fingerprint, e.g: ```text MachineID: SERVER @@ -35,22 +38,10 @@ To get a licence file and feature identifier take the following steps: ``` 1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. +1. Copy the output (Machine ID and Fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the Machine ID can be changed to any string. 1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. 1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. -## Make Installation Artefacts Available for Application Install - -{{< section "/install-application-server/make-installation-artefacts-available.md">}} - -## Make Installation Artefacts Available for Web Application Install - -1. Copy the following artefacts to a folder on the machine: - - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. - ## Generate Encryption Key {{< section "/prerequisites/install-innovation-only/single-server/encryption-requirements.md">}} diff --git a/data/urls.toml b/data/urls.toml index c5d0310ad..9d4be85c2 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -252,7 +252,7 @@ DebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" DebuggerInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation" EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#encryption-requirements" - EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#encryption-requirements" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation/#generate-encryption-key" GatewayInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" GatewayInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation" GenerateEncryptionKey = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#generate-encryption-key" @@ -270,7 +270,6 @@ InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server" InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server" LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" - LicensingRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements#licensing-requirements" MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available-on-application-servers" ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" @@ -301,7 +300,7 @@ ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server#configure-installation-script" ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server#configure-installation-script" EncryptionRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#encryption-requirements" - EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#encryption-requirements" + EncryptionRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation/#generate-encryption-key" GenerateEncryptionKey = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation#generate-encryption-key" ImportCertificateManually = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#import-certificate-manually" ImportCertificateManuallyNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server/#import-certificate-manually" @@ -312,7 +311,6 @@ InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server" InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server" LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/prerequisites#licensing-requirements" - LicensingRequirementsNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements#licensing-requirements" ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation#obtain-a-cortex-licence-file" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server/#perform-installation" PerformInstallationNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server/#perform-installation" @@ -368,7 +366,6 @@ InstallApplicationAndLoadBalancerServersNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers" Installation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation" LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#licensing-requirements" - LicensingRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements#licensing-requirements" MinimumArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#minimum-architecture" ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" PreInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation" @@ -398,7 +395,6 @@ InstallApplicationServerNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server" Installation = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation" LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#licensing-requirements" - LicensingRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements#licensing-requirements" ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation#obtain-a-cortex-licence-file" PreInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation" Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites" From 72aba438ddea9fbf3ae9b979c2bb31e8949b7a7c Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 09:19:43 +0000 Subject: [PATCH 06/19] completed documentation change for Install Innovation only --- .../pre-installation/multi-server/make-artefacts-available.md | 2 ++ .../pre-installation/single-server/make-artefacts-available.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md index 9a66c66f7..4d53af91f 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md @@ -8,6 +8,8 @@ * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in the folder.{{% /alert %}} + 1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: diff --git a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md index 8987ae930..8e364eb0b 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md @@ -8,6 +8,8 @@ * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in the folder.{{% /alert %}} + 1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: From 42f74a59d03e97ceaefefbbec60f89632a1d1c37 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 09:22:10 +0000 Subject: [PATCH 07/19] Made a fix to single server --- .../pre-installation/single-server/make-artefacts-available.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md index 8e364eb0b..5da834924 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md @@ -24,7 +24,7 @@ Unblock-File -Path .\Cortex.Install.Preinstallation.ps1 ``` -1. Run the `Cortex.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS names or fully qualified domain names of the Server: +1. Run the `Cortex.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: ```powershell .\Cortex.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" From 49e21c85fc543a13955708cc871ff07c05074f63 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 09:25:53 +0000 Subject: [PATCH 08/19] modified alert note --- .../pre-installation/multi-server/make-artefacts-available.md | 2 +- .../pre-installation/single-server/make-artefacts-available.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md index 4d53af91f..716138dd9 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md @@ -8,7 +8,7 @@ * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in the folder.{{% /alert %}} + {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} 1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. diff --git a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md index 5da834924..8e675e11d 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md @@ -8,7 +8,7 @@ * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in the folder.{{% /alert %}} + {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} 1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. From 3fc04dc52485403acc991d011ad8f28eb18344b3 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 11:28:41 +0000 Subject: [PATCH 09/19] updated add innovation to 7.2 --- .../configure-installation-script.md | 2 +- .../configure-debugger-installation-script.md | 2 +- ...ll-application-and-loadbalancer-servers.md | 2 +- .../pre-installation.md | 28 ++++++------------- 4 files changed, 12 insertions(+), 22 deletions(-) diff --git a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md index b363138ec..dde0ecdb5 100644 --- a/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on the Application Server with {{< ctx >}} v7.2 installed.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index 84f189475..4b9a34ef1 100644 --- a/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2025.1/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on the Application Server with {{< ctx >}} v7.2 installed.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index fecfad556..c4c8baff8 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -207,7 +207,7 @@ To check all necessary ports are free, follow these steps: {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on the Application Server with {{< ctx >}} v7.2 installed.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md index da464965e..6a6bf4707 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md @@ -9,6 +9,10 @@ weight: 30 This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +## Make Installation Artefacts Available + +{{< section "/pre-installation/single-server/make-artefacts-available.md">}} + ## Obtain a {{% ctx %}} licence file A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. @@ -16,18 +20,17 @@ A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be proc To get a licence file and feature identifier take the following steps: 1. Copy the following template to a text file: - + ```text Web Application/Application Server MachineID: Fingerprint: - Please also include a suitable {{% ctx %}} with v7.2 feature identifier. + Please also include a suitable {{% ctx %}} feature identifier. ``` -1. Extract `Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip`. -1. From that folder, copy `Cortex.Licensing.FingerprintGeneration.exe` to the server. -1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a machine identifier and fingerprint, e.g: +1. In a File Explorer, navigate to the Fingerprint generation folder inside the install file location, e.g. `C:\Install\Cortex Innovation {{< version >}} - Licence Fingerprint Generator Extract`. +1. Double-click `Cortex.Licensing.FingerprintGeneration.exe` to run it. A command line window will appear, containing a Machine ID and Fingerprint, e.g: ```text MachineID: SERVER @@ -35,23 +38,10 @@ To get a licence file and feature identifier take the following steps: ``` 1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. +1. Copy the output (Machine ID and Fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the Machine ID can be changed to any string. 1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. 1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. -## Make Installation Artefacts Available on Application Servers - -{{< section "/install-application-server/make-installation-artefacts-available.md">}} - -## Make Installation Artefacts Available on Web Application Server - -1. Copy the following artefacts to a folder on the machine: - - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. - ## Next Steps? 1. [Installation][] From 9d8c94dbf586c4f4f90c641f0c8bb637f2d80768 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 12:47:10 +0000 Subject: [PATCH 10/19] added missing URL --- data/urls.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/data/urls.toml b/data/urls.toml index 9d4be85c2..7dceec48e 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -366,7 +366,8 @@ InstallApplicationAndLoadBalancerServersNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers" Installation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation" LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#licensing-requirements" - MinimumArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#minimum-architecture" + MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" + MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available" ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" PreInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation" Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites" From 23496b1bc97d9a555b06b2b745ae2832274375f5 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 12:52:56 +0000 Subject: [PATCH 11/19] added missing url --- data/urls.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/data/urls.toml b/data/urls.toml index 7dceec48e..6bc8187fe 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -368,6 +368,7 @@ LicensingRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#licensing-requirements" MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available" + MinimumArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture#minimum-architecture" ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" PreInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation" Prerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites" From 67315d9610f0203fe27ab3cdd835b7626111979a Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 13:04:10 +0000 Subject: [PATCH 12/19] fixed another broken url --- data/urls.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/urls.toml b/data/urls.toml index 6bc8187fe..d4e17b109 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -271,7 +271,7 @@ InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server" LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" - MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available-on-application-servers" + MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available" ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" PerformDebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-debugger-installation" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" From 60ccdd39f69fd59fdf71b9cf4927f9d26808bfeb Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 13:13:49 +0000 Subject: [PATCH 13/19] fixed broken url --- data/urls.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/urls.toml b/data/urls.toml index d4e17b109..d25ea1626 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -271,7 +271,7 @@ InstallWebApplicationServerNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server" LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" MakeInstallationArtefactsAvailable = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers/#make-installation-artefacts-available" - MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#make-installation-artefacts-available" + MakeInstallationArtefactsAvailableNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation/#make-installation-artefacts-available-on-all-servers" ObtainLicence = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation#obtain-a-cortex-licence-file" PerformDebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-debugger-installation" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" From 3ca1b542acc93666c8202f59ef6047cc7b0f3724 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 20 Jan 2025 16:36:38 +0000 Subject: [PATCH 14/19] Fixed up Next Steps following initial review --- .../single-server-without-ha/requirements.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md index 7eb14246b..a92ab01d7 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md @@ -221,14 +221,13 @@ See [SSL Best Practices][] for a full list of the security changes which will be ## Next Steps? -1. [Install Application Server][] +1. [Pre-Installation][] [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Architecture" >}} [C++ Redistributable]: {{< url path="MSDownload.CPlusPlusRedistributable.2013" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Create Full DB Backup]: {{< url path="MSDocs.SqlServer.CreateFullDbBackup" >}} [IIS URL Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServerNew" >}} [Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}} [Microsoft Server 2016]: {{< url path="MSEval.WindowsServer.2016" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} From 66afbb314161a4309d0e8d1cb474abc0eab47417 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Tue, 21 Jan 2025 11:04:51 +0000 Subject: [PATCH 15/19] Changes followingf PR Review --- .../multi-server/make-artefacts-available.md | 2 +- .../single-server/make-artefacts-available.md | 2 +- .../single-server/encryption-requirements.md | 7 ++----- .../perform-gateway-installation.md | 2 ++ .../installation/install-web-application-server.md | 2 ++ .../single-server-without-ha/pre-installation.md | 1 - .../single-server-without-ha/pre-installation.md | 1 - 7 files changed, 8 insertions(+), 9 deletions(-) diff --git a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md index 716138dd9..355d436da 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md @@ -8,7 +8,7 @@ * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} 1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. diff --git a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md index 8e675e11d..59aaddf8f 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md @@ -8,7 +8,7 @@ * Cortex Innovation {{< version >}} - Licence Fingerprint Generator.zip * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - {{% alert title="Note" %}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} 1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. 1. Open a Windows PowerShell (x64) window as administrator. diff --git a/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/single-server/encryption-requirements.md b/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/single-server/encryption-requirements.md index 95ab65f45..8fa148e66 100644 --- a/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/single-server/encryption-requirements.md +++ b/content/en/docs/2025.1/_shared/prerequisites/install-innovation-only/single-server/encryption-requirements.md @@ -2,10 +2,7 @@ Certain sensitive parameters required during installation (e.g. passwords) must Before encrypting parameters, it is required to generate a private key that will be used by the [{{% ctx %}} Encryptor][CORTEX Encrypted] PowerShell module using the following steps: -Copy the `Cortex Innovation {{< version >}} - Encryption Key Generator.zip` artefacts to a folder on the server: - -1. Extract the `Cortex Innovation {{< version >}} - Encryption Key Generator.zip` file to a folder with the same name. -1. Open a Windows PowerShell (x64) window as administrator. The administrator must be a domain user that is a member of the local Administrators group on the Application Server and Web Application Server. +1. Open a Windows PowerShell (x64) window as administrator. The administrator must be a domain user that is a member of the local Administrators group on the server. 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Encryption Key Generator` folder using the following command, modifying the path as necessary: ```powershell @@ -30,4 +27,4 @@ Copy the `Cortex Innovation {{< version >}} - Encryption Key Generator.zip` arte {{% alert title="Important" color="warning" %}}For security reasons the outputted `Encryption Key` should be backed up. If any keys were overwritten then they must be backed up too.{{% /alert %}} -[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} \ No newline at end of file +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index fe85581c3..d8f70b3a9 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -41,6 +41,8 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on the Application Server with {{< ctx >}} v7.2 installed.{{% /alert %}} + | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md index b46b1ef5c..00e39459c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md @@ -91,6 +91,8 @@ A Friendly Name should be assigned to the certificate being used for the Cortex *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on the Application Server with {{< ctx >}} v7.2 installed.{{% /alert %}} + | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md index 6a6bf4707..1950dc99e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md @@ -37,7 +37,6 @@ To get a licence file and feature identifier take the following steps: Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 ``` -1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. 1. Copy the output (Machine ID and Fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the Machine ID can be changed to any string. 1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. 1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Upgrading Gateway][]. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md index 507ba323c..2e6cfbec3 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md @@ -37,7 +37,6 @@ To get a licence file and feature identifier take the following steps: Fingerprint: 111118BA104C928319E0CBAE30844CF8B7FD8BC414D1567844D1D0830089F1C9BF5C6 ``` -1. Copy the output (machine identifier and fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the machine identifier can be changed to any string. 1. Copy the output (Machine ID and Fingerprint) to the `Web Application/Application Server` section of the text file created in the initial step. Note that the Machine ID can be changed to any string. 1. Request a licence and feature identifier by raising a case in the [{{% ctx %}} Service Portal][CORTEX Service Portal], including the contents of the text file containing all of the fingerprint and machine information in the body of the case. 1. When the licence and feature identifier have arrived, copy the file `Cortex.lic` to `%ProgramData%\Cortex\Licences` on the Web Application Server, creating the `Cortex` and `Licences` folders if they don't exist. Save the feature identifier for use when [Installing Gateway][]. From 44a870bd60a7de33cfb528812d08111b96d655c9 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 22 Jan 2025 13:04:09 +0000 Subject: [PATCH 16/19] Reverted Innovation change in Add to 7.2 --- .../multi-server/make-artefacts-available.md | 8 ++++---- .../single-server/make-artefacts-available.md | 8 ++++---- .../on-premise/add-innovation-to-72/_index.md | 4 ++-- .../multiple-server-with-ha/_index.md | 2 +- .../multiple-server-with-ha/architecture.md | 2 +- .../multiple-server-with-ha/installation/_index.md | 4 ++-- .../install-application-and-loadbalancer-servers.md | 4 ++-- .../multiple-server-with-ha/pre-installation.md | 2 +- .../multiple-server-with-ha/requirements.md | 6 +++--- .../multiple-server-with-ha/try-it-out.md | 4 ++-- .../single-server-without-ha/_index.md | 2 +- .../single-server-without-ha/architecture.md | 6 +++--- .../single-server-without-ha/installation/_index.md | 4 ++-- .../installation/install-application-server.md | 4 ++-- .../installation/install-web-application-server.md | 4 ++-- .../single-server-without-ha/pre-installation.md | 8 ++++---- .../single-server-without-ha/requirements.md | 6 +++--- .../single-server-without-ha/try-it-out.md | 6 +++--- 18 files changed, 42 insertions(+), 42 deletions(-) diff --git a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md index 355d436da..f4683c4a9 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/multi-server/make-artefacts-available.md @@ -18,16 +18,16 @@ cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" ``` -1. Ensure that the `Cortex.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: ```powershell - Unblock-File -Path .\Cortex.Install.Preinstallation.ps1 + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 ``` -1. Run the `Cortex.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers, the `WebApplicationServer` value to contain the NETBIOS names or fully qualified domain name of the Web Application Server and the `LoadBalancerServer` value to contain the NETBIOS names or fully qualified domain name of the Load Balancer Server (remove the `LoadBalancerServer` parameter if using an [alternative load balancer][]): +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers, the `WebApplicationServer` value to contain the NETBIOS names or fully qualified domain name of the Web Application Server and the `LoadBalancerServer` value to contain the NETBIOS names or fully qualified domain name of the Load Balancer Server (remove the `LoadBalancerServer` parameter if using an [alternative load balancer][]): ```powershell - .\Cortex.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server" -LoadBalancerServer "lb-server" + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server" -LoadBalancerServer "lb-server" ``` [alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancerNew" >}} diff --git a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md index 59aaddf8f..b3d632043 100644 --- a/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md +++ b/content/en/docs/2025.1/_shared/pre-installation/single-server/make-artefacts-available.md @@ -18,14 +18,14 @@ cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" ``` -1. Ensure that the `Cortex.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: ```powershell - Unblock-File -Path .\Cortex.Install.Preinstallation.ps1 + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 ``` -1. Run the `Cortex.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: ```powershell - .\Cortex.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" ``` diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md index 183733f62..2a7d94281 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md @@ -1,10 +1,10 @@ --- title: "Add CORTEX to a 7.2 Installation" linkTitle: "Add CORTEX to a 7.2 Installation" -description: "Information about adding {{% ctx %}} to an existing {{% ctx %}} 7.2 platform." +description: "Information about adding {{% ctx %}} Innovation to an existing {{% ctx %}} 7.2 platform." weight: 20 --- {{% pageinfo %}} -{{% ctx %}} can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. +{{% ctx %}} Innovation can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. {{% /pageinfo %}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md index f31653e77..899f45c92 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Multiple Server - With HA (Recommended)" linkTitle: "Multiple Server - With HA" -description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." +description: "Information about adding {{% ctx %}} Innovation to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md index fdf024dcf..e3bb6bb14 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/architecture.md @@ -17,7 +17,7 @@ weight: 10 ## Possible Architectures -{{% ctx %}} and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a v7.2 installation and the only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. +{{% ctx %}} Innovation and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a v7.2 installation and the only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. ### Recommended Architecture diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md index 612bf580a..06a641e6c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/_index.md @@ -1,10 +1,10 @@ --- title: "Installation" linkTitle: "Installation" -description: "Installation instructions to add {{% ctx %}} to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA)." +description: "Installation instructions to add {{% ctx %}} Innovation to {{% ctx %}} 7.2 across multiple on-premise servers with high availability (HA)." weight: 40 --- -This guide describes how to add {{% ctx %}} to an existing {{% ctx %}} 7.2 platform. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. +This guide describes how to add {{% ctx %}} Innovation to an existing {{% ctx %}} 7.2 platform. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. [PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index c4c8baff8..c8e75298c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -7,7 +7,7 @@ weight: 30 # {{< param title >}} -This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for adding {{% ctx %}} to 7.2][] have been completed before starting this installation. +This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for adding Innovation to 7.2][] have been completed before starting this installation. ## Install Microsoft .NET Framework 4.7.2 @@ -319,7 +319,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} -[Pre-Installation steps for adding {{% ctx %}} to 7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} +[Pre-Installation steps for adding Innovation to 7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md index 71c3f7d49..894f153a5 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/pre-installation.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +This guide describes how to perform the steps required before starting the installation of {{% ctx %}} Innovation. Please ensure that the [Requirements][] have been read and met before starting this installation. ## Make Installation Artefacts Available on all Servers diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md index b9588efab..54127abd4 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/requirements.md @@ -85,7 +85,7 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} with v7.2 feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. @@ -159,7 +159,7 @@ On the Web Application Server and each Application Server, the following Windows ### Installation User -On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} is built upon. +On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} Innovation is built upon. ### Antivirus Exclusions @@ -199,7 +199,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. +{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md index 836057376..0c19737cd 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} for the first time." +description: "Information about trying out {{% ctx %}} Innovation for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} has now been verified and is ready to use. +1. {{% ctx %}} Innovation has now been verified and is ready to use. [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Troubleshooting Flow No Blocks]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNoBlocks" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md index 50794e002..1ce61bf7d 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." +description: "Information about adding {{% ctx %}} Innovation to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10000 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md index f6c5bdf20..b9d9c6c36 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture.md @@ -1,7 +1,7 @@ --- title: "Architecture" linkTitle: "Architecture" -description: "Information about the recommended platform architecture, including component descriptions." +description: "Information about the recommended Innovation platform architecture, including component descriptions." weight: 10 --- @@ -13,9 +13,9 @@ weight: 10 ## Single Server Architecture -{{% ctx %}} and {{% ctx %}} 7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. {{% ctx %}} can be added to a {{% ctx %}} v7.2 installation by using the existing hardware. The only component shared by both {{% ctx %}} and {{% ctx %}} 7.2 is {{% ctx %}} Gateway. +{{% ctx %}} Innovation and v7.2 can run side-by-side, allowing flows to be built and run for both of them from the same Gateway instance. They each require a different set of back-end components to be installed. Innovation can be added to a {{% ctx %}} v7.2 installation by using the existing hardware. The only component shared by both Innovation and v7.2 is {{% ctx %}} Gateway. -The minimum architecture for adding {{% ctx %}} to a v7.2 Single Site, Single Server system is as follows: +The minimum architecture for adding Innovation to a v7.2 Single Site, Single Server system is as follows: {{< figure src="/images/editable/Cortex Innovation v7.2 Single Server.png" class="centre" title="1 Server Architecture Diagram" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md index 0714dd224..e72b44af7 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/_index.md @@ -1,10 +1,10 @@ --- title: "Installation" linkTitle: "Installation" -description: "Information about adding {{% ctx %}} to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA)." +description: "Information about adding {{% ctx %}} Innovation to {{% ctx %}} 7.2 on a single on-premise server without high availability (HA)." weight: 40 --- -This guide describes how to add {{% ctx %}} to an existing {{% ctx %}} 7.2 platform. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. +This guide describes how to add {{% ctx %}} Innovation to an existing {{% ctx %}} 7.2 platform. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. [PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md index cafce2f40..099128d8c 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md @@ -7,7 +7,7 @@ weight: 30 # {{< param title >}} -This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for adding {{% ctx %}} to {{% ctx %}} 7.2][] have been completed before starting the installation.. +This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for adding {{% ctx %}} Innovation to {{% ctx %}} 7.2][] have been completed before starting the installation.. ## Install Microsoft .NET Framework 4.7.2 @@ -56,5 +56,5 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Upgrade v7.2 Gateway to Include Innovation][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusionsNew" >}} -[Pre-Installation steps for adding {{% ctx %}} to {{% ctx %}} 7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} +[Pre-Installation steps for adding {{% ctx %}} Innovation to {{% ctx %}} 7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} [Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServerNew" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md index 00e39459c..455af51ce 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md @@ -1,13 +1,13 @@ --- title: "Upgrade v7.2 Gateway to Include Innovation" linkTitle: "Upgrade v7.2 Gateway to Include Innovation" -description: "Information about upgrading a {{% ctx %}} 7.2 Gateway with {{% ctx %}} functionality." +description: "Information about upgrading v7.2 Gateway with Innovation functionality." weight: 40 --- # {{< param title >}} -This guide describes how to upgrade Gateway on {{% ctx %}} 7.2 to include {{% ctx %}}. Please ensure that [Install Application Server][] has been completed before starting this installation. These steps assume that the {{% ctx %}} 7.2 version of Gateway and its prerequisites have already been installed. +This guide describes how to upgrade Gateway on v7.2 to include Innovation. Please ensure that [Install Application Server][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. ## Install Prerequisites diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md index 1950dc99e..5c5ae764f 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +This guide describes how to perform the steps required before starting the installation of {{% ctx %}} Innovation. Please ensure that the [Requirements][] have been read and met before starting this installation. ## Make Installation Artefacts Available @@ -15,18 +15,18 @@ This guide describes how to perform the steps required before starting the insta ## Obtain a {{% ctx %}} licence file -A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. +A valid {{% ctx %}} licence file and {{% ctx %}} with v7.2 feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. To get a licence file and feature identifier take the following steps: 1. Copy the following template to a text file: - + ```text Web Application/Application Server MachineID: Fingerprint: - Please also include a suitable {{% ctx %}} feature identifier. + Please also include a suitable {{% ctx %}} with v7.2 feature identifier. ``` 1. In a File Explorer, navigate to the Fingerprint generation folder inside the install file location, e.g. `C:\Install\Cortex Innovation {{< version >}} - Licence Fingerprint Generator Extract`. diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md index a92ab01d7..783f71847 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements.md @@ -76,7 +76,7 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. @@ -137,7 +137,7 @@ The following Windows Services must be running on the server: ### Installation User -A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} is built upon. +A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} Innovation is built upon. ### Antivirus Exclusions @@ -170,7 +170,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. +{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md index 2b07a9e0a..5f5aad32b 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md @@ -1,13 +1,13 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} for the first time." +description: "Information about trying out {{% ctx %}} Innovation for the first time." weight: 60 --- # {{< param title >}} -This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that the [Gateway Upgrade][] has been completed before taking these steps. +This guide describes how to try out a new Innovation installation to make sure it is working. Please ensure that the [Gateway Upgrade][] has been completed before taking these steps. ## Test Debugging Flows @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the server you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} has now been verified and is ready to use. +1. {{% ctx %}} Innovation has now been verified and is ready to use. [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Troubleshooting Flow Not Starting]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNotStarting" >}} From d282d7f0dd307e2fd402a7592db9718486723b69 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 22 Jan 2025 13:21:04 +0000 Subject: [PATCH 17/19] Additional Innovation fixes for add to 7.2 --- .../make-installation-artefacts-available.md | 6 ------ .../make-installation-artefacts-available.md | 10 ---------- .../on-premise/add-innovation-to-72/_index.md | 4 ++-- .../perform-gateway-installation.md | 2 +- .../installation/install-web-application-server.md | 2 +- 5 files changed, 4 insertions(+), 20 deletions(-) delete mode 100644 content/en/docs/2025.1/_shared/install-application-server/make-installation-artefacts-available.md delete mode 100644 content/en/docs/2025.1/_shared/install-web-application-server/make-installation-artefacts-available.md diff --git a/content/en/docs/2025.1/_shared/install-application-server/make-installation-artefacts-available.md b/content/en/docs/2025.1/_shared/install-application-server/make-installation-artefacts-available.md deleted file mode 100644 index 4371a34ad..000000000 --- a/content/en/docs/2025.1/_shared/install-application-server/make-installation-artefacts-available.md +++ /dev/null @@ -1,6 +0,0 @@ -1. Copy the following artefacts to a folder on the server: - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. diff --git a/content/en/docs/2025.1/_shared/install-web-application-server/make-installation-artefacts-available.md b/content/en/docs/2025.1/_shared/install-web-application-server/make-installation-artefacts-available.md deleted file mode 100644 index 908a6a01e..000000000 --- a/content/en/docs/2025.1/_shared/install-web-application-server/make-installation-artefacts-available.md +++ /dev/null @@ -1,10 +0,0 @@ -1. Copy the following artefacts to a folder on the machine: - - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md index 2a7d94281..19d0dbf9d 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/_index.md @@ -1,6 +1,6 @@ --- -title: "Add CORTEX to a 7.2 Installation" -linkTitle: "Add CORTEX to a 7.2 Installation" +title: "Add Innovation to a 7.2 Installation" +linkTitle: "Add Innovation to a 7.2 Installation" description: "Information about adding {{% ctx %}} Innovation to an existing {{% ctx %}} 7.2 platform." weight: 20 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index d8f70b3a9..adb677faa 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -46,7 +46,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| diff --git a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md index 455af51ce..4a1845a45 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md @@ -96,7 +96,7 @@ A Friendly Name should be assigned to the certificate being used for the Cortex | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will overwrite the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will overwrite the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| From 393c9838861b365ffe78550a5450591273676438 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 22 Jan 2025 13:50:44 +0000 Subject: [PATCH 18/19] Reverted Innovation removal for Innovation Only --- .../on-premise/install-innovation-only/_index.md | 6 +++--- .../on-premise/install-innovation-only/advanced/_index.md | 2 +- .../advanced/advanced-config-changes.md | 2 +- .../install-innovation-only/advanced/port-requirements.md | 6 +++--- .../multiple-server-with-ha/_index.md | 2 +- .../multiple-server-with-ha/installation/_index.md | 4 ++-- .../install-application-and-loadbalancer-servers.md | 4 ++-- .../perform-gateway-installation.md | 2 +- .../multiple-server-with-ha/installation/setup-gateway.md | 2 +- .../multiple-server-with-ha/pre-installation.md | 6 +++--- .../multiple-server-with-ha/requirements.md | 4 ++-- .../multiple-server-with-ha/try-it-out.md | 4 ++-- .../single-server-without-ha/_index.md | 2 +- .../single-server-without-ha/installation/_index.md | 4 ++-- .../installation/install-application-server.md | 4 ++-- .../installation/install-web-application-server.md | 2 +- .../single-server-without-ha/installation/setup-gateway.md | 6 +++--- .../single-server-without-ha/pre-installation.md | 6 +++--- .../single-server-without-ha/requirements.md | 6 +++--- .../single-server-without-ha/try-it-out.md | 4 ++-- 20 files changed, 39 insertions(+), 39 deletions(-) diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md index b7b0d94e3..83af98ed7 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md @@ -1,10 +1,10 @@ --- -title: "Install CORTEX Only" -linkTitle: "Install CORTEX Only" +title: "Install Innovation Only" +linkTitle: "Install Innovation Only" description: "Information about installing a {{% ctx %}} platform." weight: 10 --- {{% pageinfo %}} -{{% ctx %}} can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. +{{% ctx %}} Innovation can be deployed on-premise across [multiple servers](multiple-server-with-ha) to provide improved scale and high availability (HA), or to a [single server](single-server-without-ha) if scale and HA aren't required. {{% /pageinfo %}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md index 6492d86a9..f42adde16 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/_index.md @@ -1,6 +1,6 @@ --- title: "Advanced Setup" linkTitle: "Advanced Setup" -description: "Supporting information about installing {{% ctx %}} with non-default configurations." +description: "Supporting information about installing {{% ctx %}} Innovation with non-default configurations." weight: 90 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md index 09b1da8d8..5c264f3f0 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/advanced-config-changes.md @@ -1,7 +1,7 @@ --- title: "Advanced Application Server and Load Balancer Configuration Changes" linkTitle: "Advanced Application Server and Load Balancer Configuration Changes" -description: "Information about installing {{% ctx %}} with non-default installation values." +description: "Information about installing {{% ctx %}} Innovation with non-default installation values." --- # {{% param title %}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md index 1e6d3301a..d9c2084ab 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/advanced/port-requirements.md @@ -1,14 +1,14 @@ --- title: "Port Requirements for Application Servers and Load Balancer" linkTitle: "Port Requirements for Application Servers and Load Balancer" -description: "Information about the ports opened when installing {{% ctx %}}." +description: "Information about the ports opened when installing {{% ctx %}} Innovation." --- # {{% param title %}} -{{% ctx %}} and Microsoft Service Fabric open a range of firewall ports between the servers and specific services. Some of them are opened during installation, others are opened dynamically as needed. These are opened on Windows Firewall. If any other firewall exists between the servers, it will be necessary to configure this selection of rules on it. Most ports may be altered if another program overlaps with them, the description will say if this is not possible. +{{% ctx %}} Innovation and Microsoft Service Fabric open a range of firewall ports between the servers and specific services. Some of them are opened during installation, others are opened dynamically as needed. These are opened on Windows Firewall. If any other firewall exists between the servers, it will be necessary to configure this selection of rules on it. Most ports may be altered if another program overlaps with them, the description will say if this is not possible. -## {{% ctx %}} Ports +## {{% ctx %}} Innovation Ports | Name | Description | Default Port(s) | Protocol | Direction | |------|-------------|-----------------|----------|-----------| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md index 7962032e3..7c744ccbc 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Multiple Server - With HA (Recommended)" linkTitle: "Multiple Server - With HA" -description: "Information about installing {{% ctx %}} across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." +description: "Information about installing {{% ctx %}} Innovation across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 10 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md index 78a2ea1a0..fab4f915b 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/_index.md @@ -1,10 +1,10 @@ --- title: "Installation" linkTitle: "Installation" -description: "Installation instructions to install {{% ctx %}} across multiple on-premise servers with high availability (HA)." +description: "Installation instructions to install {{% ctx %}} Innovation across multiple on-premise servers with high availability (HA)." weight: 40 --- -This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. +This guide describes how to install {{% ctx %}} Innovation. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. [PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index cb82f3ee3..dd277aa0e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been completed before starting this installation. +This guide describes how to install the Application Servers and Load Balancer Server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}} Innovation][] have been completed before starting this installation. ## Install Microsoft .NET Framework 4.7.2 @@ -320,6 +320,6 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServerNew" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} -[Pre-Installation steps for installing {{% ctx %}}]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} +[Pre-Installation steps for installing {{% ctx %}} Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index 4c3bd6573..45445f8c2 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -50,7 +50,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during the Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during the Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md index c44cf9869..cbf5e6675 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md @@ -57,7 +57,7 @@ Log on to Gateway and run through the setup wizard: 1. Assign access permissions to Active Directory groups: To allow users to access the various roles within Gateway, it is first necessary to assign them the appropriate access rights. - Gateway currently supports four roles, but only two are relevant for {{% ctx %}}: + Gateway currently supports four roles, but only two are relevant for {{% ctx %}} Innovation: * Admin * Studio diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md index d7856da31..02448873e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/pre-installation.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +This guide describes how to perform the steps required before starting the installation of {{% ctx %}} Innovation. Please ensure that the [Requirements][] have been read and met before starting this installation. ## Make Installation Artefacts Available on all Servers @@ -15,7 +15,7 @@ This guide describes how to perform the steps required before starting the insta ## Obtain a {{% ctx %}} licence file -A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. To get a licence file and feature identifier take the following steps: @@ -38,7 +38,7 @@ To get a licence file and feature identifier take the following steps: MachineID: Fingerprint: - Please also include a suitable {{% ctx %}} feature identifier. + Please also include a suitable {{% ctx %}} Innovation feature identifier. ``` 1. On each Application Server and the Web Application Server: diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md index c51a79970..5cc0e2b4e 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md @@ -104,7 +104,7 @@ On the Web Application Server and each Application Server, the following Windows ### Installation User -On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} is built upon. +On all Application Servers, Web Application Server and Load Balancer Server, a domain user, which is a member of the Local Administrators group, must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the HA platform that {{% ctx %}} Innovation is built upon. ### IIS Application Pool User @@ -148,7 +148,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. +{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the servers and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md index c777a4e8c..2a6a8be40 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} for the first time." +description: "Information about trying out {{% ctx %}} Innovation for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} has now been verified and is ready to use. +1. {{% ctx %}} Innovation has now been verified and is ready to use. [Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md index cac1db940..3b8740fb0 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/_index.md @@ -1,7 +1,7 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Information about installing {{% ctx %}} on a single on-premise server without high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." +description: "Information about installing {{% ctx %}} Innovation on a single on-premise server without high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions." weight: 50 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md index fa9d41676..17f04f62a 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/_index.md @@ -1,10 +1,10 @@ --- title: "Installation" linkTitle: "Installation" -description: "Installation instructions to install {{% ctx %}} on a single on-premise server without high availability (HA)." +description: "Installation instructions to install {{% ctx %}} Innovation on a single on-premise server without high availability (HA)." weight: 40 --- -This guide describes how to install {{% ctx %}}. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. +This guide describes how to install {{% ctx %}} Innovation. Please ensure that the [Pre-Installation][PreInstallation] steps have been completed before starting the installation. [PreInstallation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md index ef7e67214..58f259d18 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}}][] have been completed before starting this installation. +This guide describes how to install the Application Server components on the server. Please ensure that the [Pre-Installation steps for installing {{% ctx %}} Innovation][] have been completed before starting this installation. ## Install Microsoft .NET Framework 4.7.2 @@ -57,5 +57,5 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusionsNew" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServerNew" >}} -[Pre-Installation steps for installing {{% ctx %}}]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} +[Pre-Installation steps for installing {{% ctx %}} Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} [Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md index 45552cf02..a09041787 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-web-application-server.md @@ -141,7 +141,7 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the {{% ctx %}} Gateway web.config.| + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Obtain a {{% ctx %}} licence file][] step during Pre-Installation, if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md index a0b5777ce..ac2f32116 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md @@ -27,7 +27,7 @@ Log on to Gateway and run through the setup wizard: * [LDAP Authorisation] 1. Follow the steps in the setup wizard to configure the relevant areas: - ### Account Details + ### Account Details 1. Click `Next Step`: {{< figure class="centre" src="/images/Gateway Setup1.png" title="Initial Setup Screen" >}} @@ -36,7 +36,7 @@ Log on to Gateway and run through the setup wizard: 1. Change the Administrator password to a unique, secret password and click `Next Step`: {{< figure class="centre" src="/images/Gateway Setup3.png" title="Change Password Screen" >}} - ### LDAP Connection + ### LDAP Connection 1. Enter the details of your Active Directory server and provide a Username and Password for a user with read access to it: @@ -57,7 +57,7 @@ Log on to Gateway and run through the setup wizard: 1. Assign access permissions to Active Directory groups: To allow users to access the various roles within Gateway, it is first necessary to assign them the appropriate access rights. - Gateway currently supports four roles, but only two are relevant for {{% ctx %}}: + Gateway currently supports four roles, but only two are relevant for {{% ctx %}} Innovation: * Admin * Studio diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md index 2e6cfbec3..b6352a6c2 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/pre-installation.md @@ -7,7 +7,7 @@ weight: 30 # {{% param title %}} -This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +This guide describes how to perform the steps required before starting the installation of {{% ctx %}} Innovation. Please ensure that the [Requirements][] have been read and met before starting this installation. ## Make Installation Artefacts Available @@ -15,7 +15,7 @@ This guide describes how to perform the steps required before starting the insta ## Obtain a {{% ctx %}} licence file -A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the server and it should contain that server's fingerprint. To get a licence file and feature identifier take the following steps: @@ -26,7 +26,7 @@ To get a licence file and feature identifier take the following steps: MachineID: Fingerprint: - Please also include a suitable {{% ctx %}} feature identifier. + Please also include a suitable {{% ctx %}} Innovation feature identifier. ``` 1. In a File Explorer, navigate to the Fingerprint generation folder inside the install file location, e.g. `C:\Install\Cortex Innovation {{< version >}} - Licence Fingerprint Generator Extract`. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md index 706a41aa5..f96e5daa8 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/requirements.md @@ -57,7 +57,7 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain the fingerprint for the Server. Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps. @@ -85,7 +85,7 @@ The following Windows Services must be running on the server: ### Installation User -A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} is built upon. +A domain user which is a member of the Local Administrators group on the server must be available to run the installation scripts. This is a prerequisite of Microsoft Service Fabric, which is the platform that {{% ctx %}} Innovation is built upon. ### IIS Application Pool User @@ -122,7 +122,7 @@ If adding the exclusions manually, the Process Exclusions should be done before ### Port Requirements -{{% ctx %}} and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. +{{% ctx %}} Innovation and Microsoft Service Fabric require a range of [firewall ports to be opened][Port Requirements] between the server and specific services. If you are using Windows Firewall, some ports are opened during installation and others are opened dynamically as needed. If any other firewall is used, it will be necessary to add the rules described in [Port Requirements][] to open the correct ports. diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md index 197626d07..9e093d657 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} for the first time." +description: "Information about trying out {{% ctx %}} Innovation for the first time." weight: 60 --- @@ -55,7 +55,7 @@ Test the platform by creating a new flow and executing it using the following st {{% alert title="Note" %}} If you used self-signed certificates when installing the server you will need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. The request should return a JSON object with the output variables of the flow e.g. `{ "Output": "2022-03-09T07:35:16+0000" }`. -1. {{% ctx %}} has now been verified and is ready to use. +1. {{% ctx %}} Innovation has now been verified and is ready to use. [Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGatewayNew" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} From c0e993aed1dcd5482a38a00a872a7baee8136d51 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 22 Jan 2025 13:55:51 +0000 Subject: [PATCH 19/19] final Innovation revert --- .../on-premise/install-innovation-only/_index.md | 2 +- .../multiple-server-with-ha/requirements.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md index 83af98ed7..926f2c897 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/_index.md @@ -1,7 +1,7 @@ --- title: "Install Innovation Only" linkTitle: "Install Innovation Only" -description: "Information about installing a {{% ctx %}} platform." +description: "Information about installing a {{% ctx %}} Innovation platform." weight: 10 --- diff --git a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md index 5cc0e2b4e..6a883faec 100644 --- a/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md +++ b/content/en/docs/2025.1/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/requirements.md @@ -64,7 +64,7 @@ The installation requires IP to hostname resolution to be available. Please ensu ## Licensing Requirements -A valid {{% ctx %}} licence file and {{% ctx %}} feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. +A valid {{% ctx %}} licence file and {{% ctx %}} Innovation feature identifier must be procured from {{% ctx %}}. The feature identifier is a GUID which will be used when configuring the Gateway installation. The licence file is needed when installing the Web Application server and it should contain fingerprints for the Web Application Server and each Application Server. Details on how to obtain these are specified during the [Pre-Installation][obtain licence file] steps.