OpenFrame OSI System Tools

This chapter describes the usage of the tools used in the OpenFrame OSI system.

1. Overview

The following is a list of the programs used for OpenFrame OSI system operation.

Program Description

dfsuocu0

Copies staging library information to inactive library for dynamic change of resources.

imscmd

Enables to enter the OSI command without using terminals.

macroprep

Preprocesses assembler macros for dump.

osiboot

Starts OpenFrame core servers (Tmax/Base/Batch) and the OSI user server required to start and operate the OSI system.

osidown

Shuts down OpenFrame core servers (Tmax/Base/Batch) and the OSI user server.

osiinit

Creates or removes system table to required to operate OpenFrame OSI system.

osimfsgen

Creates 4 types (MID, MOD, DIF, and DOF) of binary files by compiling MFS files to machine language code.

osirtsddump

Displays system definition saved in the RTSD table in the macro format.

osisddump

Displays records saved in system definition table as MODBLKS library in the macro format on screen.

osisdgen

Reads the script file that defines macro resources and saves it to a specified system definition table in IMS system.

osiver

Displays the OSI system version.

osilogprt

Displays the logs stored through the LOG command of AIBTDLI.

osievtmgr

Retrieves information about OSI events.

osimqmgr

Retrieves information about OSI message queues.

osilogana

Analyzes transaction information in the DR region.

2. dfsuocu0

Copies staging library information to inactive library for dynamic change of resources. For more information about changing the staging library, refer to "Online Change Copy Utility" in IBM documents .

Usage

The following shows how to execute dfsuocu0.

Usage: dfsuocu0 <control region> [ACBLIB | FMTLIB | MODBLKS]
     | dfsuocu0 [-h | -v]

  • Parameters

    Parameter Description

    <control region>

    System server (control region) ID.

    [ACBLIB | FMTLIB |

    MODBLKS]

    Resource to copy.

    • ACBLIB

    • FMTLIB

    • MODBLKS

  • [options]

    Option Description

    [-h]

    Shows help information.

    [-v]

    Displays dfsuocu0 version.
Examples

The following copies MODBLKS by using dfsuocu0.

$ dfsuocu0 IMSA MODBLKS
- ACTIVE MODBLKS is MODBLKSA
- Succeeded to copy MODBLKS to MODBLKSB

3. imscmd

Enables to enter the OSI command without using terminals. Since a specific terminal cannot be specified, you cannot execute commands that affect an input terminal.

Usage

The following shows how to execute imscmd.

Usage: imscmd [-u <userid>/<passwd>] <control region> <command>
     | imscmd [-u <userid>/<passwd>] <crc><command>
     | imscmd [-h | -c | -v]

  • Parameters

    Parameter Description

    <control region>

    ID of the control region to execute commands.

    <command>

    Command to execute. For more information of <command> usage, refer to OpenFrame OSI Command Reference Guide.

    <crc>

    CRC value corresponding to the control region to execute commands.

    CRC (Command Recognition Character) is set as unique characters by region. CRC decides a region where the input command is executed. It must be set as unique characters by control region, and set with keys in the CRC section of osi.conf.

  • [options]

    Option Description

    [-u <userid>/<passwd>]

    Enters user ID and password with the execute permission when executing JCL.

    [-h]

    Shows help information.

    [-c]

    Displays IMS command information.

    [-v]

    Displays imscmd version.

  1. The /START REGION command that performs JCL requires a permission check by using the -u option, and if it is omitted, follow the settings in the INTRDR section of tjes.conf.
Examples

The following performs /DIS LTERM command by using imscmd.

$ imscmd IMSA /DIS LTERM ALL
IMS control region : [IMSA]
Requested command  : [DIS LTERM ALL]
----------------------------------------
LTERM     ENQCT  DEQCT    QCT
N031E01       0      0      0
N031E02       0      0      0
N031E03       0      0      0
N031E04       0      0      0
N031E05       0      0      0
N031E06       0      0      0
N031E07       0      0      0
N031E08       0      0      0
N031E09       0      0      0
*20363/103355*
----------------------------------------
Command '/DIS LTERM ALL' execution done

4. macroprep

Preprocesses assembler macros for dump. Some dump macros that do not affect screens and define maps need to be preprocessed by using mscasmc.

Usage

The following shows how to execute macroprep.

Usage: macroprep [options] <file>...

  • [options]

    Option Description

    [-c] <dir>

    Directory in which the COPY macro’s target file is located.

    [-s]

    Inserts a line break after the comma (,) that is the nearest to the 72nd column when creating a preprocessing file. Without this option, line-breaking occurs in the 71st column.

    [-o] <dir>

    Directory in which the result file of preprocessing is located.

    [-h]

    Shows help information.

    [-v]

    Displays macroprep version.

  • Parameters

    Parameter Description

    <file>

    Name of MFS format file to compile
Examples

The following preprocesses the OIVP001.TXT file by using macroprep and creates a new result file with an extension of prep.

$ macroprep -c copy OIVP001.TXT
$ ls
OIVP001.TXT       OIVP001.TXT.prep       copy

5. osiboot

Starts OpenFrame core servers (Tmax, Base, and Batch) and user servers required to start and operate the OSI system. The list of OpenFrame Base, OpenFrame Batch, and the user server to start must be registered in the $OPENFRAME_HOME/config/osi.ofsys.seq file.

  1. Starting OpenFrame core servers

    The following are the steps.

    1. Starting Tmax, the TP monitor that performs the OpenFrame core role

    2. Running server modules (OpenFrame Base and OpenFrame Batch) used in other OpenFrame packages for operating OSI.

  2. Starting OSI user servers

    To use OSI user server such as OTMA, start it with OpenFrame core servers.

  3. Starting OSI system servers

    Starts OSI system server such as osiomsvr, starting from OSI 7.2 version. The system servers are not registered in the osi.ofsys.seq file.

Usage

The following shows how to execute osiboot.

Usage: osiboot [options]
     | osiboot [-b] [-n <node_name>] [-o]
     | osiboot [-h | -v]

  • [options]

    Option Description

    [-b]

    Starts with backup servers in multi-node environment.

    [-n <node_name>]

    Node name to start.

    [-o]

    Starts OSI system server. It doesn’t start Tmax engine and servers registered in the $OPENFRAME_HOME/config/osi.ofsys.seq file.

    [-h]

    Shows help information.

    [-v]

    Displays osiboot version.
Examples

The following starts OpenFrame core servers.

$ osiboot

TMBOOT for node(NODE1) is starting:
  TMBOOT: TMM is starting: Thu Mar 11 16:23:50 2021
  TMBOOT: CLL is starting: Thu Mar 11 16:23:50 2021
  TMBOOT: CLH is starting: Thu Mar 11 16:23:50 2021
  TMBOOT: TLM(tlm) is starting: Thu Mar 11 16:23:50 2021
[2021-03-11T16:23:50.429741] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrsasvr) booting ok
[2021-03-11T16:23:50.432966] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrlhsvr) booting ok
[2021-03-11T16:23:50.436680] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrdmsvr) booting ok
[2021-03-11T16:23:50.440769] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrdsedt) booting ok
[2021-03-11T16:23:50.445375] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrcmsvr) booting ok
[2021-03-11T16:23:50.449697] [osiboot(20155)          ] [M] [OSI7061M] System server(ofruisvr) booting ok
[2021-03-11T16:23:50.453979] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrsmlog) booting ok
[2021-03-11T16:23:50.458096] [osiboot(20155)          ] [M] [OSI7061M] System server(obmjmsvr) booting ok
[2021-03-11T16:23:50.462654] [osiboot(20155)          ] [M] [OSI7061M] System server(obmjschd) booting ok
[2021-03-11T16:23:50.466494] [osiboot(20155)          ] [M] [OSI7061M] System server(obmjinit) booting ok
[2021-03-11T16:23:50.470602] [osiboot(20155)          ] [M] [OSI7061M] System server(obmjhist) booting ok
[2021-03-11T16:23:50.479765] [osiboot(20155)          ] [M] [OSI7061M] System server(obmjspbk) booting ok
[2021-03-11T16:23:50.485365] [osiboot(20155)          ] [M] [OSI7061M] System server(ofrpmsvr) booting ok
[2021-03-11T16:23:50.496121] [osiboot(20155)          ] [M] [OSI7061M] System server(obmtsmgr) booting ok
[2021-03-11T16:23:50.510815] [osiboot(20155)          ] [M] [OSI7061M] System server(tmsvr) booting ok
[2021-03-11T16:23:50.516011] [osiboot(20155)          ] [M] [OSI7061M] System server(osiomsvr) booting ok
[2021-03-11T16:23:50.516029] [osiboot(20155)          ] [M] [OSI7051M] Booting process complete.

6. osidown

Shuts down OSI system servers and servers in the ${OPENFRAME_HOME}/config/osi.ofsys.seq file list.

Usage

The following shows how to execute osidown.

Usage: osidown [options]
     | osidown [-i] [-n <node_name>] [-o]
     | osidown [-h | -v]

  • [options]

    Option Description

    [-i]

    Shuts down the servers immediately.

    [-n <node_name>]

    Name of the node to be shut down.

    [-o]

    Shuts down the OSI system servers. It doesn’t shut down Tmax engine and servers registered in the $OPENFRAME_HOME/config/osi.ofsys.seq file.

    [-h]

    Shows help information.

    [-v]

    Displays osidown version.
Examples

The following shuts down the entire OSI system.

$ osidown
[2021-03-11T16:27:52.702893] [osidown(20337)          ] [M] [OSI7141M] System server(osiomsvr) shutdown ok
[2021-03-11T16:27:52.706805] [osidown(20337)          ] [M] [OSI7141M] System server(tmsvr) shutdown ok
[2021-03-11T16:27:52.723706] [osidown(20337)          ] [M] [OSI7141M] System server(obmtsmgr) shutdown ok
[2021-03-11T16:27:52.732120] [osidown(20337)          ] [M] [OSI7141M] System server(ofrpmsvr) shutdown ok
[2021-03-11T16:27:52.742428] [osidown(20337)          ] [M] [OSI7141M] System server(obmjspbk) shutdown ok
[2021-03-11T16:27:52.750187] [osidown(20337)          ] [M] [OSI7141M] System server(obmjhist) shutdown ok
[2021-03-11T16:27:52.776262] [osidown(20337)          ] [M] [OSI7141M] System server(obmjinit) shutdown ok
[2021-03-11T16:27:52.786100] [osidown(20337)          ] [M] [OSI7141M] System server(obmjschd) shutdown ok
[2021-03-11T16:27:52.795757] [osidown(20337)          ] [M] [OSI7141M] System server(obmjmsvr) shutdown ok
[2021-03-11T16:27:52.843192] [osidown(20337)          ] [M] [OSI7141M] System server(ofrsmlog) shutdown ok
[2021-03-11T16:27:52.853223] [osidown(20337)          ] [M] [OSI7141M] System server(ofruisvr) shutdown ok
[2021-03-11T16:27:52.860983] [osidown(20337)          ] [M] [OSI7141M] System server(ofrcmsvr) shutdown ok
[2021-03-11T16:27:52.868241] [osidown(20337)          ] [M] [OSI7141M] System server(ofrdsedt) shutdown ok
[2021-03-11T16:27:52.875517] [osidown(20337)          ] [M] [OSI7141M] System server(ofrdmsvr) shutdown ok
[2021-03-11T16:27:52.883185] [osidown(20337)          ] [M] [OSI7141M] System server(ofrlhsvr) shutdown ok
[2021-03-11T16:27:52.890716] [osidown(20337)          ] [M] [OSI7141M] System server(ofrsasvr) shutdown ok

TMDOWN for node(NODE1) is starting:
  TMDOWN: CLH downed: Thu Mar 11 16:27:52 2021
  TMDOWN: CLL downed: Thu Mar 11 16:27:52 2021
  TMDOWN: TLM downed: Thu Mar 11 16:27:52 2021
  TMDOWN: TMM downed: Thu Mar 11 16:27:52 2021
  TMDOWN: TMAX is down

7. osiinit

Creates or removes system tables of REGION, MODSTAT, MQ, SD, and RTS required to operate OpenFrame OSI systems.

Usage

The following shows how to execute osiinit.

Usage: osiinit <command> [options]

  • Parameters

    Parameter Description

    <command>

    • create : Creates system tables of OpenFrame OSI.

    • remove : Deletes system tables of OpenFrame OSI.

    • list : Displays system table list of OpenFrame OSI.

  • [options]

    Option Description

    [-t] <table/index name>

    Specifies system tables/indexes to create or delete. Without this option, all systems/indexes are selected.

    [-st] <tablespace>

    Specifies a table space of system tables/indexes to create or delete.
Examples

The following displays the list of system tables used in OpenFrame OSI.

$ $ osiinit list
osiinit version 7.2.0(0) oframe@tmax:ofsrc/osi(#1) 2020-11-12 19:43:54
Initialize OpenFrame OSI System Tables

No   Table
----------------------------------------------
  1  OFM_OSI_MQ
  2  OFM_OSI_MQ_IDX1
  3  OFM_OSI_REGION
  4  OFM_OSI_REGION_SVR
  5  OFM_OSI_REGION_SVR_IDX1
  6  OFM_OSI_REGION_STATUS
  7  OFM_OSI_SD_DATABASE
  8  OFM_OSI_SD_APPLCTN
  9  OFM_OSI_SD_TRANSACT
 10  OFM_OSI_SD_TRANSACT_IDX1
 11  OFM_OSI_SD_TERMINAL
 12  OFM_OSI_SD_LTERM
 13  OFM_OSI_SD_LTERM_IDX1
 14  OFM_OSI_RTSD_DATABASE
 15  OFM_OSI_RTSD_APPLCTN
 16  OFM_OSI_RTSD_TRANSACT
 17  OFM_OSI_RTSD_TRANSACT_IDX1
 18  OFM_OSI_RTSD_TERMINAL
 19  OFM_OSI_RTSD_LTERM
 20  OFM_OSI_RTSD_LTERM_IDX1
 21  OFM_OSI_RTSD_MODS
 22  OFM_OSI_RTSD_MODS_IDX1
 23  OFM_OSI_MODSTAT
 24  OFM_OSI_CI
 25  OFM_OSI_LOG
 26  OFM_OSI_LOG_IDX1
 27  OFM_OSI_EVENT
 28  OFM_OSI_EVENT_IDX1
 29  OFM_OSI_EVENT_SEQ

The following creates OFM_OSI_SD_DATABASE table in the DEFVOL table space.

$ osiinit create -t OFM_OSI_SD_DATABASE -st DEFVOL
osiinit version 7.2.0(0) oframe@tmax:ofsrc/osi(#1) 2020-11-12 19:43:54
Initialize OpenFrame OSI System Tables

Creating OFM_OSI_SD_DATABASE...
 > "OFM_OSI_SD_DATABASE" created...

8. osimfsgen

Creates 4 types (MID, MOD, DIF, and DOF) of binary files by compiling MFS files to machine language code.

Usage

The following shows how to execute osimfsgen.

Usage: osimfsgen [options] <file>
     | osimfsgen [options] -o <dir> <file>
     | osimfsgen [options] -m <FMTLIB> <file>

  • Parameters

    Parameter Description

    <file>

    Name of MFS format file to compile.

    <dir>

    Directory in which the binary file is created.

    <FMTLIB>

    FMTLIB data set.

    [-o]

    Directory in which the binary file is created.

    [-m]

    FMTLIB data set for specific region.

    [-h]

    Shows help information.

    [-v]

    Displays osimfsgen version.

  • [options]

    Option Description

    [-d]

    Shows the MFS file to compile.

    [-l <level>]

    Specifies the level of message logs to display.

    • 1: Displays the process of preprocessing source to compile.

    • 2 : Displays unsupported statements.

    • 3 : Displays supported statements.

    • 4 : Displays both unsupported and supported statements.

    [-p 1]

    Previews the emulator screen in the 1 byte character format.

    [-p 2]

    Previews the emulator screen in the 2 byte character format.
Examples

The following compiles the OIVP001.TXT file and saves it in FMTLIB (OPNFRAME.ONLINE.MFDLIB) of IMSA.

$ osimfsgen -m OSI.IMSA.MFSLIB OIVP001.TXT
osimfsgen 7.2.0(0) oframe@tmax:ofsrc/osi(#1) 2020-11-12 19:43:54
[/home/oframe/products/ofsrc/OpenFrame/volume_default/OSI.IMSA.MFSLIB/OIVP001.mfs] create ok.
[/home/oframe/products/ofsrc/OpenFrame/volume_default/OSI.IMSA.MFSLIB/OIVP001I.mfs] create ok.
[/home/oframe/products/ofsrc/OpenFrame/volume_default/OSI.IMSA.MFSLIB/OIVP001O.mfs] create ok.

9. osirtsddump

Displays the system definition saved in the RTSD(RunTime System Definition) table of the specified IMS system in macro format on the screen. The macro output can be used as osisdgen input.

Usage

The following shows how to execute osirtsddump.

Usage: osirtsddump <imsid>
     | osirtsddump [-h | -v]

  • Parameters

    Parameter Description

    <imsid>

    ID of the system server (control region).

  • [options]

    Option Description

    [-h]

    Shows help information.

    [-v]

    Displays osirtsddump version.
Examples

The following reads the system definition saved in the RTSD table of IMSA, which is an IMS system, and displays the definition in macro format.

$ osirtsddump IMSA
DATABASE DBD=OIVPIDBD,ACCESS=EX
DATABASE DBD=OIVPIX1,ACCESS=EX
DATABASE DBD=OIVPIX2,ACCESS=EX
APPLCTN FPATH=NO,PSB=OIVPI001,PGMTYPE=(TP,,1),SCHDTYP=PARALLEL
TRANSACT CODE=OIVPMPP1,EDIT=(UC),FPATH=NO,INQUIRY=(NO),MAXRGN=0,       X
        MODE=SNGL,MSGTYPE=(SNGLSEG,RESPONSE,1),PARLIM=0,PROCLIM=(0,0), X
        PRTY=(1,5,65535),SEGNO=0,SEGSIZE=0
APPLCTN FPATH=NO,PSB=OIVPI002,PGMTYPE=(TP,,1),SCHDTYP=PARALLEL
TRANSACT CODE=OIVPMPP2,EDIT=(UC),FPATH=NO,INQUIRY=(NO),MAXRGN=1,       X
        MODE=SNGL,MSGTYPE=(SNGLSEG,RESPONSE,1),PARLIM=0,PROCLIM=(0,0), X
        PRTY=(1,5,65535),SEGNO=0,SEGSIZE=0
APPLCTN FPATH=NO,PSB=OIVPI003,PGMTYPE=(TP,,1),SCHDTYP=PARALLEL
TRANSACT CODE=OIVPMPP3,EDIT=(UC),FPATH=NO,INQUIRY=(NO),MAXRGN=0,       X
        MODE=SNGL,MSGTYPE=(SNGLSEG,RESPONSE,1),PARLIM=0,PROCLIM=(0,0), X
        PRTY=(1,5,65535),SEGNO=0,SEGSIZE=0
TERMINAL NAME=(OIVPTRM1),ADDR=(),BACKUP=(0),EDIT=(NO,NO),LTERM=        X
        MSGDEL=SYSINFO,OPTIONS=(PAGDEL,OPNDST,PROT),OPTIONS=(TRSOSI),  X
        FPBUF=0,BUFSIZE=0,HEADCTL=0,FEAT=(CARD,PEN),COMPT=(),MODEL=1,  X
        PTRSIZE=120,TYPE=,SIZE=(0,0),OUTBUF=0,UNIT=,COMPT1=(,IGNORE),  X
        COMPT2=(,IGNORE),COMPT3=(,IGNORE),COMPT4=(,IGNORE),MODETBL=,   X
        SEGSIZE=0,SESSION=0
NAME N031E01,EDIT=(,ULC),OUTPUT=
TERMINAL NAME=(OIVPTRM2),ADDR=(),BACKUP=(0),EDIT=(NO,NO),LTERM=        X
        MSGDEL=SYSINFO,OPTIONS=(PAGDEL,OPNDST,PROT),OPTIONS=(TRSOSI),  X
        FPBUF=0,BUFSIZE=0,HEADCTL=0,FEAT=(CARD,PEN),COMPT=(),MODEL=1,  X
        PTRSIZE=120,TYPE=,SIZE=(0,0),OUTBUF=0,UNIT=,COMPT1=(,IGNORE),  X
        COMPT2=(,IGNORE),COMPT3=(,IGNORE),COMPT4=(,IGNORE),MODETBL=,   X
        SEGSIZE=0,SESSION=0
NAME N031E02,EDIT=(,ULC),OUTPUT=
TERMINAL NAME=(OIVPTRM3),ADDR=(),BACKUP=(0),EDIT=(NO,NO),LTERM=        X
        MSGDEL=SYSINFO,OPTIONS=(PAGDEL,OPNDST,PROT),OPTIONS=(TRSOSI),  X
        FPBUF=0,BUFSIZE=0,HEADCTL=0,FEAT=(CARD,PEN),COMPT=(),MODEL=1,  X
        PTRSIZE=120,TYPE=,SIZE=(0,0),OUTBUF=0,UNIT=,COMPT1=(,IGNORE),  X
        COMPT2=(,IGNORE),COMPT3=(,IGNORE),COMPT4=(,IGNORE),MODETBL=,   X
        SEGSIZE=0,SESSION=0
NAME N031E03,EDIT=(,ULC),OUTPUT=

10. osisddump

Displays the records saved as the MODBLKS library in the system definition table of a specified IMS system in macro format on the screen. The macro output can be used as osisdgen input.

Usage

The following shows how to execute osisddump.

Usage: osisddump <imsid>
     | osisddump [-h | -v]

  • Parameters

    Parameter Description

    <imsid>

    ID of the system server (control region).

  • [options]

    Option Description

    [-h]

    Shows help information.

    [-v]

    Displays osisddump version.
Examples

The following reads the system definition saved as the MODBLKS library in the system definition table of IMSA, which is an IMS system, and displays the definition in macro format.

$ osisddump IMSA
DATABASE DBD=OIVPIDBD,ACCESS=EX
DATABASE DBD=OIVPIX1,ACCESS=EX
DATABASE DBD=OIVPIX2,ACCESS=EX
APPLCTN FPATH=NO,PSB=OIVPI001,PGMTYPE=(TP,,1),SCHDTYP=PARALLEL
TRANSACT CODE=OIVPMPP1,EDIT=(UC),FPATH=NO,INQUIRY=(NO),MAXRGN=0,       X
        MODE=SNGL,MSGTYPE=(SNGLSEG,1),PARLIM=0,PROCLIM=(0,0),          X
        PRTY=(1,5,65535),SEGNO=0,SEGSIZE=0
APPLCTN FPATH=NO,PSB=OIVPI002,PGMTYPE=(TP,,1),SCHDTYP=PARALLEL
TRANSACT CODE=OIVPMPP2,EDIT=(UC),FPATH=NO,INQUIRY=(NO),MAXRGN=1,       X
        MODE=SNGL,MSGTYPE=(SNGLSEG,1),PARLIM=0,PROCLIM=(0,0),          X
        PRTY=(1,5,65535),SEGNO=0,SEGSIZE=0
APPLCTN FPATH=NO,PSB=OIVPI003,PGMTYPE=(TP,,1),SCHDTYP=PARALLEL
TRANSACT CODE=OIVPMPP3,EDIT=(UC),FPATH=NO,INQUIRY=(NO),MAXRGN=0,       X
        MODE=SNGL,MSGTYPE=(SNGLSEG,1),PARLIM=0,PROCLIM=(0,0),          X
        PRTY=(1,5,65535),SEGNO=0,SEGSIZE=0
TERMINAL NAME=(OIVPTRM1),ADDR=(),BACKUP=(0),EDIT=(NO,NO),LTERM=        X
        MSGDEL=SYSINFO,OPTIONS=(PAGDEL,OPNDST,PROT),OPTIONS=(TRSOSI),  X
        FPBUF=0,BUFSIZE=0,HEADCTL=0,FEAT=(CARD,PEN),COMPT=(),MODEL=1,  X
        PTRSIZE=120,TYPE=,SIZE=(0,0),OUTBUF=0,UNIT=,COMPT1=(,IGNORE),  X
        COMPT2=(,IGNORE),COMPT3=(,IGNORE),COMPT4=(,IGNORE),MODETBL=,   X
        SEGSIZE=0,SESSION=0
NAME N031E01,EDIT=(,ULC),OUTPUT=
TERMINAL NAME=(OIVPTRM2),ADDR=(),BACKUP=(0),EDIT=(NO,NO),LTERM=        X
        MSGDEL=SYSINFO,OPTIONS=(PAGDEL,OPNDST,PROT),OPTIONS=(TRSOSI),  X
        FPBUF=0,BUFSIZE=0,HEADCTL=0,FEAT=(CARD,PEN),COMPT=(),MODEL=1,  X
        PTRSIZE=120,TYPE=,SIZE=(0,0),OUTBUF=0,UNIT=,COMPT1=(,IGNORE),  X
        COMPT2=(,IGNORE),COMPT3=(,IGNORE),COMPT4=(,IGNORE),MODETBL=,   X
        SEGSIZE=0,SESSION=0
NAME N031E02,EDIT=(,ULC),OUTPUT=
TERMINAL NAME=(OIVPTRM3),ADDR=(),BACKUP=(0),EDIT=(NO,NO),LTERM=        X
        MSGDEL=SYSINFO,OPTIONS=(PAGDEL,OPNDST,PROT),OPTIONS=(TRSOSI),  X
        FPBUF=0,BUFSIZE=0,HEADCTL=0,FEAT=(CARD,PEN),COMPT=(),MODEL=1,  X
        PTRSIZE=120,TYPE=,SIZE=(0,0),OUTBUF=0,UNIT=,COMPT1=(,IGNORE),  X
        COMPT2=(,IGNORE),COMPT3=(,IGNORE),COMPT4=(,IGNORE),MODETBL=,   X
        SEGSIZE=0,SESSION=0
NAME N031E03,EDIT=(,ULC),OUTPUT=

11. osisdgen

Reads the script file that defines macro resources and saves it as the MODBLKS library to the system definition table of a specified IMS system. If the macro file includes duplicate definitions or the data set already includes definitions of the same resource, the definitions are overwritten.

Usage

The following shows how to execute osisdgen.

Usage: osisdgen [-d] [-l] <file> <imsid>
     | osisdgen [-h | -v]
     | osisdgen -s [AP | DB | NM | TR | TRM] <sd_name> <imsid>

  • Parameters

    Parameter Description

    <file>

    Resource definition macro file you want to save to the system definition table.

    <imsid>

    ID of the system server (control region).

  • [options1]

    Option Description

    [-d]

    Deletes existing records saved as the MODBLKS library in the system definition table before saving.

    [-l]

    Displays macros that are ignored by missing preprocessed macros or that are not supported in OSI.

    [-s]

    Deletes a single record from the table by specifying its resource name and type. If you delete a resource by specifying APPLCTN or TERMINAL type, related TRANSACT or NAME resources are also deleted from the table.

    The following types can be specified.

    • AP : APPLCTN

    • DB : DATABASE

    • NM : NAME

    • TR : TRANSACT

    • TRM : TERMINAL

  • [options2]

    Option Description

    [-h]

    Shows help information.

    [-v]

    Displays osisdgen version.
Examples

The following reads the resource definition macros in the osi_sd.dat file and saves them to the system definition table of IMSA, which is an IMS system.

$ osisdgen -d osi_sd.dat IMSA
[2020-12-28T14:24:05.886998] [osisdgen(8205)          ] [M] [OSI7203M] Processing result : Success[43], Ignore[0], Error[0]

The following deletes the single resource APPLCTN "OIVPI001" from the system definition table of IMSA, which is an IMS system.

$ osisdgen -s AP OIVPI001 IMSA
[2020-12-28T14:24:17.123691] [osisdgen(8212)          ] [M] [OSI7203M] Processing result : Success[1], Ignore[0], Error[0]

12. osiver

Displays the OSI system version.

Usage

Use this tool without an option.

Usage: osiver
Examples

The following displays the OSI system version.

$ osiver
OpenFrame OSI 7.2 64bit

13. osilogprt

Displays the stored logs with the LOG command of AIBTDLI.

Usage

The following shows how to execute osilogprt.

Usage: osilogprt <imsid> [options]
     | osilogprt [-h | -v]

  • Parameters

    Parameter Description

    <imsid>

    Name of the MFS format file to compile.

    [-h]

    Displays the detailed usage instruction for the program.

    [-v]

    Shows the version information of osilogprt.

  • [options]

    Option Description

    [-d <date>]

    Displays logs for a specific date <YYYYMMDD>.

    [-r <date>]

    Deletes logs for a specific date <YYYYMMDD>.

    [-r -i <date>]

    Deletes logs for a specific date <YYYYMMDD> without checking.
Examples

The following shows an example of displaying the stored logs through the LOG command of AIBTDLI.

$ osilogprt IMSA -d 20230321
IMS control region : [IMSA]
    Requested date : [20230321]
-------------------------------------------------------------------
               NO.  TIME      TRAN      PROGRAM   LL    C  Text
                 1  13:44:55  TESTBMP1  TESTI001    45  ~  TESTBMP120230321123456782022050912345678
                 2  14:47:57  TESTBMP1  TESTI001    45  ~  TESTBMP120230321123456782022050912345678
                 3  17:18:00  TESTBMP1  TESTI001    45  ~  TESTBMP120230321123456782022050912345678
                 4  18:35:02  TESTBMP1  TESTI001    45  ~  TESTBMP120230321123456782022050912345678
                 5  19:05:04  TESTBMP1  TESTI001    45  ~  TESTBMP120230321123456782022050912345678
-------------------------------------------------------------------

14. osievtmgr

Retrieves information about OSI events.

Usage

The following shows how to execute osievtmgr.

Usage: osievtmgr <imsid> <command> [options]
     | osievtmgr [-h | -v]

  • Parameters

    Parameter Description

    <imsid>

    Specifies the IMSID on which to execute the command.

    <command>

    • display: Retrieves statistical information about OSI events.

    • detail: Retrieves detailed information about OSI events.

    • format: Deletes all OSI events and resets sequence numbers of events.

  • [options]

    Command Option Description

    display

    (blank)

    Retrieves events for the current date.

    -d <date>

    Retrieves events for a specific date.

    -f <date>

    Retrieves events from a specific date to the current date.

    -f <date1> -t <date2>

    Retrieves events for the specified period.

    -l <I|E|F>

    Retrieves events with a specific severity level.

    -r

    Displays events in reverse order.

    detail

    <seq no>

    Retrieves the details of a specific OSI event.

    format

    -i

    Resets immediately without confirmation.

    (blank)

    -h

    Displays detailed instructions for the program.

    -v

    Displays the version information of osievtmgr.

The date formats are either <YYYYMMDD> or <YYYYMMDD:HHmmss>.
Example

The following displays the list of events in OpenFrame OSI.

$ osievtmgr IMSA display -d 20240625
IMS control region : [IMSA]
Requested command  : [display]
-------------------------------------------------------
From date          : [20240625:000000.0000]
--------------------------------------------------------------------------------------------------------
 NO.    TIMESTAMP             NODE   PROCESS                     LV  PR  CODE  DETAIL
--------------------------------------------------------------------------------------------------------
 80495  20240625:170124.3695  NODE1  IMSAMPP_TCL4(578504)        I   N   3000  Region boot
 80494  20240625:170124.3668  NODE1  IMSAMPP_TCL2(578500)        I   N   3000  Region boot
 80493  20240625:170124.3518  NODE1  IMSAMPP_TCL1(578496)        I   N   3000  Region boot
 80492  20240625:170124.3516  NODE1  IMSAMPP_TCL3(578502)        I   N   3000  Region boot
 80491  20240625:170124.3516  NODE1  IMSAMPP_TCL1(578497)        I   N   3000  Region boot
 80490  20240625:170124.3513  NODE1  IMSAMPP_TCL1(578498)        I   N   3000  Region boot
 80489  20240625:170122.8625  NODE1  IMSASCHD(578393)            I   N   1000  Normal restart
 80488  20240625:170122.8613  NODE1  IMSASCHD(578393)            I   N   1002  Simple checkpoint

The following shows how to retrieve the details of a specific OSI event in OpenFrame OSI.

$ osievtmgr IMSA detail 80495
IMS control region : [IMSA]
Requested command  : [detail]
--------------------------------------------------------------------------------------------------------
 NO.          : 80495
 TIMESTAMP    : 20240625:170124.3695
 NODE         : NODE1
 JOBID        : JOB06514
 JOBNAME      : IMSAMSG
 STEPNAME     : STEP1
 PROCESS      : IMSAMPP_TCL4
 TYPE         : MPP
 PID          : 578504
 TRANSACT     :
 PROGRAM      :
 TERMINAL     :
 LTERM        :
 SEVERITY     : I
 MSGID        :
 ERROR_CODE   : 0
 PROC_YN      : N
 EVENT_CODE   : 3000
 EVENT_DETAIL : Region boot
 REG_NODE     : NODE1
 REG_PROCESS  : IMSAMPP_TCL4
 REG_PID      : 578504
--------------------------------------------------------------------------------------------------------

The following shows how to retrieve the details of an MSG in OpenFrame OSI.

[root@oframe osievtmgr]# osievtmgr d -m 202405211650315122610000000000000173
osievtmgr version 7.2.0(0) root@oframe:ofsrc/osi(#1) 2024-02-28 11:22:36
OpenFrame OSI MQ Manager

- MSG ID           : 202405211650315122610000000000000173
- IMSID            : IMSA
- MSG Flag         :
- MSG Type         : REQMSG
- DEST Name        : OIVPMPP1
- DEST Type        : M
- TERM Name        : OIVPTRM8
- LTERM Name       : N031E08
- MODE Name        : OIVP001O
- SVC Name         :
- GW Client ID     : 13
- Client ID        : 11
- Region Client ID : 0
- IP Address       : 13.13.70.93
- MSG Input Date   : 0024142C
- MSG Input Time   : 1650310C
- Program MOD Y/N  : Y
- Prev. MSG ID     :
- MSG Sequence     : 0
- PCB Flag         : NULL
- Segment Count    : 0
- Error TRANSACT   :
- Command Option   :
- SPA Length       : 0
- Error Code       : 0
- Alt. Type        : ISRTNOT
- MSG Length       : 20
- MSG State        : D
- Reg. Time        : 2024/05/22 01:50:31.513769
- Upt. Time        : 2024/05/22 01:50:31.540198
- Message >
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
*offset*:  00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F  0123456789ABCDEF
00000000:  14 00 00 00 4F 49 56 50 4D 50 50 31 20 20 20 20  ....OIVPMPP1
00000010:  49 4E 51 52                                      INQR
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
Event Codes

The following describes each event that can be retrieved.

Event Code Details Description

0500

Failed to connect to MQ Qmanager

Failed to connect to IBM MQ Qmanager.

0501

MQ connection has been lost

IBM MQ connection has been lost.

0600

Sending OTMA transaction message failed

Failed to send OTMA transaction message.

0601

Sending OTMA response message failed

Failed to send OTMA response message.

1000

Normal restart

The NRESTART command was successfully processed.

1001

Emergency restart

The ERESTART command was successfully processed.

1002

Simple checkpoint

A SIMPLE CHECKPOINT occurred.

1003

Shutdown checkpoint

A SHUTDOWN CHECKPOINT occurred.

3000

Region boot

Dependent Region started.

3001

Region down

Dependent Region stopped.

3002

Region abend

An ABEND occurred in the Dependent Region. If it is a USER ABNED, the ABEND code is recorded.

4000

Transaction Failed

Transaction processing failed.

4001

PCB status code is ZZ

An unexpected exception occurred during a DL/I call.

15. osimqmgr

Retrieves information about OSI message queues.

Usage

The following shows how to execute osimqmgr.

Usage : osimqmgr <command> [options]

  • Parameters

    Parameter Description

    <command>

    • summary: Retrieves statistical information about OSI MQ.

    • list: Retrieves the list of OSI MQs based on the conditions defined in the options.

    • display: Retrieve the details about a specific message in OSI MQ by specifying the MSG ID.

  • [options]

    Command Option Description

    list

    -i

    Specifies the IMS ID.

    -sm

    Specifies the starting MSG ID for the search.

    -tm

    Specifies the ending MSG ID for the search.

    -term

    Specifies the terminal ID.

    -lterm

    Specifies the logical terminal ID.

    -w

    Displays additional information in the output field.

    -r

    Specifies retrieval in reverse order by Message ID.

    display

    -m

    specifies the OSI MSG ID.

In OSI, MSG IDs are formatted as 'YYYMMDDHHMMSS…​', indicating the issuance date of the MSG ID. Therefore, if the MSG ID has been specified with the list command, messages issued at the specified time can be retrieved by referencing it.
Example

The following shows an example of retrieving statistical information about MSG IDs in OpenFrame OSI.

$ osimqmgr summary
osimqmgr version 7.2.0(0) root@oframe:ofsrc/osi(#1) 2024-02-28 11:22:36
OpenFrame OSI MQ Manager

# OSI message statistics by state
--------------------------------------
State                            Count
--------------------------------------
Waiting                              4
 - MPP                               0
 - BMP                               4
 - Term                              0
 - ISC                               0
 - OTMA                              0
 - Command                           0
 - Tool                              0
Deleted                             85
Total                               89
--------------------------------------

The following example shows the MSG list in OpenFrame OSI.

$ osimqmgr list
osimqmgr version 7.2.0(0) root@oframe:ofsrc/osi(#1) 2024-02-28 11:22:36
OpenFrame OSI MQ Manager

MSGID                                IMS  MTYPE    DEST     TERM     LTERM    STATE Registered          Updated
---------------------------------------------------------------------------------------------------------------------------
202405061444209217810000000000000173 IMSA REQMSG   /FOR     OIVPTRM3 N031E03  D     2024/05/06 23:44:20 2024/05/06 23:44:20
---------------------------------------------------------------------------------------------------------------------------
- Total 1 message(s) were printed

The following shows how to retrieve the details of an MSG in OpenFrame OSI.

[root@oframe osimqmgr]# osimqmgr d -m 202405211650315122610000000000000173
osimqmgr version 7.2.0(0) root@oframe:ofsrc/osi(#1) 2024-02-28 11:22:36
OpenFrame OSI MQ Manager

- MSG ID           : 202405211650315122610000000000000173
- IMSID            : IMSA
- MSG Flag         :
- MSG Type         : REQMSG
- DEST Name        : OIVPMPP1
- DEST Type        : M
- TERM Name        : OIVPTRM8
- LTERM Name       : N031E08
- MODE Name        : OIVP001O
- SVC Name         :
- GW Client ID     : 13
- Client ID        : 11
- Region Client ID : 0
- IP Address       : 13.13.70.93
- MSG Input Date   : 0024142C
- MSG Input Time   : 1650310C
- Program MOD Y/N  : Y
- Prev. MSG ID     :
- MSG Sequence     : 0
- PCB Flag         : NULL
- Segment Count    : 0
- Error TRANSACT   :
- Command Option   :
- SPA Length       : 0
- Error Code       : 0
- Alt. Type        : ISRTNOT
- MSG Length       : 20
- MSG State        : D
- Reg. Time        : 2024/05/22 01:50:31.513769
- Upt. Time        : 2024/05/22 01:50:31.540198
- Message >
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
*offset*:  00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F  0123456789ABCDEF
00000000:  14 00 00 00 4F 49 56 50 4D 50 50 31 20 20 20 20  ....OIVPMPP1
00000010:  49 4E 51 52                                      INQR
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

16. osilogana

Analyzes transaction information in the DR region in OSI.

Usage

The following shows how to execute osilogana.

 Usage: osilogana [input] [options]
      | osilogana [-h | -v]

  • [input]

    Input Description

    -f <file>

    Takes transaction log input from a file.

    (none)

    Takes transaction log input from stdin.

  • [options]

    Option Description

    -r

    Displays transaction information in reverse order.

    -h

    Displays program usage details.

    -v

    Displays the version information of osilogana.
Example

The following example shows how to read MPP server logs in OpenFrame OSI and analyze transaction information.

$ osilogana -f IMSAMPP_TCL106262024.out
 LINE COUNT    : 490
 OFM LOG COUNT : 284

 * No. 1
   MSGID   : 202406261715436833610000000000000109  PROCESS ID: 3105887
   TRANSACT: OIVPMPP2                              LOG COUNT : 281
   APPLCTN : OIVPI002                              PSB       : OIVPI002
   STARTED : 2024-06-26T17:15:43.687641            START LINE: 3
   ENDED   : 2024-06-26T17:15:43.712614            END LINE  : 489
   ELAPSED :                   0.024973
   --------------------------------------------------------------------------------------------------------
   SEQ  DL/I  PCB  IDX  DBD       SEGMENT   ST  TIMESTAMP                   ELAPSED   TX_ELAPSED  LINE
   --------------------------------------------------------------------------------------------------------
     1  GU     IO    1                          2024-06-26T17:15:43.698290  0.000963    0.011612  221-259
     2  GU     DB    3  OIVPIDBD  DBSEG         2024-06-26T17:15:43.699337  0.001247    0.012943  262-333
     3  CHNG  ALT    2                          2024-06-26T17:15:43.700640  0.001251    0.014250  337-360
     4  ISRT  ALT    2                          2024-06-26T17:15:43.701932  0.000664    0.014955  362-393
     5  PURG  ALT    2                          2024-06-26T17:15:43.702628  0.000558    0.015545  395-417
     6  ISRT   IO    1                          2024-06-26T17:15:43.703217  0.000646    0.016222  419-457