1. Application Runtime for CICS Reference Guide
  2. System Commands and Transactions
  3. System Commands
  4. kixpkggen(1)
  5. Options

11.1.8.4 Options

kixpkggen.py supports the following options:

-h --help
Shows help message and exit.
-a ASSET --asset=ASSET
Specifies CICS asset (a ZIP file).
-u --ubb
Only generates UBBCONFIG.
conf
Specifies XML configuration file.

The following tables show the XML configuration file's elements. The following Listing 12‑10 shows a template, and the subsequent Listing 12‑11 shows a sample.

Table 11-2 XML Configuration File Elements - Resources Section

Element Occurrence in this file Description
domain-info 0 or 1 Resources section
domainid 0 or 1 UBBCONFIG DOMAINID
ipckey 0 or 1 IPCKEY
servers 0 or 1 Servers that defined on domain level (such as ARTTCPL)
server n server has the following attributes:
  • name: Name of the server (mandatory).
  • hostname: Hostname that servers run on. It is the master machine by default.
  • clopt: CLOPT of the server.
  • conv: Whether the server is a conversational server. Set it to Y or N.
  • rm-group: RM group ID (if not specified, it is set a non RM group by default).
option 0 or n UBBCONFIG resource section parameters. It has the following attributes.
  • name: Parameter name
  • value: Parameter value

Table 11-3 XML Configuration File Elements - Machines section

Element Occurrence in this file Description
mach-info 1 Machines section
machine n N/A
hostname 1 Hostname that uname -n returns.
rm-group 1 ID of RM group in rm-info section (see Table "XML Configuration File Elements - RM Section").
ismaster 0 or 1 Indicates if this machine is MASTER or not. Set it to YES or NO
nlsport 0 or 1 NLS port
nport 0 or 1 Network listening port
tuxdir 0 or 1 Tuxedo installation directory
artdir 0 or 1 ART for CICS installation directory
appdir 0 or 1 APPDIR
cbldir 0 or 1 COBOL directory
cbltype 0 or 1 COBOL type. Set it to MF or CIT. It is mandatory if cbldir is set.
dbdir 0 or 1 Database directory
dbtype 0 or 1 Database type. Set it to Oracle or UDB. It is mandatory if dbdir is set.
path 0 or 1 The path that adds to binary search path
ldpath 0 or 1 The path that adds to library search path
uid 0 or 1 UID
gid 0 or 1 GID
env 0 or n Environment variables to be exported. It has the following attributes.
  • name: Variable name
  • value: Variable value

Table 11-4 XML Configuration File Elements - CICS Region Definition

Element Occurrence in this file Description
region-info 1 CICS region definition
region-map n  
region 1 CICS SYSID of the region
machines 0 or 1 If not specified, the region is defined on all machines.
machine n It has the following attributes.
  • nhostname: Hostname. It is mandatory.
  • rm-group: RM group ID. This setting overrides the value set in the previous machines section (see Table "XML Configuration File Elements - Machines section")
servers 0 or 1 ART for CICS servers defined in this region. If it is not specified, only ARTSTRN and ARTATRN are defined.
server n It has the following attributes.
  • type: Type of the server. Valid values are STRN, STR1, ATRN, ATR1, CTRN, CTR1, WTRN, WTR1, DPL, TSQ,CKTI, and CSKL.
  • name: Server name. If not specified, it is determined by rm-group (machine element) and by type (server element).
  • num: Number of the server to be configured. Default value is 1.
  • min: MIN. Default value is 1.
  • max: MAX. Default value is 1.
  • clopt: CLOPT of the server.

Table 11-5 XML Configuration File Elements - RM Section

Element Occurrence in this file Description
rm-info 1 RM section
rm n Must specify Id attribute, which is character string that uniquely identifies the RM.
rm-name 1 RM name
tms-name 0 or 1 TMSNAME. If omitted, it is by default set to TMS_ORA for Oracle_XA, and TMS_UDB for UDB_XA (others are error).
openinfo 1 OPENINFO
rm-group 1 Must specify Id attribute, which is character string that uniquely identifies the RM group.
rm n ID of the RM in this group
svr-name 0 or 1  
str-name 0 or 1 Name of ART for CICS synchronous transaction server
atr-name 0 or 1 Name of ART for CICS asynchronous transaction server
ctr-name 0 or 1 Name of ART for CICS conversation transaction server
dpl-name 0 or 1 Name of ART for CICS DPL server
wtr-name 0 or 1 Name of ART for CICS non-3270 synchronous transaction server
tsq-name 0 or 1 Name of ART for CICS temporary storage queue server
Listing XML Configuration File Template 
<?xml version="1.0" encoding="UTF-8"?>
<config>
  <domain-info>
      <domainid></domainid>
      <ipckey></ipckey>
      <servers>
          <server name='' clopt='' conv='' hostname='' rm-group=''/>
      </servers>
      <option name='' value=''/>
</domain-info>

<mach-info>
    <machine>
        <hostname></hostname>  
        <ismaster></ismaster>
        <tuxdir></tuxdir>
        <artdir></artdir>
        <appdir></appdir>
        <rm-group></rm-group>
        <cbldir></cbldir>    
        <cbltype></cbltype>
        <dbdir></dbdir>
        <dbtype></dbtype>
        <uid></uid>
        <gid></gid>
        <nlsport></nlsport>
        <nport></nport>
        <path></path>
        <ldpath></ldpath>
        <env name='' value='' />
   </machine>
</mach-info>

<region-info>
    <region-map>
        <region></region>  
        <machines>
            <machine hostname='' rm-group=''/>
        </machines>
    <servers>
        <server type='' name='' num='' min='' max='' clopt=''/>
    </servers>
 </region-map>
</region-info>

<rm-info>
    <rm id=''>
        <rm-name></rm-name>
        <tms-name></tms-name>
        <openinfo></openinfo>
    </rm>
    <rm-group id=''>
        <rm></rm>
          <svr-name>    
            <str-name></str-name>
            <atr-name></atr-name>
            <dpl-name></dpl-name>
            <ctr-name></ctr-name>
            <wtr-name></wtr-name>
            <tsq-name></tsq-name>
          </svr-name>
      </rm-group>
  </rm-info>
</config>
Listing XML Configuration File Sample 
<?xml version="1.0" encoding="UTF-8"?>

<config>
    <domain-info>
         <domainid>KIXD</domainid>
         <ipckey>123456</ipckey>
    </domain-info>

   <mach-info>
        <machine>
            <hostname>demobox</hostname>
            <rm-group>1</rm-group>
            <tuxdir>/home/demo/tuxedo22.1.0.0.0</tuxdir>
            <artdir>/home/demo/art22.1.0.0.0</artdir>
            <appdir>/home/demo/workspace/cicsdemo</appdir>
            <cbldir>/opt/cobol-it-3.7.10</cbldir>
            <cbltype>CIT</cbltype>
            <dbdir>/home/oracle/app/oracle/product/11.2.0/db_1</dbdir>
            <dbtype>ORA</dbtype>
        </machine>
  </mach-info>

<region-info>
    <region-map>
        <region>KIXR</region>
    </region-map>
</region-info>

<rm-info>  
    <rm id='1'>
        <rm-name>Oracle_XA</rm-name>

<openinfo>Oracle_XA:Oracle_XA+Acc=P/test/test+SqlNet=orcl</openinfo>
        </rm>

        <rm-group id='1'>
                <rm>1</rm>
            </rm-group>
         </rm-info>
</config>

Parent topic: kixpkggen(1)