OpenFrame/OSI Configuration

This chapter describes configuration items required for OpenFrame/OSI operation.

1. Overview

For operation of OpenFrame/OSI (hereafter OSI), set KEYs of each SECTION in the openframe_osi.conf file, and then save the system settings by using the ofconfig tool.

Certain KEYs have no default value (NONE). Refer to the Remark for their behaviors when they are not set.

The following are descriptions of each subject’s sections. For further details about setting values of each section’s keys, refer to the corresponding section.

  • osi

    Configures common settings for all OSI system modules.

    Section Description

    GENERAL

    General behavior related to OSI system servers or user servers.

    CRC

    Maps a control region in which OSI commands are executed with a certain CRC (Command Recognition Character).

    DEFAULT_IMSID

    Maps the default IMSID with RESLIB that are used when IMSID is not specified in JCL that start the OSI user server.

  • osi.{IMSID}

    Configure settings by IMSID in the OSI system. If the system server ID in use is IMSA, the subject name is osi.IMSA.

    Section Description

    GENERAL

    General behavior in the OSI system.

    LIBRARY

    Location of the library that saves information required for OSI system operation.

    CPM

    CPM data file used for code conversion between EBCDID and ASCII in the OSI system.

    SECURITY

    Security applied in the OSI system.

    USER

    Information that can be set by the user in the OSI system.

    PRINTER

    Master printer used in the OSI system.

    SCREEN

    Size of the map used in the OSI system.

    MQ

    Information about IBM MQ used in the OSI system.

    USER_PROGRAM

    User programs that run when starting the OSI user server.

  • osi.{osimqsvrname}

    Configures settings for each server of osimqsvr that provides a trigger monitor of IBM MQ product. If the server name is osimq001, the subject name is osi.osimq001. The items set under the osi.osimq001 subject are only applied to the osimq001 server.

    Section Description

    MQ

    Information about queue trigger monitor of IBM MQ in the OSI system.

  • ssm.{IMSID}{SSM}

    Configures settings for Tmax XA server to use MultipleRM for each IMS system in OSI.

    Section Description

    GENERAL

    General information about connection with the XA server.

2. osi

Configures common settings for all OSI system modules.

2.1. GENERAL

Sets general behaviors related to OSI system servers or user servers.

2.1.1. LOG_LEVEL

Log level of the OSI system. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

M

Range

M, D, E, W

Remark

  • M : Message

  • D : Debug

  • E : Error

  • W : Warning

2.2. CRC

Maps a control region in which the OSI command is executed with a certain CRC (Command Recognition Character). When executing a command by using the imscmd tool or JLC, a CRC value is put at the front of the command and decides a region for execution. Each CRC must be configured as a unique value.

2.2.1. CRC

KEYs set with characters to recognize a region for executing a command. The value is set as the name of a control region in which a command with the CRC value is executed. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

The key permits up to 1 byte, and the value permits up to 4 bytes of characters. If the value is set to (NONE), IMS control region is processed as blank.

The following sets the '/' character as a CRC of control region named IMSA.

$ ofconfig list -s osi -sec CRC -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
    osi     |       CRC        |          /          |            IMSA
===================================================================================

2.3. DEFAULT_IMSID

Maps the default IMSID with RESLIB if JCL that start the OSI user server (Dependent Region) does not specify IMSID as a parameter. The configuration file is read by the name of data set specified as DFSRESLB DD of JCL, and IMSID of the server to start is decided.

2.3.1. {dataset}

Data set name used as RESLIB. This is defined as DFSRESLB DD in JCL. The value is set as the default IMSID. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

The value permits up to 4 bytes of characters. If the value is set to (NONE), the default IMSID is processed as blank.

The following sets the default IMSID to IMSA in RESLIB named IMS.RESLIB.

$ ofconfig list -s osi -sec DEFAULT_IMSID -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
    osi     |  DEFAULT_IMSID   |      IMS.RESLIB     |            IMSA
===================================================================================

3. osi.{IMSID}

Configures settings for each IMSID in the OSI system. If the system server ID is IMSA, the subject name is osi.IMSA.

3.1. GENERAL

Sets general behaviors in the OSI system.

3.1.1. LOG_LEVEL

Log level of the OSI system.

Item Description

Parameter Type

String

Default Value

M

Range

M, D, E, W

Remark

  • E : Error

  • W : Warning

  • M : Message

  • D : Debug

3.1.2. SCHEDULE_RECOVER_MAXCNT

Maximum number of attempts for execution when the transaction execution fails. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

Number

Default Value

5

Range

1~10

Remark

The following sets log level of a system named IMSA to Message, and the maximum number of attempts for transaction execution to 5.

$ ofconfig list -s osi.IMSA -sec GENERAL -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY              |         VALUE
===================================================================================
  osi.IMSA  |     GENERAL      |      LOG_LEVEL           |           M
            |                  |  SCHEDULE_RECOVER_MAXCNT |           5
===================================================================================

3.2. LIBRARY

Sets the location of a staging library that has information required for operating the OSI system. The staging library is used for the administrator to add or modify operation data. When the system is operated, an active library that has copied data of the staging library is used. For more information, refer to "10.2.dfsuocu0" in OpenFrame Tool Reference Guide and "2.11.MODIFY" in OpenFrame OSI Command Reference Guide.

3.2.1. MODBLKS

DSN of a staging library data set that stores setting of all resources supported by OSI. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

Stores and manages the DSN in a meta table, not in a data set, in the current version. If the value is (NONE), the DSN in a data set is processed as blank.

3.2.2. IMSACB

DSN of a staging library data set that stores ACB. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

Stores and manages the DSN in a meta table, not in a data set, in the current version. If the value is (NONE), the DSN in a data set is processed as blank.

3.2.3. FORMAT

DSN of a staging library data set that stores MFS. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the DSN in a data set is processed as blank.

The following sets MODBLKS as OSI.IMSQ.DEFLIB, IMSACB as IMS.ACBLIB, and FORMAT as OSI.IMSA.MFSLIB in a system named IMSA.

$ ofconfig list -s osi.IMSA -sec LIBRARY -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |     LIBRARY      |       FORMAT        |       OSI.IMSA.MFSLIB
            |                  |       IMSACB        |          IMS.ACBLIB
            |                  |       MODBLKS       |       OSI.IMSA.DEFLIB
===================================================================================

3.3. CPM

Sets a CPM data file used for code conversion between EBCDIC and ASCII in the OSI system.

3.3.1. 3270_CCSID

CCSID numbers used in TN3270 emulators. Up to 2 CCSID numbers can be specified. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

The following are commonly used CSID numbers.

  • 37 : COM EUROPE EBCDIC

  • 290 : JAPANESE EBCDIC

  • 300 : JAPAN DB EBCDIC

  • 437 : USA PC-DATA

  • 933 : KOREAN MIX EBCDIC

  • 943 : JAPAN OPEN

  • 949 : KOREA KS PC-DATA

If the value is (NONE), the CCSID is processed as blank.

3.3.2. REGION_CCSID

CCSID number used in the MFS module of the OSI system. Up to 1 CCSID number can be specified. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the CCSID is processed as blank.

3.3.3. EBCDIC_TO_ASCII

CPM data file used when converting EBCDIC to ASCII. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

REGION_CCSID setting overrides EBCDIC_TO_ASCII setting in OSI. Therefore, if you want to use EBCDIC_TO_ASCII setting, do not use REGION_CCSID.

If the value is (NONE), the CPM data file is processed as blank.

3.3.4. ASCII_TO_EBCDIC

CPM data file used when converting ASCII to EBCDIC. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

REGION_CCSID setting overrides ASCII_TO_EBCDIC setting in OSI. Therefore, if you want to use ASCII_TO_EBCDIC setting, do not use REGION_CCSID.

If the value is (NONE), the CPM data file is processed as blank.

3.3.5. CONVERT_TO_SPACE

Non-display characters to be converted to blank (X'40) when displayed. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

Sets the value in the X’hh' or C’c' format based on the ASCII code. Multiple values can be specified by using a comma (,) as a delimiter.

The following example uses EBCASCKR.cpm and ASCEBCKR.cpm, both of which are CPM data files supported with Korean in a system named IMSA, and sets characters to be converted to blank as X'00.'

$ ofconfig list -s osi.IMSA -sec CPM -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |       CPM        |   ASCII_TO_EBCDIC   |         ASCEBCKR.cpm
            |                  |   EBCDIC_TO_ASCII   |         EBCASCKR.cpm
            |                  |   CONVERT_TO_SPACE  |            X'00'
===================================================================================

3.4. SECURITY

Specifies whether to use security in the OSI system.

3.4.1. TYPE

Security type. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

TACF

Remark

Supports only TACF in the current version.

If the value is (NONE), it is processed as an option without a value.

If TYPE is set to TACF, and IGNORE_AUTH_CHECK keys of HIDB_DEFAULT section in the HiDB subject to YES, an error can occur when DL/I is executed. Even when the TYPE is set to TACF, IGNORE_AUTH_CHECK must be set to NO.

3.4.2. TACF_USERID

Option to set USERID applied to IO-PCB either as a user ID or group ID when configuring TACF. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

USER

Range

USER, GROUP, NODEFGRP

Remark

  • USER : Reflects the entered user ID when signing on.

  • GROUP : Reflects the entered group ID when signing on. If not set, the default group ID is reflected.

  • NODEFGRP : Reflects the entered group ID when signing on. If not set, a user ID is reflected.

The following example uses TACF security, and applies a group ID to IO-PCB in a system named IMSA.

$ ofconfig list -s osi.IMSA -sec SECURITY -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |     SECURITY     |     TACF_USERID     |            GROUP
            |                  |         TYPE        |            TACF
===================================================================================

3.5. USER

Sets the information that can be specified by a user in the OSI system.

3.5.1. LOGON_MOD

MOD name to be displayed when logged on to the OSI system. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

OSILOGOO

Range

CLEAR, OSILOGOO, Other user MODs

Remark

  • CLEAR: Displays a blank page for entering transactions.

  • OSILOGOO: OpenFrame basic page (Default Value)

  • MOD: Other users

3.5.2. LOGON_UC

Option to convert lowercase letters to uppercase letters in the user login page. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

Y_N

Default Value

NO

Range

YES, NO

Remark

  • YES : Converts to uppercase letters

  • NO : Enters lowercase letters (Default Value)

  • Other user MODs

The following sets OSILOGOO (default MOD) as the first page and sets the login page to convert to uppercase letters in a system named IMSA.

$ ofconfig list -s osi.IMSA -sec USER -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |       USER       |      LOGON_MOD      |           OSILOGOO
            |                  |      LOGON_UC       |             YES
===================================================================================

3.6. PRINTER

Sets a master printer used in programs.

3.6.1. MASTER_NAME

Name (up to 8 characters) of a master printer to use. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the name of a master printer is processed as blank.

3.6.2. BUF_SIZE

Buffer size of data to be printed. If the buffer size is exceeded, the data in the buffer is sent to the master printer and printed. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

Number

Default Value

0 (Unit : byte)

Range

0~2147483647

Remark

The following sets a master printer to MASTPRNT and its buffer size to 1000 bytes in a system named IMSA.

$ ofconfig list -s osi.IMSA -sec PRINTER -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |     PRINTER      |       BUF_SIZE      |             1000
            |                  |     MASTER_NAME     |           MASTPRNT
===================================================================================

3.7. SCREEN

Sets 3270 screen size used in the OSI system.

3.7.1. 3270_TYPE

Size of 3270 screen to use. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

3270-A2

Range

3270-A2, 3270-A3, 3270-A7

Remark

  • 3270-A2 : 24*80 screen

  • 3270-A3 : 32*80 screen

  • 3270-A7 : 27*132 screen

The following sets the screen size to 3270-A7(27*132) in a system named IMSA.

$ ofconfig list -s osi.IMSA -sec SCREEN -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |      SCREEN      |      3270_TYPE      |           3270-A7
===================================================================================

3.8. MQ

Sets information about IBM MQ used in the OSI system.

3.8.1. USE_MQ

Option to use IBM Websphere MQ products. If set to YES, the system requests MQGET from a queue specified in APPLQ_NAME when receiving a trigger message, or requests MQPUT from a queue specified in TRANSQ_NAME when receiving a output message. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

Y_N

Default Value

NO

Range

YES, NO

Remark

  • YES : Uses IBM MQ.

  • NO : Does not use IBM MQ.

3.8.2. QMGR_NAME

Name of a queue manager of IBM Websphere MQ. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the name of a queue manager is processed as blank.

3.8.3. APPLQ_NAME

Name of an application queue from which MQGET is requested for an input message. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the name of an application queue is processed as blank.

3.8.4. TRANSQ_NAME

Name of an application queue from which MQGET is requested for an output message. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the name of a transmission queue is processed as blank.

3.8.5. MQ_LIB_PATH

MQ library path to use MQI (MQ Interface) for IBM MQ in the OSI system.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the MQ library path is processed as blank.

3.8.6. DEST_FILE_PATH

File path for the destination of an output message that is sent to IBM MQ.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the dest file path is processed as blank.

3.8.7. TIMEOUT

Timeout of the MQGET API used in a trigger monitor. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

10000 (Unit : ms)

Range

Remark

The following example uses IBM MQ in a system named IMSA, and sets a queue manager as QMA1, an application queue as APPLQ.QUEUE, a transmission queue as TRANSQ.QUEUE, MQ library path as /opt/mqm/lib64/libmqm.so, a destination file path as /home/oframe/dest.txt, and a timeout as 10 seconds.

$ ofconfig list -s osi.IMSA -sec MQ -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |        MQ        |      APPLQ_NAME     |         APPLQ.QUEUE
            |                  |    DEST_FILE_PATH   |    /home/oframe/dest.txt
            |                  |     MQ_LIB_PATH     |   /opt/mqm/lib64/libmqm.so
            |                  |      QMGR_NAME      |             QMA1
            |                  |       TIMEOUT       |            10000
            |                  |     TRANSQ_NAME     |         TRANSQ.QUEUE
            |                  |        USE_MQ       |             YES
===================================================================================

3.9. USER_PROGRAM

User programs that run when OSI user server is executed.

3.9.1. PGM_NAME

Specifies the user program name.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

User programs are searched in the following order: STEPLIB, JOBLIB, and LD_LIBRARY_PATH. Even if the program is not found, no error occurs.

If the value is specified as (NONE), it is processed as if the option has not been set.

The following is an example of configuring the user program TEST01 to run when starting the user server in the IMSA system.

$ ofconfig list -s osi.IMSA -sec USER_PROGRAM -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
  osi.IMSA  |   USER_PROGRAM   |       PGM_NAME      |            TEST01
===================================================================================

4. osi.{osimqsvrname}

Configures settings for the osimqsvr server named osimqsvrname that is used for Trigger Monitor of IBM MQ product. For example, if the server name is osimq001, the subject name is osi.osimq001, and the setting values are applied only to the osimq001 server.

4.1. MQ

Sets information about Queue Trigger Monitor of IBM MQ in the OSI system.

4.1.1. QMGR_NAME

Name of a queue manager of IBM Websphere MQ product. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the name of a queue manager is processed as blank.

4.1.2. INITQ_NAME

Name of an initiation queue from which MQGET is requested by a trigger message. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the name of an initiation queue is processed as blank.

4.1.3. IMSID

IMSID containing a schedule server (osisschd) that sends a trigger message. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), IMSID is processed as blank.

4.1.4. TIMEOUT

Timeout of the MQGET API used in a trigger monitor. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

10000 (Unit : ms)

Range

Remark

The following example setting specifies that an osimqsver server named osimq001 monitors an initiation queue named INIQ.QUEUE of QMA1 at an interval of 10 seconds, and a trigger message is sent to IMSID named IMSA.

$ ofconfig list -s osi.osimq001 -sec MQ -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
osi.osimq001|        MQ        |        IMSID        |             IMSA
            |                  |      INITQ_NAME     |         INITQ.QUEUE
            |                  |      QMGR_NAME      |             QMA1
            |                  |       TIMEOUT       |            10000
===================================================================================

If a message is put in an application queue, a trigger message is entered through a queue manager, and osimqsvr gets the trigger message from an initiation queue. Then the trigger message is sent to a schedule server contained in an imsid specified in the value of the IMSID key of the MQ section. The schedule server connects to an application queue to directly get the trigger message, and execute the scheduling according to the specified destination.

5. ssm.{IMSID}{SSM}

Configures settings for Tmax XA server to use MultipleRM for each IMS system in the OSI system. In a subject name, {IMSID} indicates the IMS system name that contains the XA server, and {SSM} indicates the subsystem ID used in an OSI user server (Dependent Region). In an OSI user server, corresponding settings are read by an SSM name specified in EXEC parameter in startup JCL.

5.1. GENERAL

Sets general information related to XA connection.

5.1.1. DLI_CONN_ID

conn_id connected to the database that executes the DLI function. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the conn_id value is processed as blank.

5.1.2. PRELOAD

Path for the xa-switch library file provided by the database in XA mode. All nodes in a multi-node environment must use the same configuration.

Item Description

Parameter Type

String

Default Value

(NONE)

Range

Remark

If the value is (NONE), the library path is processed as blank.

The following sets DLI_CONN_ID as DLI, and PRELOAD as ${TB_HOME}/client/lib/libtbxa.so:${DB2_HOME}/lib/libdb2.so in a system where IMSID is IMSA and SSM is DB2T.

$ ofconfig list -s ssm.IMSADB2T -sec GENERAL -n NODE1
===================================================================================
  SUBJECT   |     SECTION      |         KEY         |            VALUE
===================================================================================
ssm.IMSADB2T|     GENERAL      |     DLI_CONN_ID     |             DLI
            |                  |       PRELOAD       | ${TB_HOME}/client/lib/libtb
                                                       xa.so:${DB2_HOME}/lib/libdb2.so
===================================================================================