uc4config.xml - Configuring the Connection Between AWI and AE

AWI uses the Automation Engine as its backend product. AE provides AWI with databases, object types and object definitions. In the uc4config.xml configuration file you define the AE systems to which AWI can connect.

If you are using self-signed certificates, you can use the trustedCertFolder= parameter to define the path to the folder where the trusted certificates are stored. Otherwise, the certificates should be installed in the Java trust store. For more information, see Securing Connections to the AE (TLS/SSL) and Preparing TLS/SSL Certificates.

In the Automic Automation Kubernetes Edition, any changes to the configuration file uc4config.xml must be done in the awi-properties section of the configmap. For more information, see Configuring Container-Based Systems.

In configuration.properties you define whether the users will be able to select one of the connections that you configure here, or if only one connection will be available for them. For more information, see automationEngine.index.

The changes that you make to the uc4config.xml file take effect after logging out and back in.

Note: Some configuration files are delivered with an additional ".sample" extension to ensure that your existing configuration files will not be overwritten when you update the AWI installation. You can remove ".sample" and adapt the parameters in these files or you can use the old, already configured files.

This page includes the following:

File location

After you have installed the AWI, you find this configuration file in your application server, in the ...\<AWI>\config folder.

Defining the Connection to the AE Systems

  1. In your application server go to the …\<AWI>\config folder .
  2. Rename the uc4config.xml.sample file to uc4config.xml.
  3. Open the renamed file and update the configuration as described in the list below.
  4. For the changes to take effect, log out and log in back again.

Structure

This list explains the structure of the uc4config.xml file and describes the parameters and settings with their possible values.

  • <configuration>

    The beginning of the configuration

  • <trace count="count" xml="XML trace"></trace>

    Options for the trace file for the AE API calls. This logs the communication between AE and AWI from the AWI point of view.

  • <connections trustedCertFolder="">

    If you are using self-signed certificates, define the location of the folder for trusted certificates used for TLS/SSL connections. For more information, see Securing Connections to the AE (TLS/SSL) and Preparing TLS/SSL Certificates.

  • <connection name=name" system="system">

    Define one <connection> element for each AE system that you want this AWI instance to be able to connect to.

    • name = An alias for the connection to an AE system. When logging into AWI, this is the name that appears in the Connection field and in its drop-down selection list.

      Important: Every connection must have a unique connection name.

    • system = The name of the AE system. This is defined in the Automation Engine INI file.

      Important: Every connection must have a unique system name.

    For more than one <connection> element: By default, when users log into AWI they can choose the connection for the system they want to log into. However, you can force all users to log into a particular connection. To do this, specify the connection in the automationEngine.index parameter in the configuration.properties file. Change the default setting of "-1" (all connections available) to the value for the connection you want. This is a 0-indexed parameter, so "0" means the first connection that is defined, "1" means the second connection, and so on. For more information, see configuration.properties - Configuring Your Local Setup.

  • <cp ip="DNS/IP" port="Port"/>

    Definition of the connection to the AE system's Java communication process (JCP). For more information, see Java Communication Process.

    • DNS/IP = Name or the IP address of the computer on which the communication process runs.
    • Port = Port number of the Java communication processes in the AE system. You define the ports in the WS.PORT parameter in the [PORTS] section of the Automation Engine INI file. For more information, see Configuring Firewall and Ports.

  • </connection>

    The ending of the XML element <connection>

  • </connections>

    The ending of the XML element <connections>

  • </configuration>

    The ending of the XML element <configuration>

Example 

<configuration>
  <connections trustedCertFolder="C:\AWA\truststore">
    <connection name="UC4" system="UC4">
       <cp ip="vviecapam01" port="8443"/>
    </connection>
  </connections>
</configuration>

Next

You have configured the connection between AWI and the Automation Engine and its components. Now you can configure how the communication between the Automation Engine and the AWI server, and AWI and its Clients should run. For more information, see configuration.properties - Configuring Your Local Setup.