Skip to content

Commit 142315a

Browse files
author
Donna-Marie Smith
committed
added Code Analyser instructions to install guides
1 parent 7d66fd8 commit 142315a

File tree

15 files changed

+228
-7
lines changed

15 files changed

+228
-7
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
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.
2+
3+
{{% alert title="Warning" color="warning" %}}This security feature WILL prevent any flows, other than an empty flow, from running.{{< /alert >}}
4+
5+
It can either be [disabled][Disable Code Analyser], or it's configured Allowed list can be [updated][Update Code Analyser] to allow the required C# data types and namespaces.
6+
7+
[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}}
8+
[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Open a File Explorer.
2+
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.
3+
1. Open the `appsettings.json` file in a text editor.
4+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
5+
1. Save and close the file.
6+
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.
7+
1. Repeat steps 3 - 5.
8+
1. Open a web browser.
9+
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.
10+
11+
{{% alert title="Note" %}}
12+
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" >}}.
13+
{{% /alert %}}
14+
15+
1. Expand `Cluster` then `Nodes`.
16+
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.
17+
18+
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
For assistance with configuring the Allowed list for the Code Analyser, please raise a case in the [{{% ctx %}} Service Portal][].
2+
3+
[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}

content/en/docs/2025.5/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,24 @@ More advanced configuration (such as changing ports) can be undertaken by modify
298298
299299
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.
300300
301+
## Configure {{% ctx %}} Code Analyser
302+
303+
{{< section "/install-application-server/configure-code-analyser.md" >}}
304+
305+
### Update Code Analyser Allowed List
306+
307+
{{< section "/install-application-server/update-code-analyser.md" >}}
308+
309+
### Disable Code Analyser
310+
311+
On each of the the Application Servers:
312+
313+
{{< section "/install-application-server/multi-server/add-innovation-to-7.2/disable-code-analyser.md" >}}
314+
301315
## Check Application Services
302316
303317
1. Log on to the Application Server.
304-
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].
318+
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].
305319
1. Open a web browser.
306320
1. {{< section "/install-application-server/multi-server/check-application-services.md">}}
307321

0 commit comments

Comments
 (0)