OpenFrame/OSC System Tools

The following are tools for convenient management of the OSC system.

The excicblpp tool executes preprocessing to support EXCI (external CICS Interface). It allows specific region programs to be executed in DPL within COBOL programs, such as batch programs, externally from OSC.

The excicblpp tool can be invoked as follows:

The following example preprocesses the SAMPLE00.cob file in verbose mode and creates the excicblpp_SAMPLE00.cob file.

Executing the above command will display the following message and execute preprocessing.

The mscadjust tool fixes some of the two-byte character conversion errors that can occur during the map migration process.

Problems usually occur if, in the EBCDIC host map file, different types of two-byte characters are used together. This can happen if Korean and Japanese characters are mixed together. Errors can also occur in the map field definition if programming-type elements are used, such as PS=X’F8'. In the latter example, the dsmigin tool cannot convert the field to two-byte characters properly because it does not recognize elements of BMS map macro syntax, such as PS.

In order to use mscadjust, two files are required as input - the EBCDIC source map file and the ASCII source code file that is used to recognize the syntax. After being converted to ASCII but before being passed to mscadjust, the map source codes should be preprocessed with mscasmc.

mscadjust uses these files to find any fields that might not be converted appropriately with dsmigin. It then displays the results of a one-byte conversion and a two-byte conversion to user. Users can then choose one of the conversion methods for that field.

The mscadjust tool can be invoked as follows:

In the following example, the map source code file SAMPLE00.adj is created by using the mscadjust tool to process the EBCDIC source file SAMPLE00 and the ASCII map source code file SAMPLE00.map.atm which has been preprocessed with mscasmc.

The mscasmc tool preprocesses assembler macro commands for use in a map file. Certain macros used such as 'PRINT ON', 'NOGEN', and 'TITLE' don’t affect output but are still used in the dump process. These types of macros must be preprocessed by mscasmc.

The mscasmc tool can be invoked as follows:

The following example shows how mscasmc is used to preprocess the assembler macro commands for the dump in SCSOW03.map.

After preprocessing, the following messages will be displayed.

The mscmapc tool generates two files – a symbolic map file and a physical map file – by compiling map source codes.

The symbolic map file is a COBOL copybook file that defines the data structures used in applications. The physical map file is a binary file which describes the properties of each field in the map and the information required for data conversion.

The mscmapc tool can be invoked as follows:

The following example demonstrates the generation of the symbolic map file and the physical map file in the current directory after the CESN.map file is compiled.

The messages at the bottom of the example indicate successful execution.

In the following example, a copybook file and a binary are created in the ~/OPENFRAME_HOME/osc/map directory by setting the –o option.

In the next example, the files are generated in the OSC00001 region after compiling the CESN.map file with the -r option.

The mscmapupdate tool dynamically manages mapset information used by OSC regions. While tasks are in progress, the user can change map information and promptly apply the changes, or load additional information. The mscmapupdate tool supports functions to search and delete mapset information stored in the current memory.

The mscmapupdate tool can be invoked as follows:

The following example displays mapset information registered in the OSC00001 region.

In the following example, the OIVPMS1 mapset is updated in the OSC00001 region. Use the -r option to delete a mapset from a region.

In the following example, the OIVPMS1 mapset is updated in all nodes of the OSC00001 region. Use the -r option to delete a mapset from a region.

The oscadmin tool manages OSC regions.

The oscadmin tool can be invoked as follows:

The following example sets the log level of OSC00001 region to I.

The oscappbuild tool automatically creates OSC applications. It currently supports PL/I language only.

The oscappbuild tool can be invoked as follows:

The following example creates a program source written in PL/I, pg00.pli. As a result, a program binary, pg00.so, will be created.

The oscboot tool starts the entire OSC system or specific regions. oscboot provides script files such as oscboot.pre and oscboot.post to perform necessary tasks before and after the system boot.

oscboot.pre and oscboot.post scripts operate only for options that boot Tmax and OpenFrame system servers ( -N, -T, -b, -C, -B). They do not operate for options such as the -r option that boots a specific region.

The oscboot tool can be invoked as follows. If no options are specified, the OSC system servers and OSC regions will be booted according to the general steps described above.

The following example boots Tmax system processes without OpenFrame system servers or OSC system servers.

The following example boots Tmax and the OpenFrame system servers specified in ofsys.seq.

The following example boots the OSC system servers and OSC user servers specified in ofosc.seq, and then boots the OSC00001 region.

The oscbuild tool automatically creates an OSC application server. The build of an application server is dependent on the operating system and database type.

The oscbuild tool can be invoked as follows:

The following example creates an OSC application server OSC00001, which is for Linux 64Bit and does not use a database. (Describe the following command in a single line.)

The osccblpp tool preprocesses the EXEC CICS command within the COBOL source code used by OSC. If no option is specified, a file is created with a name containing a prefix "osccblpp_".

The osccblpp tool can be invoked as follows:

The following example creates the file osccblpp_SAMPLE00.cob by preprocessing SAMPLE00.cob.

The osccheck tool checks for errors in the configuration file or shared memory of OSC regions. osccheck provides a binary image dump function for shared memory so that it can check if the shared memory is damaged.

With the osccheck tool, problems such as omission of required elements, incorrect configuration values, and range errors can be checked. The configuration values to be used by the servers, can also be checked.

osccheck has the following four verification levels:

An option is provided to set which level of messages will be displayed.

The osccheck tool can be invoked as follows:

The following example checks the OSC00001 server configuration and displays a warning message.

Some statements in COBOL programs are not processed by the Unix compiler because of the differences between mainframe and Unix environment characteristics. The osccobprep tool preprocesses these statements so that COBOL programs can be used in OSC, and can also be used to add commands for the OSC system or to enable debugging. Currently, this tool preprocesses BLL (Base Locator for Linkage), BMSMAPBR, and EDF.

Unless an output filename is given or the prefix option is set, the output filename has the "osccobprep_" prefix attached to it.

The osccobprep tool can be invoked as follows:

The following example preprocesses TESTCOB.cob with osccobprep to create the osccobprep_TESTCOB.cob file. The copybook extension used in the program is .cob and the copybook directory path is set to $OPENFRAME_HOME/osc/Copybook.

Some statements in C programs are not processed by the Unix compiler because of the differences between mainframe and Unix environment characteristics. The osccprep tool preprocesses these statements so that C programs can be used in OSC, and can also be used to add commands for the OSC system.

Unless an output filename is given or the prefix option is set, the output filename will have the "osccprep_" prefix attached to it. If the -o option is not specified, the resulting file extension will be ".c".

The osccprep tool adds the dfheiptr.h header file provided by OSC and converts commands that start with EXEC CICS into functions provided by OSC during preprocessing.

The osccprep tool can be invoked as follows:

The following example preprocesses TEST.ccs with osccprep to create the osccprep_TEST.c file.

The following example preprocesses TEST.ccs with osccprep to create the TEST.c file.

The oscdct2rd tool converts the DCT macro used in IBM CICS Transaction Server (CICS) to the TDQUEUE macro used by the OSC system.

The oscdct2rd tool can be invoked as follows:

The following example converts the TDQUEUE defined in DCT.dat to TDQUEUE.dat, a TDQUEUE definition file, by configuring TDQUEUE to use the group name OSCGROUP:

The oscdown tool shuts down the entire OSC system or specified regions. oscdown provides script files such as oscdown.pre and oscdown.post that allow the user to perform necessary tasks before and after the system shutdown.

oscdown.pre and oscdown.post scripts operate only for options that shut down Tmax and OpenFrame system servers. They do not operate for options such as -r that shuts down a specific region.

The oscdown tool can be invoked as follows:

The following example specifies S1 as SUFFIX for PLTSD and shuts down the OSC00001 region.

The following example forcibly shuts down all OSC systems:

The oscinit tool creates or removes system tables and log tables needed when you first install OpenFrame OSC.

The oscinit tool can be invoked as follows:

The following example creates and removes a system table in the OFM_REPOSITORY tablespace, and a log table in the OFM_LOG tablespace.

The oscjct2rd tool converts the JCT (Journal Control Table) used in CICS to the JOURNALMODEL resource definition used by OSC. The [–g] option must be specified when using oscjct2rd, as JCT does not have an element corresponding to the GROUP element in the JOURNALMODEL resource definition.

The oscjct2rd tool can be invoked as follows:

The following example creates JOURNALMODEL.dat by converting JCT.dat.

The osclogrpt tool retrieves statistics on transaction logs specified as RDB in OSC. It displays the number of transactions, the average execution time, and the average CPU execution time by hour.

The osclogrpt tool can be invoked as follows:

The following example displays hourly statistics on transaction executions on all nodes in the OSC00001 region on 2019/05/27.

The following describes each item.

The following example displays statistics on transactions executions in the OSC00001 region on 2019/05/27.

The following describes each item.

The following example displays total statistics on transaction executions in the OSC00001 region on 2019/05/27.

The following describes each item.

The oscplipp tool preprocesses EXEC CICS commands within OpenFrame/OSC PLI application program source. The results of preprocessing are saved as a file with the prefix 'oscplipp_' added to the input filename.

The oscplipp tool can be invoked as follows:

The following example preprocesses the sample00.pli fileto create a file named oscplipp_sample00.pli.

The oscpltc tool compiles the DFHPLT macro.

The oscpltc tool can be invoked as follows:

The following example compiles the PLT macro definitions from PLT.dat and deploys to the OSC00001 region.

The oscresp tool displays information about errors on the OSC application server. If the RESP and RESP2 variables are set as a result of an EXEC CICS statement used by an application, the oscresp tool can be used to view the corresponding values.

The oscresp tool can be invoked as follows:

The following example displays information about the error where RESP=10 and RESP2=00 are specified in EXEC CICS RECEIVE MAP (EIBFN=1802).

The oscrtsddump tool exports RTSD resource definition information to a macro file. This tool extracts resource definition information of a specified OSC region, and the macro file it generates can be used as the input file for the oscrtsdupdate tool.

The oscrtsddump tool can be invoked as follows:

The following example reads RTSD resource definitions from the OSC00001 region, and exports them to the resource.dat file.

The oscrtsdupdate tool reads macro files that contain RTSD resource definitions and imports the information in them to the RTSD of an active OSC region. This tool updates only the resource definitions that exist in the RTSD of the specified region. To see details about which resource definitions and properties will be updated, run this tool in detail mode (-V).

The oscrtsdupdate tool can update only the following resources and options.

The oscrtsdupdate tool can be invoked as follows:

The following example reads RTSD resource definitions stored in the resource.dat file and imports them to the RTSD of the OSC00001 region.

The following example runs oscrtsdupdate in detail mode.

The oscruntran tool executes a specified transaction of a region.

The oscruntran tool can be invoked as follows:

The following example uses oscruntran to execute the OIVP transaction in the OSC00001 region.

The oscscview tool displays items that have been scheduled with either the START and DELAY commands or the TDQ ATI function. The following items can be checked with this tool.

The oscscview tool can be invoked as follows:

The following example shows that the transaction OIBR, which was executed in the OSC00001 region, is now waiting for scheduling.

The oscsddump tool exports OSC resource definitions from OSC SD tables to a macro file. Specific definitions or all of the definitions from one or all OSC SD tables used within an OSC region can be exported. The resulting macro file can be used again as an input file with the oscsdgen tool.

The oscsddump tool can be invoked as follows:

The following example reads resource definitions from the SD table used in the OSC00001 region, and then exports them as macros into the resource.dat file.

The oscsdgen tool imports the resource definition from a macro-type text file into a database table used in a specified OSC region.

If duplicate definitions exist within a resource definition macro file or SD table, the older definitions will be overwritten with the newer definitions. The oscsdgen tool can also remove a specified resource. When executing this tool, TACF authentication is performed but TACF users' permission to access SD is not checked.

OSC saves Change User ID, Change Time, and Define Time when adding or modifying a transaction resource. The information can be checked with ofmanager, not oscsddump.

The oscsdgen tool can be invoked as follows:

The following example reads resource definition macros from the resource.dat file, and imports them into an SD table with a region name 'OSC00001'.

The following example deletes an already registered resource from a database table used in the OSC00001 region.

The following example executes TACF user login if the TACF user has not logged in.

The osctdlinit tool initializes the Tmax Dynamic Library (TDL) shared memory and dynamic modules within OSC regions. osctdlinit must be executed before the OSC system is booted. Multiple regions can be initialized at once.

The osctdlinit tool can be invoked as follows:

The following example initializes the TDL shared memory and dynamic modules in the OSC00001 and OSC00002 regions.

The osctdlrm tool completely erases the contents of a region’s TDL shared memory. Note that after osctdlrm is executed, osctdlinit has to be re-executed. Otherwise, the registered modules cannot be used. osctdlrm can be used on multiple regions at once.

The osctdlrm tool can be invoked as follows:

The following example erases TDL shared memories in the OSC00001 and OSC00002 regions.

The osctdlupdate tool registers and updates dynamic modules within OSC regions. If the specified module is already registered, it will be updated. If it is not already registered, it will be registered. osctdlupdate can update multiple modules at once.

The osctdlupdate tool can be invoked as follows:

The following example updates the OIVPMAIN and OIVPINFO modules in the OSC00001 region.

The osctsqcheck tool monitors information about locks used in the TSQ memory area and removes abnormally-used locks. It also displays the size of TSQ memory area and data length.

Two kinds of locks are used in the TSQ: INDEX locks and ITEM locks. An INDEX lock locks the index of the hash structure, or table, that stores TSQ key information, while an ITEM lock locks an individual TSQ area.

This tool monitors lock information at user-defined intervals, and reports information about active locks until the monitoring period ends. If no locks were detected during the initial monitoring, or if all locks were released or removed during the monitoring process, osctsqcheck stops monitoring and reports that no locks were found.

The osctsqcheck tool can be invoked as follows:

The following example checks locks 10 times, at one-second intervals, in the TSQ used by the OSC00001 region.

The following example unlocks the 3852th index lock in the OSC00001 region.

The following example unlocks TSQ00001, a TSQ used in the OSC00001 region.

The following example displays information about all TSQ memories used in the OSC00001 region.

The osctxadm tool displays the status of the transactions running in the current region.

The osctxadm tool can be invoked as follows:

The following example displays information about transactions running in the OSC00001 region.

The oscxltc tool compiles DFHXLT macros.

The oscxltc tool can be invoked as follows:

The following example reads the WLT macro definitions from the XLT.dat file, and then deploys them to the OSC00001 region.