z/OS ISPF Software Configuration and Library Manager Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


DBUTIL—Generate a Tailored Output Data Set and Report

z/OS ISPF Software Configuration and Library Manager Guide and Reference
SC19-3625-00

The DBUTIL service retrieves information from the project database and creates tailored output and a report. SCLM generates the tailored output in the format you specify. It also describes the contents of the project database based on the selection criteria you supply. You can use the tailored output as input to future FLMCMD command invocations (using the FILE format of FLMCMD) or as input to other project-defined processors.

If you use the FILE format of FLMCMD to call the DBUTIL service, you can save the input parameters in a data set, then use the data set for future invocations of the DBUTIL service. See Using the FLMCMD file format for details on using the FILE format of FLMCMD.

The report indicates the contents of the project database based on the selection criteria you supply to the DBUTIL service.

Command invocation format

Read syntax diagramSkip visual syntax diagram
                                          .-*-----------.   
>>-FLMCMD--DBUTIL,project,-+---------+--,-+-------------+------->
                           '-prj_def-'    '-acct_group1-'   

>--,-+-------------+--,-+-------------+--,-+-------------+------>
     '-acct_group2-'    '-acct_group3-'    '-acct_group4-'   

                                           .-*---------.   
>--,-+-------------+--,-+-------------+--,-+-----------+-------->
     '-acct_group5-'    '-acct_group6-'    '-acct_type-'   

     .-*-----------.    .-*--------.    .-*-----------.   
>--,-+-------------+--,-+----------+--,-+-------------+--------->
     '-acct_member-'    '-authcode-'    '-change_code-'   

     .-*------------.    .-*-------------.    .-*--------.   
>--,-+--------------+--,-+---------------+--,-+----------+------>
     '-change_group-'    '-change_userid-'    '-language-'   

     .-NO--.    .-ACCT-.    .-*---.                     
>--,-+-----+--,-+------+--,-+-----+--,-+------------+----------->
     '-YES-'    +-BMAP-+    +-IN--+    '-arch_group-'   
                '-*----'    '-OUT-'                     

                                         .-NORMAL---.   
>--,-+-----------+--,-+-------------+--,-+----------+----------->
     '-arch_type-'    '-arch_member-'    +-EXTENDED-+   
                                         '-SUBUNIT--'   

     .-YES-.    .-YES-.                                     
>--,-+-----+--,-+-----+--,-+-------------+--,-+---------+------->
     '-NO--'    '-NO--'    '-report_name-'    '-dd_msgs-'   

>--,-+---------+--,-+-----------+--,-+-------------+-----------><
     '-dd_rept-'    '-dd_tailor-'    '-report_line-'   

Call invocation format

You cannot use call procedures to start this service.

ISPF interface panel

Figure 1. DBUTIL Service panel
   Menu  SCLM  Utilities  Help
 ──────────────────────────────────────────────────────────────────────────────
                    SCLM FLMCMD DBUTIL Service - Entry Panel
                                                                    More:     +
 SCLM Library:
    Project . . . SCLMTEST
    Alternate . .         
    Group . . . . DEV1     . . . TEST     . . . RELEASE 
            . . .          . . .          . . .         
    Type  . . . . SOURCE  
    Member  . . .         

 Selection criteria: (Patterns may be used)
   Authorization code  . . . *            Data type . .    1. Account
   Change code . . . . . . . *                             2. Build map
   Change group  . . . . . . *                             3. Both
   Change user id  . . . . . *       
   Language  . . . . . . . . *            Enter "/" to select option
                                          /  First occurrence only
 Hierarchy search information:
   Architecture Control   3  1. In          Scope    1  1. Normal
 Command ===>                                                                  
  F1=HELP      F2=          F3=END       F4=DATASETS  F5=FIND      F6=CHANGE
  F9=SWAP     F10=LEFT     F11=RIGHT    F12=SUBMIT                              

Parameters

project
The project name. The maximum parameter length is 8 characters.
prj_def
The project definition name to be used for the data extraction. It defaults to the project. The maximum parameter length is 8 characters.
acct_group1 - acct_group6|*
The group containing the members, accounting records, and build maps to be reported on. The maximum parameter length is 18 characters. You can specify up to six individual acct_groups, an asterisk for all, or up to six valid patterns. Only groups from the project definition are reported. The default is all account groups (*).
acct_type|*
The type containing the members, accounting records, and build maps to be reported on. Only types from the project definition are reported. The maximum parameter length is 18 characters. You can specify an individual acct_type, an asterisk for all of them, or a valid pattern. The default is all account types.
acct_member|*
The name of the members' accounting records and build maps on which the report will occur. The maximum parameter length is 18 characters. You can specify an individual acct_member, an asterisk for all of them, or a valid pattern. The default is all account members.
authcode|*
The current authorization code for the member. The maximum parameter length is 18 characters. You can specify an individual authcode, an asterisk for all of them, or a valid pattern. The default is all authorization codes.
change_code|*
A value previously assigned by a user for reference purposes. The maximum parameter length is 18 characters. You can specify an individual change_code, an asterisk for all of them, or a valid pattern. The default is all change codes.
change_group|*
The name of the group in which the member was last updated. The maximum parameter length is 18 characters. You can specify an individual change_group, an asterisk for all of them, or a valid pattern. The default is all change groups.
change_userid|*
The user ID of the person who made the last update to the member. The maximum parameter length is 18 characters. You can specify an individual change_userid, an asterisk for all of them, or a valid pattern. The default is all change_user IDs.
language|*
The language of the member. The maximum parameter length is 18 characters. You can specify an individual language, an asterisk for all of them, or a valid pattern. The default is all languages.
YES|NO
If you specify YES and use more than one group pattern, a precedence system determines which members are selected. If you specify NO, SCLM selects all versions of all members. The maximum parameter length is 24 characters. The default value is YES.
ACCT|BMAP|*
Specify the following type of data to report on:
ACCT
Accounting information
BMAP
Build map information
*
Build map and accounting information.
The maximum parameter length is 24 characters. The default value is ACCT.
IN|OUT|*
Specify the following scopes to select members:
IN
Controlled by the architecture definition
OUT
Not controlled by the architecture definition
*
Without using an architecture definition to identify them.
The maximum parameter length is 24 characters. The default is an asterisk, which indicates that members will be selected without an architecture definition. If you specify either IN or OUT, you must specify arch_group, arch_type, and arch_member.
arch_group
The group used to identify the lowest group in the hierarchy where the architecture begins. The maximum parameter length is 8 characters.
arch_type
The type containing the architecture definition that controls the selected members. The maximum parameter length is 8 characters.
arch_member
The member containing the architecture definition that controls the selected members. The maximum parameter length is 8 characters.
EXTENDED|NORMAL|SUBUNIT
Specify the following architecture scope to select:
NORMAL
Members that do or do not have compilation unit dependencies.
EXTENDED|SUBUNIT
Members that do have compilation unit dependencies.
The maximum parameter length is 24 characters. The default value is NORMAL.
YES|NO
Specify YES to include page header information in the tailored output. In addition to suppressing the page header information, NO positions the data in column 1 of the tailored output. No carriage returns appear in the output. The maximum parameter length is 24 characters. The default value is YES.
YES|NO
Specify YES to sum numeric data fields and to show the sum totals in the tailored output. The maximum parameter length is 24 characters. The default value is YES.
report_name
The title of the report to be written in the tailored output. The maximum parameter length is 35 characters. Commas are not allowed in the report name.
dd_msgs
The ddname indicating the destination of the DBUTIL service messages. If you specify a blank ddname, SCLM routes the DBUTIL service messages to the default output device, such as your terminal. Otherwise, before you call the DBUTIL service, you must allocate the ddname. The following attributes should be used: RECFM=F, LRECL=80, BLKSIZE=80. The maximum parameter length is 8 characters.
dd_rept
The ddname indicating the destination of the report. If you specify a blank ddname, SCLM routes the report to the default output device, such as your terminal. Otherwise, before you call the DBUTIL service, you must allocate the ddname. The following attributes should be used: RECFM=FBA, LRECL=80, BLKSIZE=3120. The maximum parameter length is 8 characters.
dd_tailor
The ddname indicating the destination of the tailored data set. If you specify a blank ddname, SCLM does not generate the tailored output. Otherwise, before you call the DBUTIL service, you must allocate the ddname. The following attributes should be used: RECFM=F, V, FB, or VB; LRECL=80 (minimum); and LRECL=2048 (maximum). If the LRECL value is less than 80, you receive an error message. The report continues to be generated, but it is wrapped using the LRECL value you specify. The maximum parameter length is 8 characters.
report_line
A line of data input that determines the content of the tailored output. Note that you can include commas in the report_line. If you specify all other parameters or if they default correctly, SCLM does not parse the report_line for commas. The maximum parameter length is 160 characters, but the report line will be wrapped if it is more than 80 characters long.

If you use SCLM variables with data lengths greater than 8, keep in mind that their values can exceed 8 characters. Place these variables at the end of the report line to ensure that the columns in the report line up evenly. See SCLM Variables and Metavariables for more information.

Here is the default value for the report_line:

@@FLMMBR  @@FLMLAN @@FLMCML @@FLMNCL @@FLMBLL @@FLMTLS @@FLMCMS @@FLMNCS

Return codes

Additional special services messages are written to the FLMMSGS ddname. See SCLM service messages for more information.

Other return codes might be produced by the FLMCMD processor. See SCLM service return codes for more information.

Possible return codes are:
0
Normal completion. See the SCLM messages for more information.
4
Warning condition. See the SCLM messages for more information.
8
Error condition. See the SCLM messages for more information.
> 8
Severe error condition and SCLM does not produce messages. See Return codes for a description of the return code.

Example of command invocation

FLMCMD DBUTIL,PROJ1,,USER1,,,,,,
*,*,,,,,,N,ACCT,*,,,,,N,N,NAME,,,
UTILTAIL,DELETE,@@FLMPRJ,PROJ1,@@FLMGRP,@@FLMTYP,@@FLMMBR

This service command retrieves accounting information in the USER1 architecture group. SCLM selects all versions of the member without using an architecture definition to identify them. SCLM also selects all accounting types and accounting members that match the pattern.

The dd_tailor parameter, UTILTAIL, indicates the destination of the tailored output called NAME. The report_line parameter passes SCLM variables to produce a cleanup report, which you can use to delete all of the members in a group. The cleanup report does not have header information and does not total numeric data fields.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014