Skip to content

Feature/update code analyser instructions #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/en/blog/releases/2025.X/2025.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
8 changes: 8 additions & 0 deletions content/en/docs/2025.5/FAQs/configure-code-analyser/_index.md
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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">}}
Expand Down
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Loading