All resource configuration files are stored in a common directory indicated by a well known environment variable: ${KIXCONFIG}.
Table 4‑1 defines the lists of resource groups that may be loaded by application servers.The filename is list_of_groups.desc.The format of a list_of_groups.desc definition is:
Table 4‑1 Group List Parameters Table 4‑2 lists the transactions available to application users, with their characteristics.The filename is transactions.desc.
Table 4‑2 Transaction Parameters If the system initialization parameter specifies CONFDATA=SHOW, CONFDATA on the transaction definition is ignored. The default value is USER. See Tranclasses Configuration File for more information on the usage of this parameter on the target platform. Each transaction is advertised as an Oracle Tuxedo service by CICS Runtime servers, e.g. ARTSTRN, ARTATRN…. You can divide the transactions into different groups and assign the groups to different servers using option "–l", so that each server just advertise its own services.Table 4‑3 lists and defines tranclasses available to regulate parallel transactions activities.The filename is tranclasses.desc.
Table 4‑3 Transclass Parameters Transactions that are defined as belonging to a transaction class are subject to scheduling constraints before they are allowed to execute. If transactions belonging to an active transaction class are already running, any new transactions are queued. Use the MAXACTIVE attribute to specify the maximum number of transactions that you want to run. To limit the size of the queue, you can use the PURGETHRESH attribute.Table 4‑4 lists and defines programs available to be referenced either as first program of a transaction, or being invoked by EXEC CICS LINK and XCTL.The filename is programs.desc.
Table 4‑4 Programs Parameters Specifies whether to enable the RESCOUNT information for the specified program. The default value is DISABLED, which is used when this field is not specified. Program input type. It describes the COMMAREA that is passed to the program.It must be the same as the subtype of the Tuxedo buffer that you use. It is only supported in ARTDPL when it is called with Tuxedo RECORD buffer. Program output type. It describes the COMMAREA that the program returns.It must be the same as the subtype of the Tuxedo buffer that you use. It is only supported in ARTDPL when it is called with Tuxedo RECORD buffer.Table 4‑5 lists and defines theTS Queue models available to be referenced by the CICS application.The filename is tsqmodel.desc
Table 4‑5 TS Queue Parameters
• AUXILIARY (default): Both RDBMS-based location and file-based location are supported. If RECOVERY is set to Y, database-based location is used; If RECOVERY is set to N, file-based location is used.
• MAIN: TSQ in main storage is used. This can get better access performance. TSQ data stored in main storage is unrecoverable.
• Y: Queue is stored in the RDBMS to provide recovery capabilities.
• N (default): Queue is stored in file or main storage, and does not support recovery capabilities. Table 4‑6 lists and defines ENQ Models available to be referenced by the CICS application.The filename is enqmodel.desc.
Table 4‑6 ENQ Model Parameters Table 4‑7 lists and defines extra partitions TD queues available to the CICS application.The filename is tdqextra.desc.
Table 4‑7 TD Queue Parameters
• D = DEFERRED: The data set remains closed until you indicate that you want to open it by using the CEMT INQUIRE|SET TDQUEUE command.
• I = INITIAL: The data set is to be opened at install time. However, if the DSNAME attribute is not specified, and the data set name is not specified in the DD statement in the startup JCL, the transient data queue is allocated to JES during CICS startup.
• F= FIXED: Fixed records. If you specify RECORDFORMAT FIXED, you must also specify a block format.
• V= VARIABLE: Variable records. If you specify RECORDFORMAT VARIABLE you must also specify a block format. Setting the value I, will trigger the call to a function td_extra_actions_int, which must be provided by the integrator. Table 4‑8 lists and defines intra partitions TD queues available to the CICS application.The filename is tdqintra.desc.
Table 4‑8 TD Queue Parameters Setting the value I, will trigger the call to a function td_intra_actions_int, which must be provided by the integrator. Table 4‑9 lists and defines mapsets available to be referenced by the CICS application. For more information, see tcxmapgen(1) in System Commands and Transactions.The filename is mapsets.desc.The format of a MAPSET definition is:
Table 4‑9 Mapset Parameters It will be searched in directories defined by the KIX_MAP_PATH environment variable if the absolute path is not specified.If this field is not specified, the default mapset binary file name <MAPSET_name>.mpdef will be used, in which the <MAPSET_name> is the MAPSET name parameter specified in CICS MAP related APIs.
• If set to ENABLED, the resource is available.
• If set to DISABLED, the resource is unavailable for use by the system. This attribute specifies the caching scheme to be used once the MAPSET is loaded. NORMAL keeps the MAPSET loaded in a cache. Unload it when the cache overflows and it is the oldest, least used MAPSET in the cache. TRANSIENT unloads the MAPSET if it is not being used.Table 4‑10 lists and defines system available to the CICS application.The filename is system.desc.The format of a system.desc definition is:Using a “\”, you can continue parameters on another line. Oracle Tuxedo Application Runtime for CICS concatenates the operands, omitting the remaining blanks after “\” in the current line. In this usage, only blank characters can appear after “\” in the current line; otherwise, ”\” will be treated as a backslash.To load and/or discover the defined system initialization parameters, CLOPT “-s” is required to specify.To define APPLID of current CICS region, you can either specify CLOPT “-a” (Listing 4‑1) or specify APPLID parameters in system.desc (Listing 4‑2).Listing 4‑1 Example to Specify CLOPT "-a"Listing 4‑2 Example to Specify APPLIDOracle Tuxedo Application Runtime for CICS will firstly check whether CLOPT “-a” is specified. If it is, its value will be used as JOBNAME; otherwise, the value of APPLID set in system.desc file will be used as JOBNAME. If neither “-a” nor APPLID in system.desc is set, default value DBDCCICS will be used.In either ways, if the value is more than 8 characters, it will be truncated to contain only the first 8 characters; if the value is less than 8 characters, APPLID will be padded spaces afterwards to be just 8 characters.See this example to specify GMTEXT.Listing 4‑3 Example of Specifying GMTEXTGMTEXT has the following two formats.
Table 4‑10 System Parameters
Note: If more than one sections share a same SYSIDNT, the final configuration for this CICS region will possess all the parameters defined in these sections. If a parameter is defined more than once in these sections, only the last one will make sense. Specifies initialization parameters in system initialization table (SIT) for each CICS application program that invokes ASSIGN INITPARM.The INITPARM format is INITPARM=(pgmname_1='parmstring_1'[,...,pgmname_n='parmstring_n']). We now support at most 255 sets of program=’parmstring’.The value of program should consist of 1 - 8 alphanumeric characters and will be truncated if exceeding the length limit.The value of parmstring should be at most 60 characters and will be truncated if exceeding the length limit. Parameter string should be enclosed by single quotes; any quotes imbedded in the string must be duplicated.
Note: In each section, if INITPARM parameters are specified more than one time, only the last definition will take effect. GMTEXT is a system initialization parameter. GMTEXT specifies whether the default logon message text (Oracle Tuxedo Application Runtime for CICS) or your own message text is to be displayed on the logon screen. The message text is displayed by CSGM transaction when a terminal is logged on to ART for CICS.GMTEXT should be at most 246 characters long and is truncated if it is longer. (See Specify GMTEXT for an example.)To enable GMTEXT, it is required to configure CLOPT -s option with your [SYSIDNT] for ARTCNX server. For more information, see ARTCNX Configuration. A system initialization parameter which specifies the name of the transaction that is initiated by ATI when terminals are logged on to ART CICS. The GMTRAN format is GMTRAN={CSGM|CESN|transaction-id}, where the default value is CSGM.
Note: To enable GMTRAN, it's also required to specify LOGONMSG=YES in typeterms.desc; however, if LOGONMSG is specified to NO, the screen will be cleared. Specifies whether to enable DDS (Device Dependent Support). The default value is DDS, meaning DDS is enabled.
• BMS appends the suffix specified in ALTSUFFIX to map set names if the screen size being used is the same as the alternate screen size. In other word, if a transaction has SCRNSIZE(ALTERNATE) specified in the TYPETERM definition, or if the default screen has the same size as the alternate screen, BMS map selection routines try to load the map set with the suffix specified in ALTSUFFIX. Optional. The default value is ARTCICS. Use SRM_IPCKEY only when your ARTSRM server uses shared memory to store runtime information (if ARTSRM uses database, SRM_IPCKEY is ignored). If you do not specify SRM_IPCKEY when using shared memory, ARTSRM uses its Tuxedo group number to generate an IPCKEY.Within in a single CICS region, SRM_IPCKEY must be the same for every ARTSRM in this region, and all of these ARTSRM servers must run on the same machine. Specifies the storage media for ARTSRM.
• Memory (default): uses shared memory to store data
• DB: uses database to store data The PGAIPGM system initialization parameter specifies the state of the program autoinstall function at initialization.
• INACTIVE: The program autoinstall function is disabled.
• ACTIVE (default): The program autoinstall function is enabled. Specifies CICS system code that returns in CICS INQUIRE SYSTEM RELEASE command.You can specify CICS system code either through environment variable KIX_CICS_RELEASE or through CICS_RELEASE in system configuration file.If both KIX_CICS_RELEASE and CICS_RELEASE in systems.desc are configured, the value in systems.desc is returned.If neither KIX_CICS_RELEASE nor CICS_RELEASE in systems.desc is configured, value '0660' (corresponding to CICS 4.1) is returned.Table 4‑11 lists and defines terminal available to the CICS application.The filename is terminals.desc.The format of a terminal definition is:ART CICS stores all the terminal runtime status by using Tuxedo /Q. For more information about configuring and using Tuxedo /Q, please see Implementing Asynchronous CICS Delayed Transactions.
Table 4‑11 Terminal Parameters Specifies a 1-character ALTSUFFIX name for the terminal. Only an alphanumeric character or a blank, which means no suffix, is accepted. The value is case-insensitive and will be converted to upper-case automatically. Specifies whether KATAKANA support is required.NO: Default value. KATAKANA function is disabled.YES: KATAKANA function is enabled.
Note: When there are multiple entries with same TERMID, the last entry takes effect.
Note: The value of NETNAME must be unique; otherwise, ARTCNX server fails to boot and reports the error output in ULOG and stdout. YES: Transactions may be initiated and messages may automatically be sent to the terminal.NO: The terminal can neither receive messages nor transmit input.The default value is YES. If this field is defined to neither of above values, it is treated as YES. YES: The terminal is available for use by transactions that are automatically initiated from within CICS.NO: The terminal is not available for use by transactions that are automatically initiated from within CICS.If this field is defined to neither of above values, it is treated as UNKNOWN. However, in the event that the same field in typeterms.desc is defined to UNKNOWN as well, the final value of this field is YES. YES:Transactions can be initiated at the terminal by a user. If you also specify ATI(YES), transactions can also be initiated automatically. In this case, the automatic transaction initiation, either by transient data control or interval control, sets a condition in an appropriate terminal control table terminal entry. If both ATI and TTI are specified as YES, and if there is no transaction at the terminal, terminal control initiates the user-defined task. This task is expected to send messages to the terminal.For a terminal used in the processing of transactions such as inquiries or order entries, specify TTI(YES) and ATI(NO). This also applies to a display station or hard-copy terminal to which no messages are sent without a terminal request and through which transactions are entered. Note that this is the only specification allowed for 3790 inquiry logical units.NO:Transactions cannot be initiated at the terminal by a user. If you specify NO, specify ATI(YES) to allow transactions to be initiated automatically. An example of this type of terminal is one that is located in a remote location, such as a warehouse, and is unattended but may receive messages.If this field is defined to neither of above values, it is treated as UNKNOWN. However, in the event that the same field in typeterms.desc is defined to UNKNOWN as well, the final value of this field is YES.ART CICS reserves "."; users can use it neither in NAME nor in NETNAME when defining terminals.desc.Table 4‑12 lists and defines Typeterms supported by ARTTCP.The filename is typeterms.desc.The format of a typeterm definition is:
Table 4‑12 Typeterm Parameters Specifies the terminal screen size total columns. If the SCRNSIZE=alternate, this parameter is mandatory. Specifies the terminal screen size total rows If the SCRNSIZE=alternate, this parameter is mandatory. Specifies a 1-character ALTSUFFIX name for the typeterm. Only an alphanumeric character or a blank which means no suffix is accepted. The value is case-insensitive and will be converted to upper-case automatically. The default value is DEFAULT which does not send/receive map/text with alternative screen size. Indicates whether the “Good Morning” (CSGM) transaction is automatically started on the terminal or not.Oracle Tuxedo ART provides a default CSGM transaction. Please refer to section for the configuration of the default “Good Morning” (CSGM) transaction.
• If set to ENABLED, the resource is available.
• If set to DISABLED, the resource is unavailable for use by the system
• YES: translate lowercase alphabetic characters to uppercase.
• NO: do not translate lowercase alphabetic characters to uppercase
• TRAN: only translate the transaction ID from lowercase to uppercase. Specifies whether KATAKANA support is required. The default value is NO. KATAKANA function can be enabled only if KATAKANA is specified to YES.
Note: You can either set KATAKANA in terminals.desc or typeterms.desc; however, only if KATAKANA in terminals.desc is not specified to YES or NO, KATAKANA specified in typeterms.desc will take effect. YES: Transactions can start at the terminal by automatic transaction initiation.NO: Transactions cannot start at the terminal by automatic transaction initiation.ATI(YES) allows transactions to be started at the terminal by transient data control or by an EXEC CICS START command issued by another transaction. If there is already a transaction at the terminal, the ATI transaction is held until it ends. If you specify ATI(YES), you must specify an IOAREALEN of at least one byte, except for DEVICE(APPC) when ATI and IOAREALEN have forced default values of YES and 0.If ATI is specified as YES and CREATESESS is specified as YES, and if a transaction is initiated when the terminal is not ACQUIRED, it is automatically acquired. YES:Transactions can be initiated at the terminal by a user. If you also specify ATI(YES), transactions can also be initiated automatically. In this case, the automatic transaction initiation, either by transient data control or interval control, sets a condition in an appropriate terminal control table terminal entry. If both ATI and TTI are specified as YES, and if there is no transaction at the terminal, terminal control initiates the user-defined task. This task is expected to send messages to the terminal.For a terminal used in the processing of transactions such as inquiries or order entries, specify TTI(YES) and ATI(NO). This also applies to a display station or hard-copy terminal to which no messages are sent without a terminal request and through which transactions are entered. Note that this is the only specification allowed for 3790 inquiry logical units.NO:Transactions cannot be initiated at the terminal by a user. If you specify NO, specify ATI(YES) to allow transactions to be initiated automatically. An example of this type of terminal is one that is located in a remote location, such as a warehouse, and is unattended but may receive messages.Table 4‑13 lists and defines connections that can be loaded by ART CICS application servers. Connection configuration file is mandatory to set for ARTCTRN but optional to set for other servers.The filename is connections.desc.The format of a connection definition is:
Table 4‑13 Connection Parameters Specifies the maximum number of sessions in the modeset. The format is MAXIMUM=value_1,value_2, where Value_1 must be greater than or equal to value_2. Table 4‑14 defines the web services available to the CICS application.The filename is webservice.desc.
Table 4‑14 Web Services Parameters Table 4‑15 lists and defines programs list available to the CICS application server ARTDPL boot or shutdown.The filename is program_list_table.desc.The format of a program_list_table.desc definition is:[plt]To load and/or discover the defined programs list, you have two ways: one is add "-b" or "-d" option in ARTDPL CLOPT, and the other is to define the SUFFIX in the system.desc PLTPI/PLTSD parameter.In this example, ARTDPL will load and execute the programs named RSSBT001, RSSBT002 during its initialization.
Table 4‑15 CICS Application Programs List Specifies the program list. The format is: PROGRAM=program [,...,programn].Table 4‑16 defines the pools available to the CICS application.The filename is pool.desc.The format of a pool.desc definition is:
Table 4‑16 POOL Parameters Optional. Specifies the maximum size in Kilobytes allocated for the pool. The default value is 0, standing for no limit. 1-100 This configuration file defines TCP/IP socket listener information. Table 4‑17 lists its parameters.The file name is listener.desc; it does not support dynamic configuration. The format is:
Table 4‑17 TCP/IP Socket Listener Parameters The APPLID for this listener. This parameter is specific to the enhanced version of the listener and is applicable only if CSSTTYP is IC. It specifies the delay interval to be used on the EXEC CICS START command, in the form hhmmss (hours/minutes/seconds). Only supports KC value (default), indicating that the user transaction is started using EXEC CICS START with no delay interval. The default value of STANDARD indicates that this is the original ART for CICS listener that requires the client to send the standard header. The value of ENHANCED indicates that this is the enhanced ART for CICS listener that does not expect the standard header from the client. The time in seconds this listener waits for a response to a TAKESOCKET. If this time expires, the listener assumes that either the server transaction did not start or the TAKESOCKET failed. At this time, the listener sends the client a message indicating the server failed to start and close the socket (connection). The default value is 60. This parameter is specific to the enhanced version of the listener and specifies the length of the data to be received from the client. The valid range is 0 to 999 byte. If the value is 0, the listener does not read in any data from the client. This parameter is specific to the enhanced version of the listener and applies only if MSGLEN is not 0.A value of NO indicates that the listener performs a normal read of the client data. The user transaction accesses this data in the data area-2 portion of the transaction input message (TIM). A value of YES indicates that the listener reads the data using the peek option; the data remains queued in TCP/IP and the user transaction actually read it in rather than accessing it through the TIM. The time in seconds this listener waits for a response to a RECV request. If this time expires, the listener assumes that the client has failed and terminates the connection by closing the socket. If this parameter is not specified, checking for read timeout is not performed. The file name is urimaps.desc.
Table 4‑18 URIMAP Parameters This parameter specifies the path component of the URI to which the URIMAP definition applies. PATH can be up to 255 characters, including the forward slash (/) at the beginning of the path component. This parameter specifies the scheme component of the URI to which the URIMAP definition applies. Default value is HTTP. This parameter specifies whether this URIMAP definition is for CICS as an HTTP server (SERVER), CICS as an HTTP client (CLIENT), a Web service (PIPELINE), or an Atom feed (ATOM). Default value is SERVER.ART for CICS only supports CLIENT.
Table 4‑19 Client Parameters This parameter specifies the host name of the URI to which the URIMAP definition applies, or its IPv4 or IPv6 address. This parameter specifies the decimal number of the port used by a CICS application when it communicates with a server. PORT must be a number in the range 1 − 65535.Set NO to indicate that the attribute is not used.