Systems.xml File Attributes

When you use the Client Configuration applet to configure a client - system connection, the settings you define are saved within the auto-generated Systems.xml file as attributes and values. If you create or edit a Systems.xml file manually, you can include the attributes in your file and also define their values.

Many of the elements in a Systems.xml file have attributes for which you can set values. The attributes correspond to the settings on the Client Configuration applet and the various displays you can access via the Client Configuration applet, such as the Advanced Settings window.

For each of the elements, you need to define or edit the attributes correctly:

• <Systems>—The <Systems> element has no attributes.
• <Default System>—Defines the name of the default system. If a system is not defined in the <System> attributes, the client will connect to the system specified as the Default System instead. The <Default System> corresponds to the Set as Default setting on the ClearSCADA Client Applet.

  For the <Default System> element, you need to define the name of the default system in the following format:

  <Default System="name of system" />

  Where name of system is the name of the default system, for example, <Default System="Main" /> sets the default system to the system named Main.

• <System>—Has attributes that correspond to the settings on the ClearSCADA Client Configuration window:
  • Name—The name of the system. This required string value corresponds to the System Name setting on the Client Configuration window Define the System Name and Type for a ViewX Client - System Connection.
  • Type—The type of system to which the client will connect. This required string value matches the Type setting on the ClearSCADA Client Configuration window and can be: ClearSCADA Server, OPC Data Server, OPC Historic Server, or OPC Alarm Server Define the System Name and Type for a ViewX Client - System Connection.
  • Enabled—Defines whether the system is online (enabled) or offline (disabled). This optional Boolean value corresponds to the Disable setting on the ClearSCADA Client Applet.
  • VisibleinViewX—Defines whether the client connection can be detected by ViewX. In some circumstances, you may want the client connection to only be available to Third Party OPC clients and not ViewX clients. This optional Boolean value corresponds to the Visible in ViewX setting on the Client Configuration window Define Whether the System is Visible in ViewX.
  • Clientlicensing—Defines whether the client uses client licensing. This optional Boolean value corresponds to the Use Client Licensing setting on the ClearSCADA Client Configuration window. When it is True, client licensing is enabled; when it is false, client licensing is disabled. For more information, Enable or Disable Client Licensing.
  • WorkstationName—The workstation name of the client. This optional string value corresponds to the Workstation Name setting on the Client Configuration window Define the Workstation Name for the ViewX Client.
• <Server>—Has attributes that correspond to the Node tab settings on the ClearSCADA Client Configuration window and the settings on the Advanced Settings window:
  • Name—This optional string allows you to define the name of the server node. This attribute corresponds to the Node Name setting Define the Node Name for a Client - System Connection.
  • Cost—This optional integer allows you to define the node cost (which is used by ClearSCADA to determine the order of preference for the client’s connections). This attribute corresponds to the Node Cost setting Define the Node Cost for a Client - System Connection.
  • Port—This optional integer allows you to define the number of the port that the client uses for outgoing communications to the system server. This attribute corruptions to the Port setting Define the Port and Poll Timeouts and Intervals for a ViewX Client Connection
  • Compress—This optional Boolean allows you to define whether data compression is enabled (True) or disabled (False) for the client - system connection. This attribute corresponds to the Compress setting Define the Client Compression Settings for a ViewX Client Connection.
  • DisconnectTimeout—This optional integer allows you to define the amount of time, in milliseconds, in which the client can attempt to terminate a connection to the server. This attribute corresponds to the Disconnect Timeout setting Define the Port and Poll Timeouts and Intervals for a ViewX Client Connection.
  • ConnectTimeout—This optional integer allows you to define the amount of time, in milliseconds, in which the client can attempt to make a connection to the server. This attribute corresponds to the Connect Timeout setting Define the Port and Poll Timeouts and Intervals for a ViewX Client Connection.
  • RequestTimeout—This optional integer allows you to define the amount of time, in milliseconds, in which the client can request data from the server. This attribute corresponds to the Request Timeout setting Define the Port and Poll Timeouts and Intervals for a ViewX Client Connection.
  • PollInterval—This optional integer allows you to define the amount of time, in seconds, that can elapse between each update request sent from the client to the server. This attribute corresponds to the Poll Interval setting Define the Port and Poll Timeouts and Intervals for a ViewX Client Connection.
  • PollTimeout—This optional integer allows you to define the amount of time, in seconds, that the client will wait for a response to a poll request from the server. This attribute corresponds to the Poll Timeout setting Define the Port and Poll Timeouts and Intervals for a ViewX Client Connection.

When you use the ClearSCADA Client Configuration Tool to configure a connection, the resulting Systems.xml file contains auto-generated <opcdaclsid>, <opchdaclsid>, and <opcaeclsid> elements. These elements can allow Third Party OPC clients to connect to a system and can only be included as part of a ClearSCADA generated Systems.xml file. You cannot include them in manually edited Systems.xml files - you should use the ClearSCADA Client Configuration Tool to configure Third Party OPC Client connections Third Party OPC Client - System Connections.