Using the Web Client > The CitectSCADA Web Client > Configuring a deployment > Deploying a project from within CitectSCADA

Deploying a project from within CitectSCADA

The Web Client architecture lets you deploy a project from within the CitectSCADA configuration environment, avoiding the need to use the Web Client interface to setup a system.

This process requires you to adjust two parameters in the Citect.ini file:

These parameters identify the client component used with the project and the location of the deployment root directory. When the project is compiled and prepared for deployment, it is placed directly on the Web Server.


To deploy a project from within CitectSCADA:

  1. Confirm that your CitectSCADA system is configured to use TCP/IP. If you run the Computer Setup Wizard, the Networking page will identify which communications protocol is being used.
  2. Adjust the [WebServer]DeployRoot parameter within the Citect.ini file. This parameter represents the directory where the deployment will be located on the WebServer.
  3. If you have set up an IIS-based Web Server, the default location will be the Deploy directory within the installed directories. For example:

    DeployRoot="C:Program Files\Citect\CitectSCADA 7.10

    Note: When setting the [WebServer]DeployRoot ini parameter, the path needs to contain "deploy" as the last subfolder name, otherwise the deployment will be unsuccessful. Use a mapped drive instead of a UNC address if deploying to a network destination from a Windows 2000 system. Do not map a drive directly to the deployment location, as the path needs to finish with a "deploy" subfolder.

  4. Adjust the [WebServer]WebClientCab parameter within the Citect.ini file. This parameter represents the directory path and client component to use when a deployment is run, in relation to the installed Client directory. For example:
  5. [webserver]

    Note the use of a forward slash in the defined path.

  6. Compile your project and then prepare it for deployment. Go to the Citect Explorer Tools menu and select Web Deployment Preparation or select the following icon on the Explorer toolbar.
  7. Your project will now appear as a deployment within the Web Client home page next time you log in.

    Note: You can run the Web Deployment Preparation process automatically when you compile a project. To do this, go to the Citect Project Editor Tools menu and choose Options. Select the Prepare for Web Deployment option and click OK. Be aware, however, that this might increase the time necessary for a project to compile.

  8. Determine if any of the I/O, Alarms, Reports or Trends Servers associated with the project are protected by a firewall. If they are, you need to confirm with the firewall administrator if the CitectSCADA ports have been opened to allow direct access, or if the firewall is using port forwarding.
  9. If port forwarding is being used, you will need to log in to the Web Client as an Administrator, select the project, and then the Edit Deployment button:

    This will take you to the deployment configuration page.

  10. Identify each server that port forwarding is being used for by typing the name in the Server field, using the following format:
  11. <ClusterName>.<ServerName>

    If you have alarm properties enabled on an Alarm Server, you will need to configure an alarm properties connector as a separate server to let the Web Server know which port it is running on. Type the Alarm Server name in the Server field, using the following format:


    For example:


  12. Type in the Address and Port for each server, as supplied by the firewall administrator.
  13. Note: The Web Client will automatically add any servers that are redirected in this way to the [AddressForwarding] section of the local Citect.ini file. See Using address forwarding for more information.

    You can add additional servers to the list by selecting the Add New Server icon.

See Also