Add Configurator Settings to a Response File
- Last UpdatedFeb 05, 2024
- 4 minute read
You can add a section to a response file that allows you to preconfigure the settings that are available in Configurator for Plant SCADA (and other AVEVA components).
To do this, define a new section within a response file using the following tags:
<configurator> <configurator/>
You can then use the information in the following tables to define the settings for each page in Configurator when running a silent installation.
Note: You cannot configure the authentication settings for an Industrial Graphics Server during a silent installation. If you silently install an Industrial Graphics Server, you will need to manually adjust its settings in Configurator. See Use Configurator to Set Up an Industrial Graphics Server.
You can determine the success of a silent installation using the XML log file located
at:
C:\Program Files (x86)\Common Files\ArchestrA\SilentConfigurator
Security Roles page
|
Configurator Setting |
Options |
Response file syntax |
|
Security Role Members |
Role:User,User; Role needs to be one of the following: • ConfigUsers User needs to be: • A local user: ".\<UserName>" or "<ComputerName>\<UserName>" • A local Windows group: ".\<GroupName>" or "<ComputerName>\<GroupName>" • A domain group user: • A domain group: |
Plant SCADA. Examples To add UserA and UserB to ConfigUsers: Plant SCADA. To add UserA and UserB to ConfigUsers and ServerUsers: Plant SCADA. |
Using a response file to add members to a security role has the following limitations:
-
Adding NT Service accounts is not supported.
-
If you modify a role, all existing users will be removed (except for any existing NT Service accounts).
-
If no valid users are specified for a role, the role will not be modified.
-
If the limit of 10 users per role is exceeded in the response file, only the first 10 users will be added. This means if you try to add 12 users, the last two will be ignored.
Computer Setup page
|
Configurator Setting |
Options |
Response file syntax |
|
Configure Server Password |
True or false. |
Plant SCADA. |
|
Password / |
A valid password. |
Plant SCADA.ComputerSetup.ServerPassword= |
|
Project Run Path |
True = Run the project deployed from the Deployment Server. False = Run the project selected in Plant SCADA Studio. |
Plant SCADA.ComputerSetup.DeploymentEnabled= |
|
Run Runtime Manager as a Service |
True or false. |
Plant SCADA.ComputerSetup.RuntimeAsService= |
Encryption page
|
Configurator Setting |
Options |
Response file syntax |
|
Enable Encryption |
True or false. |
Plant SCADA.Encryption.IsEncryptionEnabled= |
|
Accept encrypted and non-encrypted connections |
True or false. |
Plant SCADA.Encryption.AcceptLegacyConnections= |
Deployment Server page
|
Configurator Setting |
Options |
Response file syntax |
|
AUTHORIZE User Name |
A valid user name. |
Plant SCADA.DeploymentServer.UserNameValue= |
|
AUTHORIZE Password |
A valid password. |
Plant SCADA.ComputerSetup.ServerPassword= |
|
SETTINGS Password |
A valid password. |
Plant SCADA. |
|
SETTINGS Confirm Password |
A valid password. |
Plant SCADA. |
Deployment Client page
|
Configurator Setting |
Options |
Response file syntax |
|
CONNECT Deployment Server |
A valid Windows computer name for the deployment server. |
Plant SCADA.DeploymentClient.SelectedServer= |
|
AUTHORIZE User Name |
A valid user name. |
Plant SCADA.DeploymentClient.UserNameValue= |
|
AUTHORIZE Password |
A valid password. |
Plant SCADA. |
|
SETTINGS Unpack Rate |
Zero (0). |
Plant SCADA.DeploymentClient.UnpackRateValue= |
|
SETTINGS Deployed project location |
A valid path to the deployed project location. |
Plant SCADA. |
OPCUA Server page
|
Configurator Setting |
Options |
Response file syntax |
|
Port Number |
A valid port number. The default is 48031 |
Plant SCADA.OpcUaServer.Port= |
|
Enable encrypted communications |
True or false. |
Plant SCADA.OpcUaServer.EnableEncryption= |
|
Allow anonymous access |
True or false. |
Plant SCADA.OpcUaServer.EnableAuthentication= |
|
Disable property and extension |
True or false. |
Plant SCADA.OpcUaServer. |
See Use Configurator to Set Up an OPC UA Server.
AVEVA Enterprise License Server page
|
Configurator Setting |
Options |
Response file syntax |
|
Primary Server Name |
A valid Windows computer name |
AVEVA Enterprise Licensing. |
|
Server Port |
A valid port number. The default is 55559. |
AVEVA Enterprise Licensing. |
|
Agent Port |
A valid port number. The default is 59200. |
AVEVA Enterprise Licensing. |
|
Legacy Port |
A valid port number. The default is 55555. |
AVEVA Enterprise Licensing. |
See Use Configurator to Set Up an Enterprise License Server.
System Management Server page
|
Configurator Setting |
Options |
Response file syntax |
|
System Management Server location |
0 = None (No SMS configured) 1 = Remote (Connect to an existing SMS) 2 = Local (This machine is the SMS) |
Common Platform. |
|
Connect to an existing System Management Server |
A valid Windows computer name. |
Common Platform. |
|
Configure this machine as a redundant SSO Server |
True or false. |
Common Platform. |
|
Advanced Configuration - Authentication |
0 = None 1 = Authenticate using embedded browser using popup dialog 2 = Authenticate using your default browser |
Common Platform. |
See Configure a System Management Server.
System Management Server - Advanced Configuration dialog
|
Configurator Setting |
Options |
Response file syntax |
|
Certificates tab - Certificate Source |
True or false. |
Common Platform. |
|
Certificates tab - System Management Server |
A valid Windows computer name |
Common Platform. |
|
Certificates tab - Port |
Port number. Default is 443. |
Common Platform. |
|
Ports tab - HTTP Port |
A valid port number. The default is 80 |
Common Platform.ASBRuntime.HttpPort= |
|
Ports tab - HTTPS Port |
A valid port number. The default is 443. |
Common Platform.ASBRuntime.HttpsPort= |
Example
The following is an example of the provided All.txt response file with Configurator settings included.
<responsefile>
<install>
ComputerRoleSelectionForm.SelectedComputerRoleName=DevelopmentWorkstation
FeaturesForm.SFeatureList=ALL
SecurityGroupForm.AddUserToGroups=true
FirewallForm.ModifyFireWall=true
CustomDestinationSelectionForm.InstallDirPath=C:\Program Files (x86)\AVEVA Plant SCADA
CustomDestinationSelectionForm.ProgramDataPath=C:\ProgramData\AVEVA Plant SCADA 2023 R2
</install>
<configurator>
AVEVA Enterprise Licensing.LicAPI2.NewServerName=
AVEVA Enterprise Licensing.LicAPI2.NewPortNumber=55559
AVEVA Enterprise Licensing.LicAPI2.LegacyPortNumber=55555
AVEVA Enterprise Licensing.LicAPI2.NewAgentPortNumber=59200
Common Platform.ASBRuntime.HttpPort=80
Common Platform.ASBRuntime.HttpsPort=443
Common Platform.ASBRuntime.ManagementServerPort=443
Common Platform.ASBRuntime.ManagementServerName=<ServerName>
Common Platform.ASBRuntime.AsbManagedCertificates=true
Common Platform.ASBRuntime.IsRedundantSsoServer =false
Common Platform.ASBRuntime.SuitelinkMixedModeEnabled=false
Common Platform.ASBRuntime.NmxAllowAllUsers=false
Plant SCADA.ComputerSetup.RuntimeAsService=false
Plant SCADA.ComputerSetup.PartOfTrustedNetwork=true
Plant SCADA.ComputerSetup.DeploymentEnabled=true
Plant SCADA.ComputerSetup.ServerPassword=<ServerPassword>
Plant SCADA.Encryption.IsEncryptionEnabled=true
Plant SCADA.Encryption.AcceptLegacyConnections=true
Plant SCADA.DeploymentServer.UserNameValue=<UserName>
Plant SCADA.DeploymentServer.UserPasswordValue=<Password>
Plant SCADA.DeploymentServer.DatabasePasswordValue=<Password>
Plant SCADA.DeploymentServer.ConfirmDatabasePasswordValue=<Password>
Plant SCADA.DeploymentClient.SelectedServer=<ServerName>
Plant SCADA.DeploymentClient.UserNameValue=<UserName>
Plant SCADA.DeploymentClient.UserPasswordValue=<Password>
Plant SCADA.DeploymentClient.UnpackRateValue=0
Plant SCADA.DeploymentClient.DeployedProjectPath=C:\ProgramData\AVEVA Plant SCADA 2023 R2\Deployment\Client\Projects
Plant SCADA.OpcUaServer.Port=48031
Plant SCADA.OpcUaServer.EnableEncryption=false
Plant SCADA.OpcUaServer.EnableAuthentication=true
Plant SCADA.OpcUaServer.DisablePropertyAndExtensionBrowsing=false
Plant SCADA.SecurityConfiguration.RoleMembers=
ConfigUsers:.\SCADA.ConfigUsers;
RuntimeUsers:.\SCADA.RuntimeUsers;
ServerUsers:.\SCADA.ServerUsers;
DeploymentAdmins:.\SCADA.DeploymentAdmins;
DeploymentUsers:.\SCADA.DeploymentUsers;
DeploymentUploaders:.\SCADA.DeploymentUploaders;
AIGUsers:.\AIGUsers;
AIGUsersRW:.\AIGUsersRW;
</configurator>
</responsefile>