uc4config.xml

In this configuration file, you define the connections to the AE systems that the AE Plug‑in and its perspectives can access. Without this configuration, you will not be able to work with the perspectives of the AE Plug‑in

Related Components

The following AWI plug-ins
- Administration Plug-in
- Dashboards Plug-in
- AE Plug‑in
Automation Engine backend

Description

AWI uses the as its backend product. AE provides AWI the databases as well as all object types and object definitions. The uc4config.xml is where you define one or more AE systems that AWI users can log into. Whether users can select an AE connection or are restricted to only the first connection that is defined here, depends on how the "automationEngine.index" property in the configuration.properties file is set.

File location

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

Steps

In your Tomcat web server go to the folder …\webapps\<AWI>\config,
Rename the file uc4config.xml.sample to uc4config.xml.
Some configuration files are delivered with the extension "sample" to ensure that your existing configuration files will not be overwritten when you update the AWI installation.
Open the renamed file and update the configurations as described in the table that follows.
For the changes to take effect, stop and restart your Tomcat web server.

Structure

The table that follows explains the structure of the file and describes the parameters and settings with their possible values.

Parameters	Description
<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. For information about the various logging and tracing options in AWI, as well as steps for collecting log data when reporting an error to Automic support, see "Preparing Log Files for Error Reporting."
<connections>	The beginning of the elements for the connections to AE systems.
<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. system = The name of the AE system. This is defined in the Automation Engine's INI file. Important: Every connection must have a unique definition of system and 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.
<cp ip="DNS/IP" port="Port"/>	Definition of the connection to the AE system's communication process (CP). DNS/IP = Specifies the name or the IP address of the computer on which the communication process runs. Port = Port number of the communication processes in the AE system. If you define more than one CP for a connection, the system will try to connect to the first CP in the list, and if it fails, then the system will try the next and so on, until it can connect successfully. For more information about the communication processes in AE, see "Establishing a Connection" in the Inside Automation Engine help or PDF.
</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:

</connection>

</connection>

</connections>

</configuration>