Configure a Deployment Client

Deployment uses encrypted communications, which means you will firstly need to connect each deployment client to the System Management Server used by the deployment server (see Connect a Computer to a System Management Server).

To configure a deployment client you use Configurator. This allows you to enter the login credentials required to register the client.

Note: To configure a deployment client you need to have the deployment client components installed. This is an option on the Customize the default components page of the Plant SCADA installer.

Launch the Configurator at the completion of the installation procedure, or from the Windows™ Start menu (Programs | AVEVA | Configurator).

On the Security Roles page under Plant SCADA, make sure that your user account is assigned to the Deployment Administrator role, either directly or via an associated domain group (see Security Roles).

Note: The current user on a deployment client needs to be assigned to the Runtime Users role to run a deployment client. If this is not always possible, you can configure Runtime Manager to run as a service (see Configure a Runtime Computer for Deployment).

To configure a deployment client (on a local computer):

1. In the panel on the left side of the Configurator, select Plant SCADA | Deployment Server. The [START] page appears.

2. Select one of the following options:

   • Configure the Deployment Client - This option is available when no deployment client has been configured.

   • Update the configuration of the current Deployment Client - This option is available if a deployment client has been configured. The Deployment Client configuration needs to be updated whenever there is change in the System Management Server configuration.

   • Import configuration file from previous version of the Deployment Client - If you have an earlier version of the deployment client configured (from Plant SCADA 2016 or 2018), you can import the client settings. Browse for the following Configurator file in the provided field:

     "SE.Asb.Deployment.Node.WindowsService.exe.config".

     Note: The default location is "%PROGRAMDATA%\AVEVA Plant SCADA <VersionNumber>\Config"

3. Click Next. The CONNECT page appears.

   In the Deployment Server field, select the deployment server to which you would like to connect. If the name does not appear in the list, type the Windows computer name of the machine on which the System Management Server is installed.

   To change the deployment server to which a deployment client is connected, repeat the steps needed to configure a deployment client.

   If the deployment client is also configured as a deployment server, the deployment client should only connect to the local deployment server.

4. Click Next. The AUTHORIZE page appears.

   Enter the User Name and Password for the Windows user account that will be used to register the client computer with the deployment server.

   The user account you enter needs to be assigned to the Deployment Administrator role on the deployment server (either directly or via an associated domain group). For more information, see Security Roles.

   If the System Management Server is on a different computer to the Deployment Server, the user account also needs to be assigned to the 'Administrators' or 'aaAdministrators' group on the System Management Server.

5. Click Next. The SETTINGS page appears.

   On the SETTINGS page, you can set the Unpack Rate, and specify the location for the projects to be deployed.

   • In the Unpack rate (KB/s) field, enter a value between 0 and 2147483647 (0 being unrestricted). If you limit the unpack rate, your system will still be able to run other processes. This value may affect the overall duration of a deployment operation.

   • In the Deployed project location field, specify the folder path where the deployed projects from the Deployment Server will be stored. The default location is: %PROGRAMDATA%\AVEVA Plant SCADA <VersionNumber>\Deployment\Client\Projects. You can use the browse button to change the folder path.

6. Click Next. The FINISH page appears.

   This page informs you that the Configurator is ready to send a request to the deployment server for registration.

   If required, you can use the Previous button to make any changes to your settings before you initiate the registration process.

7. Click Configure.

   If registration is successful, the configured client information will be stored on the computer and a connection will be established. If registration is not successful, you will be notified via the Configuration Messages panel.

If there is any issues with deployment client activities, check that the NT Service\CitectDeploymentClient and NT Service\Citect Runtime Manager virtual service accounts have read and write permissions for the deployment client folder (%PROGRAMDATA%\AVEVA Plant SCADA <VersionNumber>\Deployment\Client).

Right click the Client folder, go to Properties | Security, and check that the permissions are assigned correctly.

See Also

Configure a Runtime Computer for Deployment

Connect a Computer to a System Management Server