8.2.2 Properties.xml

The "Properties.xml" file is a group-level UBBCONFIG file which describes the relationship and parameters of all the servers within groups in the package. It contains properties in the *GROUPS, *RMS, *SERVERS, and *SERVICES sections of a complete UBBCONFIG file and can contain multiple groups.

The Properties.xml file is used to generate the final UBBCONFIG file when deploying the package to a machine. Its content can be modified at that time.

A simple Properties.xml file is shown in listing below:

Adding Pathname to Server Names

<ApplicationProperties>
<PackageName>APP1.zip</PackageName>
<TuxedoVersion>12.1.3.0.0</TuxedoVersion>
<SupportedOS>Linux</SupportedOS>
<TuxedoWordSize>64<TuxedoWordSize>
<MachineArch>x86_64</MachineArch>
<LibPath>/path/to/libs</LibPath>
 
<Groups>
    <GroupSection GROUPNAME="G1" GRPNO="29999">
    <ServerSections>
  <ServerSection AOUT="servers/simpserv1" SRVID="20">
  </ServerSection>
    </ServerSections>
    </GroupSection>
</Groups>
</ApplicationProperties>

Besides the Tuxedo group related information in the Groups element, there are some package global attributes defined at the beginning of the Properties.xml file as shown in the table below:

Table 8-1 Description Information of the Package

Item Description
PackageName The global unique application package name, for example, APP1.zip.
TuxedoVersion The Tuxedo version this package is built on. This item is checked when assembling Tuxedo domain to decide if the package is suitable for certain Tuxedo installation.
SupportedOS The Operation System this package can be deployed to. This information is compared with the corresponding item in Machine list entry when deploying the package. The possible values are Linux, SunOS, HP-UX, and AIX.
TuxedoWordSize The Tuxedo word size this package is built on. The value can be 32 or 64 (bit). This information is compared with the corresponding item in Machine list entry when deploying the package.
MachineArch The machine architecture this package can apply to. The possible values are: x86_64, SUNW, powerpc, IA64, and etc. Check the Platform property (Target Setup -> Properties) of a Host target to decide the appropriate value of the MachineArch here. Only when the MachineArch property value is a substring of the host Platform property, the value is a substring of the host property, the package can be deployed on the target machine.
LibPath The path where the library locates in the package, if there is a library in it.

All parameters in the UBBCONFIG file *GROUPS, *RMS, *SERVERS, and *SERVICES sections are divided into three categories, which determines how they are defined in Propertise.xml.

  • Forbidden

    Indicates this parameter cannot be defined in the application packages Properties.xml file. It can only be filled in when assembling the UBBCONFIG in Resource Broker domain editor.

  • Optional

    Indicates this parameter can be filled in the Properties.xml if needed, and it can also be modified when assembling the UBBCONFIG.

  • Mandatory

    Indicates this parameter must be filled in the Properties.xml, and it can also be modified when assembling the UBBCONFIG.

The following table lists the category of each parameter in the *GROUPS, *RMS, *SERVERS, and *SERVICES sections.

Table 8-2 UBBCONFIG Parameter Categories

Section Parameter Category
GROUPS GROUPNAME Mandatory
GRPNO = number Mandatory
LMID = string_value1 [,string_value2] Forbidden
ENVFILE = string_value Optional
TMSNAME = string_value Optional
MRM = {Y | N} Optional
SIGNATURE_REQUIRED = {Y | N} Optional
ENCRYPTION_REQUIRED = {Y | N} Optional
OPENINFO = string_value Optional
CLOSEINFO = string_value Optional
TMSCOUNT = number Optional
SEC_PRINCIPAL_NAME = string_value Forbidden
SEC_PRINCIPAL_LOCATION = string_value Forbidden
SEC_PRINCIPAL_PASSVAR = string_value Forbidden
RMS RMSNAME Mandatory
RMID = number Mandatory
TMSNAME = string_value Optional
OPENINFO = string_value Optional
CLOSEINFO = string_value Optional
TMSCOUNT = number Optional
AUTO = {Y | N} Optional
SERVERS SRVID = number Mandatory
AOUT Mandatory
ENVFILE = string_value Optional
RCMD = string_value Optional
CONV = {Y | N} Optional
CLOPT = string_value Optional
SEQUENCE = number Optional
RQADDR = string_value Optional
MIN = number Optional
MAX = number Optional
RQPERM = number Optional
REPLYQ = {Y | N} Optional
RPPERM = number Optional
MAXGEN = number Optional
GRACE = number Optional
RESTART = {Y | N} Optional
SYSTEM_ACCESS = identifier[,identifier] Optional
MAXDISPATCHTHREADS = number Optional
MINDISPATCHTHREADS = number Optional
THREADSTACKSIZE = number Optional
SEC_PRINCIPAL_NAME = string_value Forbidden
SEC_PRINCIPAL_LOCATION = string_value Forbidden
SEC_PRINCIPAL_PASSVAR = string_value Forbidden
SICACHEENTRIESMAX = string_value Optional
CONCURR_STRATEGY=PER_REQUEST Forbidden
CONCURR_STRATEGY = PER_OBJECT Forbidden
SERVICES SRVGRP = string_value Forbidden
SVCNM Mandatory
BUFTYPE = "type1[:subtype1[,subtype2 .
. . ]][;type2[:subtype3[, .
. . ]]] . . .
Optional
SIGNATURE_REQUIRED = {Y | N} Optional
ENCRYPTION_REQUIRED = {Y | N} Optional
LOAD = number Optional
PRIO = number Optional
BUFTYPECONV = {XML2FML | XML2FML32} Optional
BLOCKTIME numeric_value Optional
SVCTIMEOUT = number Optional
SESSIONROLE Optional
AFFINITYSCOPE Optional
AFFINITYSTRICT Optional
AUTOTRAN = {Y | N} Optional
ROUTING = string_value Forbidden
TRANTIME = number Optional

For more information, see Properties.xml Schema in Enterprise Manager for Oracle Tuxedo Reference.

To make the TMS executable file (generated by command buildtms),accessible for Tuxedo application runtime when running tmboot, the TMS executable file should be located in sub-directory 'bin' of the application package. The <package_name>/bin folder is appended to the environment variable PATH in the generated setenv file. The setenv file is sourced before booting up the Tuxedo application.

For the ENVFILE mentioned previously, RCMD files, and control_file specified by "TMSYSEVT -f", this feature does not support deploying them to directories other than APPDIR. For example, if APPDIR is /nfs/lcfilerc/vol1/APPDIR, you cannot specify ENVFILE=/nfs/lcfilerc/vol2/envfile in UBBCONFIG because ENVFILE is under /nfs/lcfilerc/vol1/APPDIR/APP1/….

Note:

All the Tuxedo servers dependent third party libraries (such as Database client libraries), are not in the deployment scope of this feature.