4.5.1 Details of the logical server reference definition file

Organization of this subsection

(1) Format
(2) File storage location
(3) Functionality
(4) Specifiable elements
(5) Examples of coding

(1) Format

This file is in the XML format.

To Page Top

(2) File storage location

Store this file at any work location.

To Page Top

(3) Functionality

This is a definition file used to add user-defined logical servers (logical user server) to service units in Web systems built using commands of the Smart Composer functionality. The file defines information needed to associate logical user server with service units.

Copy and use the following template files:

In Windows

Cosminexus-installation-directory\manager\config\templates\cmxaddserverref.xml
In UNIX

/opt/Cosminexus/manager/config/templates/cmxaddserverref.xml

Note that the logical server reference definition file is used for compatibility with the older version. Use this file for adding the logical user servers into the built system. It is recommended that you use the Easy Setup definition file for adding the logical user server.

To Page Top

(4) Specifiable elements

You define in a logical server reference definition file the name of a logical server to be added, and you define the target Web system and service unit to which the logical server is to be added. You can define as many Web systems, service units, and logical servers as you need.

The structure of a logical server reference definition file is shown below. Specify the <server-reference> and <web-system> tags in this format.

Structure of a logical server reference definition file

<server-reference xmlns="http://www.cosminexus.com/mngsvr/schema/ServerReference-2.0">
  <!-- Definition of Web system -->
  <web-system>
    <!-- Definition of Web system attributes -->
    <name>Web-system-name</name>
 
    <!-- Definition of service unit -->
    <unit>
      <name>service-unit-name1</name>
      <logical-server-ref>logical-server-name-1</logical-server-ref>
        : 
      <logical-server-ref>logical-server-name-n</logical-server-ref>
    </unit>
    <unit>
      : 
  </web-system>
  <web-system>
    : 
</server-reference>

The following table lists and describes each tag and the default values:

Tag names	Contents	Default
`web-system`	Defines a Web system. For defining the multiple Web systems, specify the `<web-system>` tag for each Web system.	None
`name`	Specifies a name for identifying the Web system, within 32 characters. This name must be unique within the domain. Specify this name in the `-s` option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).	None
`unit`	Defines a service unit. For defining the multiple service units, specify the `<unit>` tag for each service unit to be defined.	None
`name`	Specifies a name for identifying the service unit, as a maximum of 32 characters. This name must be unique within the Web system. Specify this name in the `-unit` option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).	None
`logical-server-ref`	Specifies the name of the logical user server that is to be added to the service unit, as up to 128 characters. Specify the name that was specified in the `<logical-server-name>` tag in the logical user server definition file. Specify a logical user server that has been added by the `mngsvrutil add userserver` command. To define multiple logical user servers, specify a `<logical-server-ref>` tag for each logical user server.	None

To Page Top

(5) Examples of coding

This example adds the usersv1 and usersv2 logical user servers to the unit1 service unit, and the usersv3 and sersv4 logical user servers to the unit2 service unit.

<?xml version="1.0" encoding="UTF-8"?>
<server-reference xmlns="http://www.cosminexus.com/mngsvr/schema/ServerReference-2.0">
  <web-system>
    <name>MyWebSystem</name>
    <unit>
      <name>unit1</name>
      <logical-server-ref>usersv1</logical-server-ref>
      <logical-server-ref>usersv2</logical-server-ref>
    </unit>
    <unit>
      <name>unit2</name>
      <logical-server-ref>usersv3</logical-server-ref>
      <logical-server-ref>usersv4</logical-server-ref>
    </unit>
  </web-system>
</server-reference>

To Page Top