diff --git a/content/en/blog/releases/2025.X/2025.5.md b/content/en/blog/releases/2025.X/2025.5.md index 971f1aa6b..c07d2c27e 100644 --- a/content/en/blog/releases/2025.X/2025.5.md +++ b/content/en/blog/releases/2025.X/2025.5.md @@ -647,10 +647,10 @@ Releases are currently forecast to be made available on: [Tutorials - License Consumption]: {{< url path="Cortex.Tutorials.Administration.LicenseConsumption.MainDoc" version="2025.5" >}} [Tutorials - Studio Import]: {{< url path="Cortex.Tutorials.Administration.StudioImport.MainDoc" version="2025.5" >}} [Tutorials - Studio Export]: {{< url path="Cortex.Tutorials.Administration.StudioExport.MainDoc" version="2025.5" >}} -[Disable Code Analyser - Single Node]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.DisableCodeAnalyser" version="2025.5" >}} -[Update Allowed list - Single Node]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpdateAllowedList" version="2025.5" >}} -[Disable Code Analyser - Multi Node]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.DisableCodeAnalyser" version="2025.5" >}} -[Update Allowed list - Multi Node]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpdateAllowedList" version="2025.5" >}} +[Disable Code Analyser - Single Node]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.SingleServerWithoutHA.DisableCodeAnalyser" version="2025.5" >}} +[Update Allowed list - Single Node]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.SingleServerWithoutHA.UpdateCodeAnalyser" version="2025.5" >}} +[Disable Code Analyser - Multi Node]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.MultipleServerWithHA.DisableCodeAnalyser" version="2025.5" >}} +[Update Allowed list - Multi Node]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.MultipleServerWithHA.UpdateCodeAnalyser" version="2025.5" >}} [Extended the _executionContext with additional properties]: {{< ref "#extended-the-_executioncontext-with-additional-properties" >}} [Added support for the {{% ctx %}} Interaction Portal to provide separate credentials for querying AD Groups]: {{< ref "#added-support-for-the-cortex-interaction-portal-to-provide-separate-credentials-for-querying-ad-groups" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md index 494f3f69f..14b90efbf 100644 --- a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md @@ -133,7 +133,7 @@ None [Package Versions]: {{< ref "#package-versions" >}} [Time Period]: {{< ref "#time-period" >}} -[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth">}} +[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth.MainDoc">}} [Package Management]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.Overview.MainDoc" >}} [Running Executions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.RunningExecutions" >}} [Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}} diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/_index.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/_index.md new file mode 100644 index 000000000..3574aa6fa --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/_index.md @@ -0,0 +1,8 @@ +--- +title: "How do I configure the code analyser?" +linkTitle: "How do I configure the code analyser?" +description: "Instructions on how to configure the code analyser to allow flows to be run." +weight: 200 +--- + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/_index.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/_index.md new file mode 100644 index 000000000..7648e0464 --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/_index.md @@ -0,0 +1,6 @@ +--- +title: "Multiple Server With HA" +linkTitle: "Multiple Server With HA" +description: "Instructions on how to configure the code analyser on a multiple server cluster." +weight: 10 +--- diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/disable-code-analyser.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/disable-code-analyser.md new file mode 100644 index 000000000..3d723e9dd --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/disable-code-analyser.md @@ -0,0 +1,12 @@ +--- +title: "How do I disable the code analyser on a multiple server cluster?" +linkTitle: "How do I disable the code analyser on a multiple server cluster?" +description: "Instructions on how to disable the code analyser on a multiple server cluster." +weight: 20 +--- + +# Disable Code Analyser + +On each Application Server and the Web Application Server: + +{{< section "/configure-code-analyser/multi-server/disable-code-analyser.md" >}} diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/update-code-analyser.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/update-code-analyser.md new file mode 100644 index 000000000..55a0b9533 --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/multi-server-with-ha/update-code-analyser.md @@ -0,0 +1,10 @@ +--- +title: "How do I update the code analyser allowed list on a multiple server cluster?" +linkTitle: "How do I update the code analyser allowed list on a multiple server cluster?" +description: "Instructions on how to update the code analyser allowed list on a multiple server cluster." +weight: 10 +--- + +# Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/_index.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/_index.md new file mode 100644 index 000000000..2cb23ae24 --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/_index.md @@ -0,0 +1,6 @@ +--- +title: "Single Server Without HA" +linkTitle: "Single Server Without HA" +description: "Instructions on how to configure the code analyser on a single server cluster." +weight: 20 +--- diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/disable-code-analyser.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/disable-code-analyser.md new file mode 100644 index 000000000..d4abff218 --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/disable-code-analyser.md @@ -0,0 +1,12 @@ +--- +title: "How do I disable the code analyser on a single server cluster?" +linkTitle: "How do I disable the code analyser on a single server cluster?" +description: "Instructions on how to disable the code analyser on a single server cluster." +weight: 20 +--- + +# Disable Code Analyser + +On the Application Server: + +{{< section "/configure-code-analyser/single-server/disable-code-analyser.md" >}} diff --git a/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/update-code-analyser.md b/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/update-code-analyser.md new file mode 100644 index 000000000..50cb7ad95 --- /dev/null +++ b/content/en/docs/2025.5/FAQs/configure-code-analyser/single-server-without-ha/update-code-analyser.md @@ -0,0 +1,10 @@ +--- +title: "How do I update the code analyser allowed list on a single server cluster?" +linkTitle: "How do I update the code analyser allowed list on a single server cluster?" +description: "Instructions on how to update the code analyser allowed list on a single server cluster." +weight: 10 +--- + +# Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/_index.md new file mode 100644 index 000000000..1a5dad18a --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/_index.md @@ -0,0 +1,10 @@ +--- +title: "Post-Upgrade" +linkTitle: "Post-Upgrade" +description: "Information about the steps required to be completed after the upgrade of {{% ctx %}} has been completed." +weight: 50 +--- + +This guide describes how to perform the steps to verify the upgrade of {{% ctx %}} and perform final configuration. Please ensure that the [Upgrade][] has been completed before starting this section. + +[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.Upgrade" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/configure-code-analyser.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/configure-code-analyser.md new file mode 100644 index 000000000..05edf4ac6 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/configure-code-analyser.md @@ -0,0 +1,24 @@ +--- +title: "Configure Code Analyser" +linkTitle: "Configure Code Analyser" +description: "Information about configuring the code analyser to allow flows to be executed." +weight: 20 +--- + +# {{% param title %}} + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} + +The Code Analyser can either be [updated][Update Code Analyser] to allow required C# data types and namespaces, or it can be [disabled][Disable Code Analyser]. + +### Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} + +### Disable Code Analyser + +Instructions on how to disable the Code Analyser can be found [here][Disable Code Analyser FAQ]. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} +[Disable Code Analyser FAQ]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.MultipleServerWithHA.DisableCodeAnalyser" >}} \ No newline at end of file diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/try-it-out.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/try-it-out.md new file mode 100644 index 000000000..7a39ff551 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/try-it-out.md @@ -0,0 +1,29 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out {{% ctx %}} after upgrade." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to try out an upgraded {{% ctx %}} to make sure it is working. Please ensure that the [Upgrade Web Application Server][] has been completed before taking these steps. + +## Test Debugging Flows + +{{< section "/try-it-out/test-debugging-flows.md" >}} + +## Test Publishing Production Flows + +{{< section "/try-it-out/test-publishing-flows.md" >}} + +## Test Executing Production Flows + +{{< section "/try-it-out/multi-server/test-executing-production-flows.md" >}} + +## Next Steps? + +1. [Configure Code Analyser][] + +[Configure Code Analyser]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.ConfigureCodeAnalyser" >}} +[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out.md deleted file mode 100644 index 104c26b3f..000000000 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Try it out" -linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} after upgrade." -weight: 60 ---- - -# {{% param title %}} - -This guide describes how to try out an upgraded {{% ctx %}} to make sure it is working. Please ensure that both the [Application Servers and Load Balancer Upgrade][] and [Web Application Server Upgrade][] has been completed before taking these steps. - -## Test Debugging Flows - -{{< section "/upgrade/try-it-out/test-debugging-flows.md" >}} - -## Test Publishing Production Flows - -{{< section "/upgrade/try-it-out/test-publishing-flows.md" >}} - -## Test Executing Production Flows - -{{< section "/upgrade/try-it-out/multi-server/test-executing-production-flows.md" >}} - -[Application Servers and Load Balancer Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}} -[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md index 4094936d1..fb1acd9ea 100644 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md @@ -55,20 +55,6 @@ To check the previous configuration values open the `Cortex.Upgrade.ApplicationC {{< section "/upgrade/2025.5/upgrade-application-server/multi-server/run-upgrade-script.md" >}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/upgrade/upgrade-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/upgrade/upgrade-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On each of the Application Servers: - -{{< section "/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md" >}} - ## Check Application Services {{< section "/upgrade/upgrade-application-server/multi-server/check-application-services.md" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md index 1cee5d6eb..599952246 100644 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md @@ -15,7 +15,7 @@ This guide describes how to upgrade {{% ctx %}} Interaction Portal. Please ensur ## Next Steps? -1. [Try It Out][] +1. [Post-Upgrade][] [Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeGateway" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.TryItOut" >}} +[Post-Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.PostUpgrade" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md index 3424d9302..e0d4a9b21 100644 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md @@ -17,20 +17,6 @@ This guide describes how to upgrade the Flow Debugger on the Web Application Ser {{< section "/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md">}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/upgrade/upgrade-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/upgrade/upgrade-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On the Web Application Server: - -{{< section "/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md" >}} - ## Check Application Services {{< section "/upgrade/upgrade-application-server/single-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/_index.md new file mode 100644 index 000000000..66e1c8208 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/_index.md @@ -0,0 +1,10 @@ +--- +title: "Post-Upgrade" +linkTitle: "Post-Upgrade" +description: "Information about the steps required to be completed after the upgrade of {{% ctx %}} has been completed." +weight: 50 +--- + +This guide describes how to perform the steps to verify the upgrade of {{% ctx %}} and perform final configuration. Please ensure that the [Upgrade][] has been completed before starting this section. + +[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.Upgrade" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/configure-code-analyser.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/configure-code-analyser.md new file mode 100644 index 000000000..6bd2e03f8 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/configure-code-analyser.md @@ -0,0 +1,24 @@ +--- +title: "Configure Code Analyser" +linkTitle: "Configure Code Analyser" +description: "Information about configuring the code analyser to allow flows to be executed." +weight: 20 +--- + +# {{% param title %}} + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} + +The Code Analyser can either be [updated][Update Code Analyser] to allow required C# data types and namespaces, or it can be [disabled][Disable Code Analyser]. + +### Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} + +### Disable Code Analyser + +Instructions on how to disable the Code Analyser can be found [here][Disable Code Analyser FAQ]. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} +[Disable Code Analyser FAQ]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.SingleServerWithoutHA.DisableCodeAnalyser" >}} \ No newline at end of file diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/try-it-out.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/try-it-out.md new file mode 100644 index 000000000..e8aadd585 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/try-it-out.md @@ -0,0 +1,29 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out {{% ctx %}} after upgrade." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to try out an upgraded {{% ctx %}} to make sure it is working. Please ensure that the [Upgrade Web Application Server][] has been completed before taking these steps. + +## Test Debugging Flows + +{{< section "/try-it-out/test-debugging-flows.md" >}} + +## Test Publishing Production Flows + +{{< section "/try-it-out/test-publishing-flows.md" >}} + +## Test Executing Production Flows + +{{< section "/try-it-out/single-server/test-executing-production-flows.md" >}} + +## Next Steps? + +1. [Configure Code Analyser][] + +[Configure Code Analyser]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.ConfigureCodeAnalyser" >}} +[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out.md deleted file mode 100644 index 734212196..000000000 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Try it out" -linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} after upgrade." -weight: 60 ---- - -# {{% param title %}} - -This guide describes how to try out an upgraded {{% ctx %}} to make sure it is working. Please ensure that both the [Application Server Upgrade][] and [Web Application Server Upgrade][] has been completed before taking these steps. - -## Test Debugging Flows - -{{< section "/upgrade/try-it-out/test-debugging-flows.md" >}} - -## Test Publishing Production Flows - -{{< section "/upgrade/try-it-out/test-publishing-flows.md" >}} - -## Test Executing Production Flows - -{{< section "/upgrade/try-it-out/single-server/test-executing-production-flows.md" >}} - -[Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeApplicationServer" >}} -[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md index 332f495fd..e2f2c598c 100644 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md @@ -21,20 +21,6 @@ The Application Server will be reinstalled as part of the upgrade. As a result p {{< section "/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md" >}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/upgrade/upgrade-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/upgrade/upgrade-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On the Application Server: - -{{< section "/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md" >}} - ## Check Application Services {{< section "/upgrade/upgrade-application-server/single-server/check-application-services.md" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md index 48056aa8b..4b87ffa4e 100644 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md @@ -15,7 +15,7 @@ This guide describes how to upgrade {{% ctx %}} Interaction Portal. Please ensur ## Next Steps? -1. [Try It Out][] +1. [Post-Upgrade][] [Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeGateway" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.TryItOut" >}} +[Post-Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.PostUpgrade" >}} diff --git a/content/en/docs/2025.5/Guides/user-guides/user-interfaces/gateway/ops/overview.md b/content/en/docs/2025.5/Guides/user-guides/user-interfaces/gateway/ops/overview.md index 494f3f69f..14b90efbf 100644 --- a/content/en/docs/2025.5/Guides/user-guides/user-interfaces/gateway/ops/overview.md +++ b/content/en/docs/2025.5/Guides/user-guides/user-interfaces/gateway/ops/overview.md @@ -133,7 +133,7 @@ None [Package Versions]: {{< ref "#package-versions" >}} [Time Period]: {{< ref "#time-period" >}} -[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth">}} +[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth.MainDoc">}} [Package Management]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.Overview.MainDoc" >}} [Running Executions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.RunningExecutions" >}} [Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}} diff --git a/content/en/docs/2025.5/_shared/configure-code-analyser/_index.md b/content/en/docs/2025.5/_shared/configure-code-analyser/_index.md new file mode 100644 index 000000000..3574aa6fa --- /dev/null +++ b/content/en/docs/2025.5/_shared/configure-code-analyser/_index.md @@ -0,0 +1,8 @@ +--- +title: "How do I configure the code analyser?" +linkTitle: "How do I configure the code analyser?" +description: "Instructions on how to configure the code analyser to allow flows to be run." +weight: 200 +--- + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/configure-code-analyser.md b/content/en/docs/2025.5/_shared/configure-code-analyser/configure-code-analyser.md similarity index 55% rename from content/en/docs/2025.5/_shared/install-application-server/configure-code-analyser.md rename to content/en/docs/2025.5/_shared/configure-code-analyser/configure-code-analyser.md index 94cd07907..ed438703c 100644 --- a/content/en/docs/2025.5/_shared/install-application-server/configure-code-analyser.md +++ b/content/en/docs/2025.5/_shared/configure-code-analyser/configure-code-analyser.md @@ -1,8 +1,3 @@ A Code Analyser used to restrict what C# code can be executed from flows within {{% ctx %}} has been installed. It is enabled and secure by default, restricting all C# data types and namespaces other than those required to run an empty flow. {{% alert title="Warning" color="warning" %}}This security feature WILL prevent any flows, other than an empty flow, from running.{{< /alert >}} - -It can either be [disabled][Disable Code Analyser], or it's configured Allowed list can be [updated][Update Code Analyser] to allow required C# data types and namespaces. - -[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} -[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} diff --git a/content/en/docs/2025.5/_shared/configure-code-analyser/multi-server/disable-code-analyser.md b/content/en/docs/2025.5/_shared/configure-code-analyser/multi-server/disable-code-analyser.md new file mode 100644 index 000000000..3684a05d9 --- /dev/null +++ b/content/en/docs/2025.5/_shared/configure-code-analyser/multi-server/disable-code-analyser.md @@ -0,0 +1,22 @@ +1. Open a File Explorer. +1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.{{% execpkgversion %}}` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. +1. Open the `appsettings.json` file in a text editor. +1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. +1. Save and close the file. +1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.{{% execpkgversion %}}` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. +1. Repeat steps 3 - 5. +1. Open a web browser. +1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. + + {{% alert title="Note" %}} +If a certificate error occurs, it will be necessary to import the client certificate used in the `ClientCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" title="Configuring the Installation Script" >}} on the Application Servers or the certificate used in the `ServerCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureDebuggerInstallationScript" title="Configuring the Flow Debugger Installation Script" >}} on the Web Application Server. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.MultiServer" title="here" >}}. + {{% /alert %}} + +1. Expand `Cluster` then `Nodes`. +1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. + +Once the all the nodes have been restarted, it is necessary to re-check the cluster health. Instructions on how to do this can be found [here][Check Application Server Cluster Health] for the Application Servers and [here][Check Flow Debugger Cluster Health] for the Flow Debugger. + +[Check Application Server Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth.MultiServer.ViewClusterHealth" >}} +[Check Flow Debugger Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth.SingleServer.ViewClusterHealth" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-only/disable-code-analyser.md b/content/en/docs/2025.5/_shared/configure-code-analyser/single-server/disable-code-analyser.md similarity index 61% rename from content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-only/disable-code-analyser.md rename to content/en/docs/2025.5/_shared/configure-code-analyser/single-server/disable-code-analyser.md index cb6b471d8..6e0cbce28 100644 --- a/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-only/disable-code-analyser.md +++ b/content/en/docs/2025.5/_shared/configure-code-analyser/single-server/disable-code-analyser.md @@ -1,9 +1,9 @@ 1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. +1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.{{% execpkgversion %}}` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. 1. Open the `appsettings.json` file in a text editor. 1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. 1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. +1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.{{% execpkgversion %}}` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. 1. Repeat steps 3 - 5. 1. Open a web browser. 1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. @@ -15,4 +15,7 @@ If a certificate error occurs, it will be necessary to import the certificate us 1. Expand `Cluster` then `Nodes`. 1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} +Once the node has been restarted, it is necessary to re-check the cluster health. Instructions on how to do this can be found [here][Check Application Server Cluster Health]. + +[Check Application Server Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth.SingleServer.ViewClusterHealth" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/update-code-analyser.md b/content/en/docs/2025.5/_shared/configure-code-analyser/update-code-analyser.md similarity index 100% rename from content/en/docs/2025.5/_shared/install-application-server/update-code-analyser.md rename to content/en/docs/2025.5/_shared/configure-code-analyser/update-code-analyser.md diff --git a/content/en/docs/2025.5/_shared/executionPackageCurrentVersion.md b/content/en/docs/2025.5/_shared/executionPackageCurrentVersion.md new file mode 100644 index 000000000..e63c7a29b --- /dev/null +++ b/content/en/docs/2025.5/_shared/executionPackageCurrentVersion.md @@ -0,0 +1 @@ +27.3.1.25310 \ No newline at end of file diff --git a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-only/disable-code-analyser.md b/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-only/disable-code-analyser.md deleted file mode 100644 index 59f2472c8..000000000 --- a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-only/disable-code-analyser.md +++ /dev/null @@ -1,18 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the client certificate used in the `ClientCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" title="Configuring the Installation Script" >}}. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.MultiServer" title="here" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-only/disable-debugger-code-analyser.md b/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-only/disable-debugger-code-analyser.md deleted file mode 100644 index acc9ad9c8..000000000 --- a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-only/disable-debugger-code-analyser.md +++ /dev/null @@ -1,18 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the certificate used in the `ServerCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureDebuggerInstallationScript" title="Configuring the Installation Script" >}}. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.MultiServer" title="here" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-to-7.2/disable-code-analyser.md b/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-to-7.2/disable-code-analyser.md deleted file mode 100644 index ef5295857..000000000 --- a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-to-7.2/disable-code-analyser.md +++ /dev/null @@ -1,18 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the client certificate used in the `ClientCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScriptNew" title="Configuring the Installation Script" >}}. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.MultiServer" title="here" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-to-7.2/disable-debugger-code-analyser.md b/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-to-7.2/disable-debugger-code-analyser.md deleted file mode 100644 index 8c01e6fe5..000000000 --- a/content/en/docs/2025.5/_shared/install-application-server/multi-server/add-innovation-to-7.2/disable-debugger-code-analyser.md +++ /dev/null @@ -1,18 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the certificate used in the `ServerCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureDebuggerInstallationScript" title="Configuring the Installation Script" >}}. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.MultiServer" title="here" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-to-7.2/disable-code-analyser.md b/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-to-7.2/disable-code-analyser.md deleted file mode 100644 index 9302e114e..000000000 --- a/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-to-7.2/disable-code-analyser.md +++ /dev/null @@ -1,18 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the certificate used in the `ServerCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureInstallationScriptNew" title="Configuring the Installation Script" >}}. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.SingleServer" title="here" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} diff --git a/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-to-7.2/disable-debugger-code-analyser.md b/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-to-7.2/disable-debugger-code-analyser.md deleted file mode 100644 index bbb1ef174..000000000 --- a/content/en/docs/2025.5/_shared/install-application-server/single-server/add-innovation-to-7.2/disable-debugger-code-analyser.md +++ /dev/null @@ -1,18 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the `CustomerName` configured during [installation][Configure Installation Script], `` with the NETBIOS name of the server and `` with the highest number in the directory. -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the client certificate used in the `ServerCertificatePath` parameter when {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureDebuggerInstallationScript" title="Configuring the Installation Script" >}}. Instructions on how to do this can be found {{< ahref path="Cortex.Faqs.ImportClientCertificate.SingleServer" title="here" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} diff --git a/content/en/docs/2025.5/_shared/try-it-out/multi-server/test-executing-production-flows.md b/content/en/docs/2025.5/_shared/try-it-out/multi-server/test-executing-production-flows.md new file mode 100644 index 000000000..56740dc2c --- /dev/null +++ b/content/en/docs/2025.5/_shared/try-it-out/multi-server/test-executing-production-flows.md @@ -0,0 +1,15 @@ +1. Open an HTTP client, such as [Postman](https://www.postman.com/downloads/). Make a request with the following format: + | Property | Value | + |---------------|-------------------------------------------------------------------------------------| + | Action | POST | + | URL | https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}
e.g. https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage| + | Content Type | application/json | + | Body | {} | + | Authentication| Basic | + | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services | + | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted) | + + {{% 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": "211ea792-7ef0-4b35-92cc-dc2d3581d8c1" }`. +1. {{% ctx %}} has now been verified and is ready to use. diff --git a/content/en/docs/2025.5/_shared/try-it-out/single-server/test-executing-production-flows.md b/content/en/docs/2025.5/_shared/try-it-out/single-server/test-executing-production-flows.md new file mode 100644 index 000000000..7721d233b --- /dev/null +++ b/content/en/docs/2025.5/_shared/try-it-out/single-server/test-executing-production-flows.md @@ -0,0 +1,15 @@ +1. Open an HTTP client, such as [Postman](https://www.postman.com/downloads/). Make a request with the following format: + | Property | Value | + |---------------|-------------------------------------------------------------------------------------| + | Action | POST | + | URL | https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}
e.g. https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage| + | Content Type | application/json | + | Body | {} | + | Authentication| Basic | + | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services | + | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted) | + + {{% 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": "211ea792-7ef0-4b35-92cc-dc2d3581d8c1" }`. +1. {{% ctx %}} has now been verified and is ready to use. diff --git a/content/en/docs/2025.5/_shared/try-it-out/test-debugging-flows.md b/content/en/docs/2025.5/_shared/try-it-out/test-debugging-flows.md new file mode 100644 index 000000000..05f41849d --- /dev/null +++ b/content/en/docs/2025.5/_shared/try-it-out/test-debugging-flows.md @@ -0,0 +1,24 @@ +Test the platform by creating a new flow and executing it using the following steps: + +1. Click on the `Dev` charm, then the `+` button and click `Group` to open a dialog. +1. Enter a name for the group, configure the `Permission Groups` and click `OK` to create the group. +1. Click on the group to open it (refresh the page if it does not appear). +1. Inside the group, click the `+` button again and click on `Activity` to open a dialog. If the menu item is not present, it means that the `FeatureFlags` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway. See [Troubleshooting][Troubleshooting No Innovation] for more information. +1. Enter a name for the flow, configure the `Permission Groups` and click `OK` to create the flow. +1. The flow should be displayed with a `Start Flow` block and `End Flow` block, if those blocks are not displayed see [Troubleshooting][Troubleshooting Flow No Blocks]. A list of block palettes should be displayed down the left hand side: + {{< figure src="/images/CORTEX Flow View.PNG" title="New Flow - Number of palettes may differ" >}} +1. Add a `Set Variable` block and connect it between the `Start Flow` and `End Flow` blocks. +1. Click the `Set Variable` block to open the Property Editor. +1. Set the `Value` property to the expression `new Guid.NewGuid()`. +1. Type `Result` into the `Variable` property and click `Create Result`. +1. In the Variables Grid, set `Is Output Variable?` to `true` for the new `Result` variable. +1. Add a breakpoint to the `End Flow` block and start the flow. An execution token should appear. + If the token does not appear, try refreshing the page. Failing that, see [Troubleshooting][Troubleshooting Flow Not Starting]. +1. Select the execution in the Executions Grid (bottom panel). +1. The `Result` variable displayed in the Variables Viewer (right panel) should show a GUID. +1. Continue or stop the execution. +1. Commit the flow. + +[Troubleshooting Flow Not Starting]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNotStarting" >}} +[Troubleshooting Flow No Blocks]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingFlowNoBlocks" >}} +[Troubleshooting No Innovation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoInnovation" >}} diff --git a/content/en/docs/2025.5/_shared/try-it-out/test-publishing-flows.md b/content/en/docs/2025.5/_shared/try-it-out/test-publishing-flows.md new file mode 100644 index 000000000..07bf421fe --- /dev/null +++ b/content/en/docs/2025.5/_shared/try-it-out/test-publishing-flows.md @@ -0,0 +1,6 @@ +1. Log in to Gateway with a user that has the `Admin` role. +1. Click on the `Admin` charm, then `Packages`. +1. Click `Add Package Definition`. Enter a package name and select the new flow to add to the package. Click `Save` to save the new package. +1. Click `Publish`. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy. See [Troubleshooting][Troubleshooting No Publish] for more information. + +[Troubleshooting No Publish]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoPublish" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md deleted file mode 100644 index eed944bc6..000000000 --- a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md +++ /dev/null @@ -1,19 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name configured during installation, `` with the NETBIOS name of the server and `` with the highest number in the directory. - {{% alert title="Note" %}} -To check the value to be used for Customer Name open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. - {{% /alert %}} -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the client certificate used in the original installation. Follow instructions provided in Step 2 of {{< ahref path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.CheckApplicationServices" title="Check Application Services" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md deleted file mode 100644 index bc7e04ef2..000000000 --- a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md +++ /dev/null @@ -1,19 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name configured during installation, `` with the NETBIOS name of the server and `` with the highest number in the directory. - {{% alert title="Note" %}} -To check the value to be used for Customer Name open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. - {{% /alert %}} -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the client certificate used in the original installation. Follow instructions provided in Step 2 of {{< ahref path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.CheckDebuggerApplicationServices" title="Check Application Services" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md deleted file mode 100644 index dcd91ceb6..000000000 --- a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md +++ /dev/null @@ -1,19 +0,0 @@ -1. Open a File Explorer. -1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name configured during installation, `` with the NETBIOS name of the server and `` with the highest number in the directory. - {{% alert title="Note" %}} -To check the value to be used for Customer Name open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. - {{% /alert %}} -1. Open the `appsettings.json` file in a text editor. -1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. -1. Save and close the file. -1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.1.25310` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. -1. Repeat steps 3 - 5. -1. Open a web browser. -1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. - - {{% alert title="Note" %}} -If a certificate error occurs, it will be necessary to import the client certificate used in the original installation. Follow instructions provided in Step 2 of {{< ahref path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.CheckApplicationServices" title="Check Application Services" >}}. - {{% /alert %}} - -1. Expand `Cluster` then `Nodes`. -1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions. diff --git a/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/configure-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/configure-code-analyser.md deleted file mode 100644 index 226c4fda2..000000000 --- a/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/configure-code-analyser.md +++ /dev/null @@ -1,8 +0,0 @@ -This release introduces a new Code Analyser used to restrict what C# code can be executed from flows within {{% ctx %}}. It is enabled and secure by default, restricting all C# data types and namespaces other than those required to run an empty flow. - -{{% alert title="Warning" color="warning" %}}This security feature WILL break existing flows.{{< /alert >}} - -It can either be [disabled][Disable Code Analyser] to restore behaviour to that prior of this release, or it's configured Allowed list can be [updated][Update Code Analyser] to allow the required C# data types and namespaces. - -[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} -[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/update-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/update-code-analyser.md deleted file mode 100644 index bd75d1fdb..000000000 --- a/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/update-code-analyser.md +++ /dev/null @@ -1,3 +0,0 @@ -For assistance with configuring the Allowed list for the Code Analyser, please raise a case in the [{{% ctx %}} Service Portal][]. - -[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/content/en/docs/2025.5/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.5/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md index 0ab653084..4feecd4a5 100644 --- a/content/en/docs/2025.5/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.5/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 {{% ctx %}} 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 {{% ctx %}} installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlowNew" 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: diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 27f2eba45..0f8752b85 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -298,24 +298,10 @@ More advanced configuration (such as changing ports) can be undertaken by modify If the errors do not give any instructions on how to rectify, see [Troubleshooting During Installation][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. -## Configure {{% ctx %}} Code Analyser - -{{< section "/install-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/install-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On each of the Application Servers: - -{{< section "/install-application-server/multi-server/add-innovation-to-7.2/disable-code-analyser.md" >}} - ## Check Application Services 1. Log on to the Application Server. -1. If not already done so, import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. 1. Open a web browser. 1. {{< section "/install-application-server/multi-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index 204f02379..8d848c9c3 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -43,24 +43,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc {{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/install-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/install-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On the Web Application Server: - -{{< section "/install-application-server/multi-server/add-innovation-to-7.2/disable-debugger-code-analyser.md" >}} - ## Check Application Services 1. Log on to the Web Application Server. -1. If not already done so, import the certificate, used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Import the certificate, used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. 1. Open a web browser. 1. {{< section "/install-application-server/single-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/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.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md index d7c37a6bb..556634b31 100644 --- a/content/en/docs/2025.5/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.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation.md @@ -112,7 +112,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway on {{% ctx %}} 7 to incl ## Next Steps? -1. [Try it out][] +1. [Post-Installation][] [Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AssignCertificateFriendlyNameNew2" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} @@ -123,4 +123,4 @@ This guide describes how to upgrade {{% ctx %}} Gateway on {{% ctx %}} 7 to incl [Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallationNew" >}} [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" >}} +[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PostInstallation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/_index.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/_index.md new file mode 100644 index 000000000..2a1aeed4f --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Post-Installation" +linkTitle: "Post-Installation" +description: "Information about the steps required to be completed after the addition of {{% ctx %}} has finished." +weight: 50 +--- + +This guide describes how to perform the steps to verify the addition of {{% ctx %}} and perform final configuration. Please ensure that the [Installation][] has been completed before starting this section. + +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Installation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/configure-code-analyser.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/configure-code-analyser.md new file mode 100644 index 000000000..05edf4ac6 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/configure-code-analyser.md @@ -0,0 +1,24 @@ +--- +title: "Configure Code Analyser" +linkTitle: "Configure Code Analyser" +description: "Information about configuring the code analyser to allow flows to be executed." +weight: 20 +--- + +# {{% param title %}} + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} + +The Code Analyser can either be [updated][Update Code Analyser] to allow required C# data types and namespaces, or it can be [disabled][Disable Code Analyser]. + +### Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} + +### Disable Code Analyser + +Instructions on how to disable the Code Analyser can be found [here][Disable Code Analyser FAQ]. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} +[Disable Code Analyser FAQ]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.MultipleServerWithHA.DisableCodeAnalyser" >}} \ No newline at end of file diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/try-it-out.md new file mode 100644 index 000000000..8f2d50e9c --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/try-it-out.md @@ -0,0 +1,29 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out {{% ctx %}} for the first time." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that [Upgrade Gateway][] has been completed before taking these steps. + +## Test Debugging Flows + +{{< section "/try-it-out/test-debugging-flows.md" >}} + +## Test Publishing Production Flows + +{{< section "/try-it-out/test-publishing-flows.md" >}} + +## Test Executing Production Flows + +{{< section "/try-it-out/multi-server/test-executing-production-flows.md" >}} + +## Next Steps? + +1. [Configure Code Analyser][] + +[Configure Code Analyser]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCodeAnalyser" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallationNew" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md deleted file mode 100644 index 4d6ea1883..000000000 --- a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/try-it-out.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "Try it out" -linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} 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. - -## Test Debugging Flows - -Test the platform by creating a new flow and executing it using the following steps: - -1. Click on the `Dev` charm, then the `+` button and click `Group` to open a dialog. -1. Enter a name for the group, configure the `Permission Groups` and click `OK` to create the group. -1. Click on the group to open it (refresh the page if it does not appear). -1. Inside the group, click the `+` button again and click on `Activity` to open a dialog. If the menu item is not present, it means that the `FeatureFlags` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway. See [Troubleshooting][Troubleshooting No Innovation] for more information. -1. Enter a name for the flow, configure the `Permission Groups` and click `OK` to create the flow. -1. The flow should be displayed with a `Start Flow` block and `End Flow` block, if those blocks are not displayed see [Troubleshooting][Troubleshooting Flow No Blocks]. A list of block palettes should be displayed down the left hand side: - {{< figure src="/images/CORTEX Flow View.PNG" title="New Flow - Number of palettes may differ" >}} -1. Add a `Set Variable` block and connect it between the `Start Flow` and `End Flow` blocks. -1. Click the `Set Variable` block to open the Property Editor. -1. Set the `Value` property to the expression `DateTimeOffset.Now`. -1. Type `Result` into the `Variable` property and click `Create Result`. -1. In the Variables Grid, set `Is Output Variable?` to `true` for the new `Result` variable. -1. Add a breakpoint to the `End Flow` block and start the flow. An execution token should appear. - If the token does not appear, try refreshing the page. Failing that, see [Troubleshooting][Troubleshooting Flow Not Starting]. -1. Select the execution in the Executions Grid (bottom panel). -1. The `Result` variable displayed in the Variables Viewer (right panel) should show the current time. -1. Continue or stop the execution. -1. Commit the flow. - -## Test Publishing Production Flows - -1. Log in to Gateway with a user that has the `Admin` role. -1. Click on the `Admin` charm, then `Packages`. -1. Click `Add Package Definition`. Enter a package name and select the new flow to add to the package. Click `Save` to save the new package. -1. Click `Publish`. A success message should appear. If it doesn't it means that either one or more of the parameters prefixed with `Service Fabric` in the `CortexGateway.SetParameters.xml` file was not set properly when updating Gateway, or the Application Services aren't healthy. See [Troubleshooting][Troubleshooting No Publish] for more information. - -## Test Executing Production Flows - -1. Open an HTTP client, such as [Postman](https://www.postman.com/downloads/). Make a request with the following format: - | Property | Value | - |---------------|-------------------------------------------------------------------------------------| - | Action | POST | - | URL | https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}
e.g. https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage| - | Content Type | application/json | - | Body | {} | - | Authentication| Basic | - | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services | - | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted) | - - {{% 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. - -[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" >}} -[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.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md index 213b19aab..d7775eada 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md @@ -43,24 +43,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc {{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/install-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/install-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On the Application Server: - -{{< section "/install-application-server/single-server/add-innovation-to-7.2/disable-code-analyser.md" >}} - ## Check Application Services 1. Log on to the Application Server. -1. If not already done so, import the certificate used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Import the certificate used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. 1. Open a web browser. 1. {{< section "/install-application-server/single-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md index ef6c867c4..d0f9f683f 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server.md @@ -188,7 +188,7 @@ Ensure that the installation files are backed up or kept on the server, especial ## Next Steps? -1. [Try it out][] +1. [Post-Installation][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} @@ -200,4 +200,4 @@ Ensure that the installation files are backed up or kept on the server, especial [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" >}} +[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PostInstallation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/_index.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/_index.md new file mode 100644 index 000000000..8b5cb0485 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Post-Installation" +linkTitle: "Post-Installation" +description: "Information about the steps required to be completed after the addition of {{% ctx %}} has finished." +weight: 50 +--- + +This guide describes how to perform the steps to verify the addition of {{% ctx %}} and perform final configuration. Please ensure that the [Installation][] has been completed before starting this section. + +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Installation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/configure-code-analyser.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/configure-code-analyser.md new file mode 100644 index 000000000..6bd2e03f8 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/configure-code-analyser.md @@ -0,0 +1,24 @@ +--- +title: "Configure Code Analyser" +linkTitle: "Configure Code Analyser" +description: "Information about configuring the code analyser to allow flows to be executed." +weight: 20 +--- + +# {{% param title %}} + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} + +The Code Analyser can either be [updated][Update Code Analyser] to allow required C# data types and namespaces, or it can be [disabled][Disable Code Analyser]. + +### Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} + +### Disable Code Analyser + +Instructions on how to disable the Code Analyser can be found [here][Disable Code Analyser FAQ]. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} +[Disable Code Analyser FAQ]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.SingleServerWithoutHA.DisableCodeAnalyser" >}} \ No newline at end of file diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/try-it-out.md new file mode 100644 index 000000000..60b697bc7 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/try-it-out.md @@ -0,0 +1,29 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out {{% ctx %}} for the first time." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that [Upgrade Gateway][] has been completed before taking these steps. + +## Test Debugging Flows + +{{< section "/try-it-out/test-debugging-flows.md" >}} + +## Test Publishing Production Flows + +{{< section "/try-it-out/test-publishing-flows.md" >}} + +## Test Executing Production Flows + +{{< section "/try-it-out/single-server/test-executing-production-flows.md" >}} + +## Next Steps? + +1. [Configure Code Analyser][] + +[Configure Code Analyser]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCodeAnalyser" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.UpgradeGatewayNew" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md deleted file mode 100644 index 9a22a1807..000000000 --- a/content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "Try it out" -linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} 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. - -## Test Debugging Flows - -Test the platform by creating a new flow and executing it using the following steps: - -1. Click on the `Dev` charm, then the `+` button and click `Group` to open a dialog. -1. Enter a name for the group, configure the `Permission Groups` and click `OK` to create the group. -1. Click on the group to open it (refresh the page if it does not appear). -1. Inside the group, click the `+` button again and click on `Activity` to open a dialog. If the menu item is not present, it means that the `FeatureFlags` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway. See [Troubleshooting][Troubleshooting No Innovation] for more information. -1. Enter a name for the flow, configure the `Permission Groups` and click `OK` to create the flow. -1. The flow should be displayed with a `Start Flow` block and `End Flow` block, if those blocks are not displayed see [Troubleshooting][Troubleshooting Flow No Blocks]. A list of block palettes should be displayed down the left hand side: - {{< figure src="/images/CORTEX Flow View.PNG" title="New Flow - Number of palettes may differ" >}} -1. Add a `Set Variable` block and connect it between the `Start Flow` and `End Flow` blocks. -1. Click the `Set Variable` block to open the Property Editor. -1. Set the `Value` property to the expression `DateTimeOffset.Now`. -1. Type `Result` into the `Variable` property and click `Create Result`. -1. In the Variables Grid, set `Is Output Variable?` to `true` for the new `Result` variable. -1. Add a breakpoint to the `End Flow` block and start the flow. An execution token should appear. - If the token does not appear, try refreshing the page. Failing that, see [Troubleshooting][Troubleshooting Flow Not Starting]. -1. Select the execution in the Executions Grid (bottom panel). -1. The `Result` variable displayed in the Variables Viewer (right panel) should show the current time. -1. Continue or stop the execution. -1. Commit the flow. - -## Test Publishing Production Flows - -1. Log in to Gateway with a user that has the `Admin` role. -1. Click on the `Admin` charm, then `Packages`. -1. Click `Add Package Definition`. Enter a package name and select the new flow to add to the package. Click `Save` to save the new package. -1. Click `Publish`. A success message should appear. If it doesn't it means that either one or more of the parameters prefixed with `Service Fabric` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway, or the Application Services aren't healthy. See [Troubleshooting][Troubleshooting No Publish] for more information. - -## Test Executing Production Flows - -1. Open an HTTP client, such as [Postman](https://www.postman.com/downloads/). Make a request with the following format: - | Property | Value | - |---------------|-------------------------------------------------------------------------------------| - | Action | POST | - | URL | https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}
e.g. https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage| - | Content Type | application/json | - | Body | {} | - | Authentication| Basic | - | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services | - | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted) | - - {{% 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. - -[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" >}} -[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.AddInnovationTo72WebApplicationServerNew" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md index 8e60d6f7a..260ea6fa0 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.5/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 {{% ctx %}} 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 {{% ctx %}} installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlowNew" 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: diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index b1ec5555c..b27238442 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -298,24 +298,10 @@ More advanced configuration (such as changing ports) can be undertaken by modify If the errors do not give any instructions on how to rectify, see [Troubleshooting During Installation][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. -## Configure {{% ctx %}} Code Analyser - -{{< section "/install-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/install-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On each of the Application Servers: - -{{< section "/install-application-server/multi-server/add-innovation-only/disable-code-analyser.md" >}} - ## Check Application Services 1. Log on to one of the Application Servers. -1. If not already done so, import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. 1. Open a web browser. 1. {{< section "/install-application-server/multi-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index 509d01f1e..030e5b536 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -43,24 +43,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc {{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/install-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/install-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On the Web Application Server: - -{{< section "/install-application-server/multi-server/add-innovation-only/disable-debugger-code-analyser.md" >}} - ## Check Application Services 1. Log on to the Web Application Server. -1. If not already done so, import the certificate used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Import the certificate used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. 1. Open a web browser. 1. {{< section "/install-application-server/single-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md index c44cf9869..50249252c 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/setup-gateway.md @@ -74,11 +74,11 @@ Log on to Gateway and run through the setup wizard: ## Next Steps? -1. [Try it out][] +1. [Post-Installation][] [Account Details]: {{< ref "#account-details" >}} [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.WebBrowserRequirementsNew" >}} -[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOut" >}} +[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PostInstallation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/_index.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/_index.md new file mode 100644 index 000000000..4f5047d9b --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Post-Installation" +linkTitle: "Post-Installation" +description: "Information about the steps required to be completed after the installation has finished." +weight: 50 +--- + +This guide describes how to perform the steps to verify the installation of {{% ctx %}} and perform final configuration. Please ensure that the [Installation][] has been completed before starting this section. + +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Installation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/configure-code-analyser.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/configure-code-analyser.md new file mode 100644 index 000000000..05edf4ac6 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/configure-code-analyser.md @@ -0,0 +1,24 @@ +--- +title: "Configure Code Analyser" +linkTitle: "Configure Code Analyser" +description: "Information about configuring the code analyser to allow flows to be executed." +weight: 20 +--- + +# {{% param title %}} + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} + +The Code Analyser can either be [updated][Update Code Analyser] to allow required C# data types and namespaces, or it can be [disabled][Disable Code Analyser]. + +### Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} + +### Disable Code Analyser + +Instructions on how to disable the Code Analyser can be found [here][Disable Code Analyser FAQ]. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} +[Disable Code Analyser FAQ]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.MultipleServerWithHA.DisableCodeAnalyser" >}} \ No newline at end of file diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/try-it-out.md new file mode 100644 index 000000000..08dd30dec --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/try-it-out.md @@ -0,0 +1,29 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out {{% ctx %}} for the first time." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that [Setup Gateway][] has been completed before taking these steps. + +## Test Debugging Flows + +{{< section "/try-it-out/test-debugging-flows.md" >}} + +## Test Publishing Production Flows + +{{< section "/try-it-out/test-publishing-flows.md" >}} + +## Test Executing Production Flows + +{{< section "/try-it-out/multi-server/test-executing-production-flows.md" >}} + +## Next Steps? + +1. [Configure Code Analyser][] + +[Configure Code Analyser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCodeAnalyser" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md deleted file mode 100644 index b732fcf0b..000000000 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "Try it out" -linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} 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 [Setup Gateway][] has been completed before taking these steps. - -## Test Debugging Flows - -Test the platform by creating a new flow and executing it using the following steps: - -1. Click on the `Dev` charm, then the `+` button and click `Group` to open a dialog. -1. Enter a name for the group, configure the `Permission Groups` and click `OK` to create the group. -1. Click on the group to open it (refresh the page if it does not appear). -1. Inside the group, click the `+` button again and click on `Activity` to open a dialog. If the menu item is not present, it means that the `FeatureFlags` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway. See [Troubleshooting][Troubleshooting No Innovation] for more information. -1. Enter a name for the flow, configure the `Permission Groups` and click `OK` to create the flow. -1. The flow should be displayed with a `Start Flow` block and `End Flow` block, if those blocks are not displayed see [Troubleshooting][Troubleshooting Flow No Blocks]. A list of block palettes should be displayed down the left hand side: - {{< figure src="/images/CORTEX Flow View.PNG" title="New Flow - Number of palettes may differ" >}} -1. Add a `Set Variable` block and connect it between the `Start Flow` and `End Flow` blocks. -1. Click the `Set Variable` block to open the Property Editor. -1. Set the `Value` property to the expression `DateTimeOffset.Now`. -1. Type `Result` into the `Variable` property and click `Create Result`. -1. In the Variables Grid, set `Is Output Variable?` to `true` for the new `Result` variable. -1. Add a breakpoint to the `End Flow` block and start the flow. An execution token should appear. - If the token does not appear, try refreshing the page. Failing that, see [Troubleshooting][Troubleshooting Flow Not Starting]. -1. Select the execution in the Executions Grid (bottom panel). -1. The `Result` variable displayed in the Variables Viewer (right panel) should show the current time. -1. Continue or stop the execution. -1. Commit the flow. - -## Test Publishing Production Flows - -1. Log in to Gateway with a user that has the `Admin` role. -1. Click on the `Admin` charm, then `Packages`. -1. Click `Add Package Definition`. Enter a package name and select the new flow to add to the package. Click `Save` to save the new package. -1. Click `Publish`. A success message should appear. If it doesn't it means that either one or more of the parameters prefixed with `Service Fabric` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway, or the Application Services aren't healthy. See [Troubleshooting][Troubleshooting No Publish] for more information. - -## Test Executing Production Flows - -1. Open an HTTP client, such as [Postman](https://www.postman.com/downloads/). Make a request with the following format: - | Property | Value | - |---------------|-------------------------------------------------------------------------------------| - | Action | POST | - | URL | https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}
e.g. https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage| - | Content Type | application/json | - | Body | {} | - | Authentication| Basic | - | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services | - | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted) | - - {{% 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. - -[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" >}} -[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" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md index 5299b177d..cafafd4f5 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md @@ -43,24 +43,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc {{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -## Configure {{% ctx %}} Code Analyser - -{{< section "/install-application-server/configure-code-analyser.md" >}} - -### Update Code Analyser Allowed List - -{{< section "/install-application-server/update-code-analyser.md" >}} - -### Disable Code Analyser - -On the Application Server: - -{{< section "/install-application-server/single-server/add-innovation-only/disable-code-analyser.md" >}} - ## Check Application Services 1. Log on to the Application Server. -1. If not already done so, import the certificate used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Import the certificate used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. 1. Open a web browser. 1. {{< section "/install-application-server/single-server/check-application-services.md">}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md index ea7732ed2..a3053860a 100644 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/setup-gateway.md @@ -74,11 +74,11 @@ Log on to Gateway and run through the setup wizard: ## Next Steps? -1. [Try it out][] +1. [Post-Installation][] [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.InstallWebApplicationServerNew" >}} [supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.WebBrowserRequirementsNew" >}} -[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOut" >}} +[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PostInstallation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/_index.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/_index.md new file mode 100644 index 000000000..a1de01556 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/_index.md @@ -0,0 +1,10 @@ +--- +title: "Post-Installation" +linkTitle: "Post-Installation" +description: "Information about the steps required to be completed after the installation has finished." +weight: 50 +--- + +This guide describes how to perform the steps to verify the installation of {{% ctx %}} and perform final configuration. Please ensure that the [Installation][] has been completed before starting this section. + +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Installation" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/configure-code-analyser.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/configure-code-analyser.md new file mode 100644 index 000000000..6bd2e03f8 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/configure-code-analyser.md @@ -0,0 +1,24 @@ +--- +title: "Configure Code Analyser" +linkTitle: "Configure Code Analyser" +description: "Information about configuring the code analyser to allow flows to be executed." +weight: 20 +--- + +# {{% param title %}} + +{{< section "/configure-code-analyser/configure-code-analyser.md" >}} + +The Code Analyser can either be [updated][Update Code Analyser] to allow required C# data types and namespaces, or it can be [disabled][Disable Code Analyser]. + +### Update Code Analyser Allowed List + +{{< section "/configure-code-analyser/update-code-analyser.md" >}} + +### Disable Code Analyser + +Instructions on how to disable the Code Analyser can be found [here][Disable Code Analyser FAQ]. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} +[Disable Code Analyser FAQ]: {{< url path="Cortex.Faqs.ConfigureCodeAnalyser.SingleServerWithoutHA.DisableCodeAnalyser" >}} \ No newline at end of file diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/try-it-out.md new file mode 100644 index 000000000..5050d97c0 --- /dev/null +++ b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/try-it-out.md @@ -0,0 +1,29 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out {{% ctx %}} for the first time." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that [Setup Gateway][] has been completed before taking these steps. + +## Test Debugging Flows + +{{< section "/try-it-out/test-debugging-flows.md" >}} + +## Test Publishing Production Flows + +{{< section "/try-it-out/test-publishing-flows.md" >}} + +## Test Executing Production Flows + +{{< section "/try-it-out/single-server/test-executing-production-flows.md" >}} + +## Next Steps? + +1. [Configure Code Analyser][] + +[Configure Code Analyser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCodeAnalyser" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGatewayNew" >}} diff --git a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md b/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md deleted file mode 100644 index 5b49eff33..000000000 --- a/content/en/docs/2025.5/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "Try it out" -linkTitle: "Try it out" -description: "Information about trying out {{% ctx %}} 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 [Setup Gateway][] has been completed before taking these steps. - -## Test Debugging Flows - -Test the platform by creating a new flow and executing it using the following steps: - -1. Click on the `Dev` charm, then the `+` button and click `Group` to open a dialog. -1. Enter a name for the group, configure the `Permission Groups` and click `OK` to create the group. -1. Click on the group to open it (refresh the page if it does not appear). -1. Inside the group, click the `+` button again and click on `Activity` to open a dialog. If the menu item is not present, it means that the `FeatureFlags` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway. See [Troubleshooting][Troubleshooting No Innovation] for more information. -1. Enter a name for the flow, configure the `Permission Groups` and click `OK` to create the flow. -1. The flow should be displayed with a `Start Flow` block and `End Flow` block, if those blocks are not displayed see [Troubleshooting][Troubleshooting Flow No Blocks]. A list of block palettes should be displayed down the left hand side: - {{< figure src="/images/CORTEX Flow View.PNG" title="New Flow - Number of palettes may differ" >}} -1. Add a `Set Variable` block and connect it between the `Start Flow` and `End Flow` blocks. -1. Click the `Set Variable` block to open the Property Editor. -1. Set the `Value` property to the expression `DateTimeOffset.Now`. -1. Type `Result` into the `Variable` property and click `Create Result`. -1. In the Variables Grid, set `Is Output Variable?` to `true` for the new `Result` variable. -1. Add a breakpoint to the `End Flow` block and start the flow. An execution token should appear. - If the token does not appear, try refreshing the page. Failing that, see [Troubleshooting][Troubleshooting Flow Not Starting]. -1. Select the execution in the Executions Grid (bottom panel). -1. The `Result` variable displayed in the Variables Viewer (right panel) should show the current time. -1. Continue or stop the execution. -1. Commit the flow. - -## Test Publishing Production Flows - -1. Log in to Gateway with a user that has the `Admin` role. -1. Click on the `Admin` charm, then `Packages`. -1. Click `Add Package Definition`. Enter a package name and select the new flow to add to the package. Click `Save` to save the new package. -1. Click `Publish`. A success message should appear. If it doesn't it means that either one or more of the parameters prefixed with `Service Fabric` in the `CortexGateway.SetParameters.xml` file was not set properly when installing Gateway, or the Application Services aren't healthy. See [Troubleshooting][Troubleshooting No Publish] for more information. - -## Test Executing Production Flows - -1. Open an HTTP client, such as [Postman](https://www.postman.com/downloads/). Make a request with the following format: - | Property | Value | - |---------------|-------------------------------------------------------------------------------------| - | Action | POST | - | URL | https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}
e.g. https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage| - | Content Type | application/json | - | Body | {} | - | Authentication| Basic | - | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services | - | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted) | - - {{% 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. - -[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" >}} -[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" >}} diff --git a/content/static/2025.5/pdf/Installation Checklists - Multiple Server With HA.pdf b/content/static/2025.5/pdf/Installation Checklists - Multiple Server With HA.pdf index 2a93c68f7..9ddaaccee 100644 Binary files a/content/static/2025.5/pdf/Installation Checklists - Multiple Server With HA.pdf and b/content/static/2025.5/pdf/Installation Checklists - Multiple Server With HA.pdf differ diff --git a/content/static/2025.5/pdf/Installation Checklists - Single Server Without HA.pdf b/content/static/2025.5/pdf/Installation Checklists - Single Server Without HA.pdf index 5adc4876d..b99432d55 100644 Binary files a/content/static/2025.5/pdf/Installation Checklists - Single Server Without HA.pdf and b/content/static/2025.5/pdf/Installation Checklists - Single Server Without HA.pdf differ diff --git a/content/static/word/Installation Checklists - Multiple Server With HA.docx b/content/static/word/Installation Checklists - Multiple Server With HA.docx index a843a5fb2..a41856ca8 100644 Binary files a/content/static/word/Installation Checklists - Multiple Server With HA.docx and b/content/static/word/Installation Checklists - Multiple Server With HA.docx differ diff --git a/content/static/word/Installation Checklists - Single Server Without HA.docx b/content/static/word/Installation Checklists - Single Server Without HA.docx index 462e5a126..a56a90467 100644 Binary files a/content/static/word/Installation Checklists - Single Server Without HA.docx and b/content/static/word/Installation Checklists - Single Server Without HA.docx differ diff --git a/data/urls.toml b/data/urls.toml index 9f38a6c33..3e9e0d89b 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -259,11 +259,28 @@ ProductPortal = "/blog/2022/10/27/2022.9/#product-portal" [Cortex.Faqs] MainDoc = "/docs/faqs/" - CheckClusterHealth = "/docs/faqs/check-cluster-health/" + [Cortex.Faqs.CheckClusterHealth] + MainDoc = "/docs/faqs/check-cluster-health/" + [Cortex.Faqs.CheckClusterHealth.MultiServer] + MainDoc = "/docs/faqs/check-cluster-health/multi-server-with-ha" + ViewClusterHealth = "/docs/faqs/check-cluster-health/multi-server-with-ha/#view-cluster-health" + [Cortex.Faqs.CheckClusterHealth.SingleServer] + MainDoc = "/docs/faqs/check-cluster-health/single-server-without-ha" + ViewClusterHealth = "/docs/faqs/check-cluster-health/single-server-without-ha/#view-cluster-health" [Cortex.Faqs.ImportClientCertificate] MainDoc = "/docs/faqs/import-client-certificate/" MultiServer = "/docs/faqs/import-client-certificate/multi-server-with-ha" SingleServer = "/docs/faqs/import-client-certificate/single-server-without-ha" + [Cortex.Faqs.ConfigureCodeAnalyser] + MainDoc = "/docs/faqs/configure-code-analyser/" + [Cortex.Faqs.ConfigureCodeAnalyser.MultipleServerWithHA] + MainDoc = "/docs/faqs/configure-code-analyser/multi-server-with-ha" + UpdateCodeAnalyser = "/docs/faqs/configure-code-analyser/multi-server-with-ha/update-code-analyser" + DisableCodeAnalyser = "/docs/faqs/configure-code-analyser/multi-server-with-ha/disable-code-analyser" + [Cortex.Faqs.ConfigureCodeAnalyser.SingleServerWithoutHA] + MainDoc = "/docs/faqs/configure-code-analyser/single-server-without-ha" + UpdateCodeAnalyser = "/docs/faqs/configure-code-analyser/single-server-without-ha/update-code-analyser" + DisableCodeAnalyser = "/docs/faqs/configure-code-analyser/single-server-without-ha/disable-code-analyser" [Cortex.GettingStarted] MainDoc = "/docs/getting-started/" [Cortex.GettingStarted.OnPremise] @@ -294,6 +311,7 @@ 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" + ConfigureCodeAnalyser = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/configure-code-analyser" 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" @@ -326,13 +344,16 @@ 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" + PostInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-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" 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" + TryItOutNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/try-it-out" TryItOutPublishedFlow = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/try-it-out/#test-publishing-production-flows" + TryItOutPublishedFlowNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/post-installation/try-it-out/#test-publishing-production-flows" 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" @@ -346,6 +367,7 @@ 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" + ConfigureCodeAnalyser = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/configure-code-analyser" 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" @@ -365,13 +387,16 @@ 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" + PostInstallation = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-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" 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" + TryItOut = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out" + TryItOutNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/try-it-out" + TryItOutPublishedFlow = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/try-it-out/#test-publishing-production-flows" + TryItOutPublishedFlowNew = "/docs/getting-started/on-premise/install-innovation-only/single-server-without-ha/post-installation/try-it-out/#test-publishing-production-flows" 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] @@ -399,6 +424,7 @@ 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" + ConfigureCodeAnalyser = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/configure-code-analyser" 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" @@ -422,11 +448,13 @@ 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" + PostInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation" 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" + TryItOutNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/post-installation/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" @@ -439,6 +467,7 @@ 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" CertificateRequirementsNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/requirements#certificate-requirements" + ConfigureCodeAnalyser = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation/configure-code-analyser" 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" @@ -450,11 +479,13 @@ 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" ObtainLicence = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/pre-installation#obtain-a-cortex-licence-file" + PostInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/post-installation" 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" + UpgradeGatewayNew = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-web-application-server" [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation] MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/" [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana] @@ -922,30 +953,28 @@ MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/" [Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA] MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/" + CheckApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers/#check-application-services" + CheckDebuggerApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger/#check-application-services" + ConfigureCodeAnalyser = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade/configure-code-analyser" + PostUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/post-upgrade" PreUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/pre-upgrade" - TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out" Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers" UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip" UpgradeDebugger = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger" - UpdateAllowedList = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger/#update-code-analyser-allowed-list" - DisableCodeAnalyser = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger/#disable-code-analyser" UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server" - CheckApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers/#check-application-services" - CheckDebuggerApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger/#check-application-services" [Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA] MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/" + CheckApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server/#check-application-services" + ConfigureCodeAnalyser = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade/configure-code-analyser" + PostUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/post-upgrade" PreUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/pre-upgrade" - TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out" Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade" UpgradeApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server" - UpdateAllowedList = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server/#update-code-analyser-allowed-list" - DisableCodeAnalyser = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server/#disable-code-analyser" UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip" UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server" - CheckApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server/#check-application-services" [Cortex.Guides.UpgradeGuides.UpgradeObservability] MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/" [Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise] diff --git a/layouts/shortcodes/execpkgversion.html b/layouts/shortcodes/execpkgversion.html new file mode 100644 index 000000000..d243888a3 --- /dev/null +++ b/layouts/shortcodes/execpkgversion.html @@ -0,0 +1,27 @@ +{{/* + This shortcode provides a single point to the Execution Service package version in docs. + This only works in files under /docs/. +*/}} +{{- /* Get the current version, setting to latest if not in a versioned page. */}} +{{- $isNested := false }} +{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }} +{{- if (not $currentVer) }} + {{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }} + {{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }} + {{- if (not $currentVer) }} + {{ range where .Site.Params.versions "latest" true }} + {{- $currentVer = .url }} + {{ end }} + {{- end }} +{{- end }} +{{- $filePath := printf "%s%s" $currentVer "_shared/executionPackageCurrentVersion.md" -}} +{{- $page := .Site.GetPage $filePath -}} +{{- with $page -}} + {{- with .Plain -}} + {{- (trim . "\n") -}} + {{- else -}} + {{ errorf "version.html: Version file at path %q is empty" $filePath }} + {{- end -}} +{{- else -}} + {{ errorf "version.html: Version file at path %q is missing" $filePath }} +{{- end -}} \ No newline at end of file