Skip to content

added Code Analyser instructions to install guides #220

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
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
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.7 to 2024.9. P
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.
Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Preserve installation files

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.
Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Republish Packages

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.
Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Republish Packages

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.
Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Republish Packages

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To check the previous configuration values open the `Cortex.Upgrade.ApplicationC

### Disable Code Analyser

On each of the the Application Servers:
On each of the Application Servers:

{{< section "/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ See the [Step the Execution][Step the Execution tutorial] tutorial for a step-by

### Stop the Execution

Clicking the {{< image src="/images/Flow Editor - Stop Execution.png" >}} icon stops the the selected executions, and after a few seconds, removes them from Executions Grid. This action is available for all executions, regardless of their state.
Clicking the {{< image src="/images/Flow Editor - Stop Execution.png" >}} icon stops the selected executions, and after a few seconds, removes them from Executions Grid. This action is available for all executions, regardless of their state.

See the [Continue and Stop the Execution][Continue and Stop the Execution tutorial] tutorial for a step-by-step guide.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ For information about the [supported values][ComparisonTypes] for the [Compariso

### Null or empty Text

If [Text][Text Property] is `null` or empty (i.e. `""`), the variable specified in the [Contains Any Text][ContainsAnyText Property] property is set to `false`.
If [Text][Text Property] is `null` or empty (i.e. `""`), the variable specified in the [Contains Any Text][ContainsAnyText Property] property is set to `false`.

### Null or empty Texts To Find

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ For information about the [supported values][ComparisonTypes] for the [Compariso

### Null or empty Text

If [Text][Text Property] is `null` or empty (i.e. `""`), the variable specified in the [Contains Text][ContainsText Property] property is set to `false`.
If [Text][Text Property] is `null` or empty (i.e. `""`), the variable specified in the [Contains Text][ContainsText Property] property is set to `false`.

### Null or empty Text To Find

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In this example `"users"` already exists and contains the following keys and dat

#### Result

Waiting for `"user2"` to contain [Value][Value Property] `{"Domain": "domain", "Username": "admin", "Password": "encryptedPassword"}` in the [Data Storage Collection][] results in the execution waiting until the the key `"user2"` contains the desired [Value][Value Property]; see [Write Data With Key][Write Data With Key].
Waiting for `"user2"` to contain [Value][Value Property] `{"Domain": "domain", "Username": "admin", "Password": "encryptedPassword"}` in the [Data Storage Collection][] results in the execution waiting until the key `"user2"` contains the desired [Value][Value Property]; see [Write Data With Key][Write Data With Key].

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ If `null` is provided as a file path in the [Attachments][] within the [Email Me

#### Empty file path

If an empty string is provided as a file path in the the [Attachments][] within the [Email Message][Email Message Property], an [ArgumentException][] is thrown.
If an empty string is provided as a file path in the [Attachments][] within the [Email Message][Email Message Property], an [ArgumentException][] is thrown.

#### File path does not exist

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ If `null` is provided as a file path in the [Attachments][] within the [Email Me

#### Empty file path

If an empty string is provided as a file path in the the [Attachments][] within the [Email Message][Email Message Property], an [ArgumentException][] is thrown.
If an empty string is provided as a file path in the [Attachments][] within the [Email Message][Email Message Property], an [ArgumentException][] is thrown.

#### File path does not exist

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ TODO
TODO:

- The literal editor will have one or more available types, these types will be either Complex or Basic Types
- The types available to the literal editor are restricted by the block property.
- The types available to the literal editor are restricted by the block property.
- It is possible to switch the type of the literal editor to any available type.

### Basic Types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ There are a number of ways to use variables:

## Variable Editor

The [Variable Editor][] allows the the developer to [create][] and [use][] variables whilst configuring a [block][].
The [Variable Editor][] allows the developer to [create][] and [use][] variables whilst configuring a [block][].

### Creating a Variable

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
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" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
1. Open a File Explorer.
1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App<n>\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the `CustomerName` configured during [installation][Configure Installation Script], `<NodeName>` with the NETBIOS name of the server and `<n>` 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\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the Customer Name and `<NodeName>` 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" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
1. Open a File Explorer.
1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App<n>\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the `CustomerName` configured during [installation][Configure Installation Script], `<NodeName>` with the NETBIOS name of the server and `<n>` 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\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the Customer Name and `<NodeName>` 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" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
1. Open a File Explorer.
1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App<n>\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the `CustomerName` configured during [installation][Configure Installation Script], `<NodeName>` with the NETBIOS name of the server and `<n>` 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\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the Customer Name and `<NodeName>` 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" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
1. Open a File Explorer.
1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App<n>\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the `CustomerName` configured during [installation][Configure Installation Script], `<NodeName>` with the NETBIOS name of the server and `<n>` 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\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the Customer Name and `<NodeName>` 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" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
1. Open a File Explorer.
1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App<n>\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the `CustomerName` configured during [installation][Configure Installation Script], `<NodeName>` with the NETBIOS name of the server and `<n>` 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\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the Customer Name and `<NodeName>` 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.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" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
1. Open a File Explorer.
1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App<n>\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the `CustomerName` configured during [installation][Configure Installation Script], `<NodeName>` with the NETBIOS name of the server and `<n>` 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\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `<CustomerName>` with the Customer Name and `<NodeName>` 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" >}}
Loading