IBM Support

Updates to IMS Tools Base for z/OS V1.6 Policy Services User's Guide and Reference (SC19-4374-04)

Release Notes


Abstract

Updates to IMS Tools Base for z/OS V1.6 Policy Services User's Guide and Reference (SC19-4374-04).

Content

The most recent updates appear at the top of the list.


Update 3

Date of change: February 2021

Change description: Documentation change to support APAR PH29916 (OSAM encryption support for FF DB Sensor).

Topic: Reference: Policy Services > Data elements > Data elements related to database data set space

Description for the DB_MAX_DS_SIZE data element has been updated as follows:

Table. Data elements related to database data set space

Data element name HDAM HIDAM HISAM SHISAM PINDEX SINDEX PHDAM PHIDAM PSINDEX Type Description
...
DB_MAX_DS_SIZE Y Y Y Y - - Y Y - DS
The maximum size of the data set. 4 GB or 8 GB.
For HDAM and HIDAM databases:
  • Start of changeIf the data set is a VSAM linear data set (OSAM LDS) with the extended addressability attribute, the maximum size is 8 GB.End of change
  • If the data set is OSAM and block size is even, the maximum size is 8 GB.
  • Start of changeOtherwise, the maximum size is 4 GB.End of change

For HISAM and SHISAM databases, the maximum size is 4 GB.
For PHDAM and PHIDAM databases:
  • Start of changeIf the data set is a VSAM linear data set (OSAM LDS) with the extended addressability attribute and OSAM8G is specified in the RECON data sets, the maximum size is 8 GB.End of change
  • If the data set is OSAM and OSAM8G is specified in the RECON data sets, the maximum size is 8 GB.
  • Otherwise, the maximum size is 4 GB.
...

Update 2
Date of change: January 2021
Change description: Documentation changes by APAR PH31559. This APAR provides the IMS-managed ACBs support for the Statistics Data Import Utility.
Topics: Changes apply to multiple topics.

============================
Topic: Using Policy Services utilities > Statistics Data Import Utility > Statistics Data Import Utility overview

In figure "Importing sensor data by using the Statistics Data Import Utility," text "DBDLIB" has been changed to "DBDLIB or IMS directory", as follows:

Start of change

Figure illustrating the Statistics Data Import Utility overview

End of change

============================
Topic: Using Policy Services utilities > Statistics Data Import Utility > EXEC and DD statements for the Statistics Data Import Utility

This topic has been updated as follows:

Summary of DD statements

DD statements for the Statistics Data Import Utility determine the input and output data sets and specify how to run the Statistics Data Import Utility.

The following table summarizes the DD statements for the Statistics Data Import Utility.

Table 1. DD statements for the Statistics Data Import Utility

Table 1. DD statements for the Statistics Data Import Utility
DD name Use Format Can be dynamically
allocated?
Required or optional?
STEPLIB Input RECFM=U No Required
IMS Input RECFM=U No Start of changeRequired if the IMSCATHLQ keyword is not specified End of change
BSNSYSIN Input RECFM=FB,LRECL=80 No Required
BSNUJRNL Output RECFM=FBA,LRECL=133 Yes Optional
BSNURPRT Output RECFM=FBA,LRECL=133 Yes Optional


DD statements for input

The following input DD statements are used for the Statistics Data Import Utility.

STEPLIB
Start of changeThis DD statement is required. It specifies the following load module libraries: 

  • The IMS Tools Base library (SHKTLOAD). This library is required.
  • The IMS Tools Base library (SGLXLOAD). This library is required if you specify the IMSCATHLQ keyword.
  • The IMS load module library (SDFSRESL). This library is required if you specify the IMSCATHLQ keyword. End of change

IMS
Start of changeIf you do not specify the IMSCATHLQ keyword, this DD statement is required. It specifies the library that contains the DBD. The DBD name is described in the input CSV data set.

If you specify the IMSCATHLQ keyword, the IMS DD statement is not required; the IMS directory is used instead of the DBD library.  End of change

BSNSYSIN
This DD statement is required. It specifies the input control statement that controls the Statistics Data Import Utility functions.
The BSNSYSIN DD statement can be coded as a standard SYSIN file, a sequential data set, or a PDS member. LRECL=80 is required for the DCB of this data set.

For details about coding the BSNSYSIN DD statement, see Control statements for the Statistics Data Import Utility.

...

============================

Topic: Using Policy Services utilities > Statistics Data Import Utility > Control statements for the Statistics Data Import Utility

A new keyword, IMSCATHLQ, has been added, as follows:

...

Summary of keywords

The following table summarizes the keywords of the control statement for the Statistics Data Import Utility.

Table 1. Keywords for the Statistics Data Import Utility

Keyword Required or optional? Default Description
... ... ... ...
HLQ_HISTORY Required n/a Specifies the data set high level qualifier for the historical sensor data set.
Start of changeIMSCATHLQEnd of change Start of changeOptionalEnd of change Start of changen/aEnd of change Start of changeSpecifies the data set high level qualifier for the bootstrap data set of the IMS directory.End of change
INPUT_FORMAT Optional CSV Specifies the format of the input sensor data to be imported.
... ... ... ...


Description of keywords

The following keywords are available for the control statement.

...

HLQ_HISTORY
This keyword specifies the data set high level qualifier of the historical sensor data set.
HLQ_HISTORY is a required keyword.

Format:

>>--- HLQ_HISTORY( data_set_high_level_qualifier) ------><

data_set_high_level_qualifier
Specify a 1- to 17-character high level qualifier of the output (historical) sensor data set. There is no default.
The Statistics Data Import Utility determines the name of the historical sensor data set by using the high level qualifier specified by the HLQ_HISTORY keyword and the name of the DBD, the partition, or the area to be imported.

Start of changeIMSCATHLQ
This keyword specifies the data set high level qualifier for the bootstrap data set of the IMS directory.
IMSCATHLQ is an optional keyword.

If you specify the IMSCATHLQ keyword, you must enable the IMS catalog and the IMS management of ACBs.

Format:

>>--- IMSCATHLQ( data_set_high_level_qualifier) ----→<

data_set_high_level_qualifier
Specify a 1- to 37-character high level qualifier for the bootstrap data set of the IMS directory. There is no default.
The Statistics Data Import Utility reads database definitions from the IMS directory instead of the DBD library by using IMS Tools Catalog Interface.

If you specify the IMSCATHLQ keyword, you must add the following libraries to the STEPLIB DD statement:

  • The IMS Tools Base library (SGLXLOAD)
  • The IMS load module library (SDFSRESL) End of change

INPUT_FORMAT
This keyword specifies the format of input sensor data.
INPUT_FORMAT is an optional keyword.

...

============================

Topic: Troubleshooting > Runtime error messages (BSN)

Message BSN8017E has been changed as follows:

BSN8017E DBD dbd_name NOT FOUND IN DBDLIB.

Start of changeor

BSN8017E DATABASE DEFINITION database_name NOT FOUND IN THE IMS DIRECTORY. End of change

Explanation
Start of changeIn a situation where the IMSCAHLQ keyword was not specified, the Policy Services utility could not find the DBD member dbd_name in the DBD library.
In a situation where the IMSCAHLQ keyword was specified, the Policy Services utility could not find the database definition of database_name in the IMS directory. End of change

System action
Processing ends with a return code of 8.

User response
Start of changeIf you do not specify the IMSCAHLQ keyword, ensure that the correct DBD library is specified in the IMS DD statement.
If you specify the IMSCATHLQ keyword, ensure that the correct high level qualifier for the bootstrap data set of the IMS directory is specified as the parameter of the IMSCATHLQ keyword. End of change


The following messages have been added:

Start of changeBSN8018E IMS CATALOG API FAILED. FUNC=function, RC=return_code, RSN=reason_code.

Explanation
IMS catalog API ended with an error. function is the function code of the IMS catalog API. Hexadecimal values return_code and reason_code are the return code and the reason code from the IMS catalog API.

System action
Processing ends with a return code of 8.

User response
If the function is OPEN, check whether the correct high level qualifier of the bootstrap data set is specified in the IMSCATHLQ keyword. Otherwise, contact IBM Software Support.

-----------

BSN8025I DATABASE DEFINITION IS RETRIEVED FROM THE [ DBDLIB | IMS DIRECTORY ].

Explanation
This message indicates where the Policy Services utility retrieves database definitions from.

System action
Processing continues.

User response
None. This message is informational.

End of change


Update 1
Date of change: November 2020
Change description: Documentation changes by APAR PH28437. This APAR provides an option to suppress repeated notifications.
Topics: Changes apply to multiple topics.

============================

Topic: Using Policy Services > Managing notification lists and directory entries > Creating directory entries > Creating a USER directory entry

A new option to suppress repeated notifications has been added:

3. Select option 2 - Create directory entry of type USER and press Enter.
The Create Directory Entry panel is displayed.

Figure 3. Create Directory Entry panel

Start of change

  Help
                                                                        
------------------------------------------------------------------------------

REORG/OPERATION       Create Directory Entry                   Row 1 to 3 of 3

                                                                              
Select short and long names. Then select delivery types. Press Enter to commit
the entries. Press End to cancel all entries.                                 
Short name  . . ____________________                                          
Long name . . . ____________________                                          
Description(optional)                                                         
______________________________________________________________________        
Active(A/N/R)   A  Delegate  . . . ____________________  (Optional)           
Delegate delivery type . . . . . . ________  TSO or E-MAIL or TEXTING or WTO  
Suppress repeated notifications    N                                          
                                                                              
Create the delivery types for this directory entry.                           
A: Row Actions:  S - Select          S : Status:  S - Selected                
                                                                              
A S Delivery type                                                             
_   TSO                                                                       
_   E-MAIL                                                                    
_   TEXTING 

End of change

Short name
The unique name that is used in a notification list to identify the directory entry for this user.
...
Delegate delivery type
(Optional) The delivery type for messages sent to the specified delegate: Values are:
  - TSO
  - E-MAIL
  - TEXTING  

Start of changeSuppress repeated notifications
The suppression option for repeated notification messages.
                                                                
Y: Notification message for the same exception is sent only once.
N: Notification message for the same exception is sent each time the exception is detected by policy evaluation. The default is N.  End of change              
Delivery type
The delivery type for messages sent to the user. Values are:
  - TSO
  - E-MAIL
  - TEXTING
4. Specify the USER directory type information and press Enter.
   The TSO, E-MAIL, and TEXTING Delivery Type panels are shown.
...
============================

Topic: Troubleshooting > Runtime error messages (BSN)

The following messages have been added:

--------------------------

Start of change

BSN4029E NOTIFICATION LIST DATA STORE SERVICE FAILED. FUNC=function_code, RC=return_code, RSN=reason_code.
          NOTIFICATION LIST NAME=notification_list_name

Explanation
The policy evaluation process failed to read a notification list from the repository.

The function_code indicates the 4-byte function code of the repository service. The return code and the reason code are hexadecimal values that are returned by the repository read service. The notification_list_name variable indicates the name of the notification list that could not be read. 

System action
The policy evaluation process is rejected, and the return and reason codes that define the failure are returned to the client.

User response
This might be an internal error. Contact IBM Software Support, and notify them of the IMS tool that encountered this problem.

--------------------------
BSN4030E ACCESS TO THE INPUT REPOSITORY FAILED. FUNC=function_code, RC=return_code, RSN=reason_code.
          CALLER=modname, FEEDBACK AREA=fpq_feedback_area
          NAME=member_name

Explanation
The policy evaluation process failed to access the IMS Tools KB input repository.

The function_code indicates the 4-byte function code of the repository service. The return code and the reason code are hexadecimal values that are returned by the repository service. The modname indicates the name of the module that caused the error. The fpq_feedback_area includes IBM diagnostic and debugging information. The member_name indicates the name of the repository member that failed to access.

System action
The policy evaluation process is rejected, and the return and reason codes that define the failure are returned to the client.

User response
This might be an internal error. Contact IBM Software Support, and notify them of the IMS tool that encountered this problem.

--------------------------
BSN4039I DELETED NOTIFIED RESOURCE MEMBER FROM THE REPOSITORY.
          NAME=member_name

Explanation

The policy evaluation process deleted the repository member called notified resource member from the IMS Tools KB input repository. The member_name indicates the repository member name of the deleted notified resource member.

The policy evaluation process deleted a repository member called the notified resource member from the IMS Tools KB input repository. The member_name indicates the name of the repository member that was deleted.

System action
Processing continues.

User response
None. This message is informational.

--------------------------
BSN4620E ACCESS TO THE INPUT REPOSITORY FAILED. FUNC=function_code, RC=return_code, RSN=reason_code.
          CALLER=modname, FEEDBACK AREA=fpq_feedback_area
          NAME=member_name

Explanation
The message notification process failed to access the IMS Tools KB input repository.

The function_code indicates the 4-byte function code of the repository service. The return code and the reason code are hexadecimal values that are returned by the repository service. The modname indicates the name of the module that caused the error. The fpq_feedback_area includes IBM diagnostic and debugging information. The member_name indicates the name of the repository member that failed to access.

System action
The policy evaluation process is rejected, and the return and reason codes that define the failure are returned to the client.

User response
This might be an internal error. Contact IBM Software Support, and notify them of the IMS tool that encountered this problem.

--------------------------
BSN4621I CREATED A NEW NOTIFIED RESOURCE MEMBER.
          NAME=member_name

Explanation
The message notification process created a repository member called the notified resource member in the IMS Tools KB input repository. The member_name indicates the name of the notified resource member that was created.

System action
Processing continues.

User response
None. This message is informational.

--------------------------
BSN4622I FOUND A NOTIFIED RESOURCE MEMBER.
          NAME=member_name

Explanation
The message notification process found a repository member called the notified resource member in the IMS Tools KB input repository. The member_name indicates the name of the notified resource member that was found.

System action
Processing continues.

User response
None. This message is informational.

--------------------------
BSN4623I SUPPRESSED NOTIFICATION FOR DIRECTORY ENTRY directory_entry_name

Explanation
The message notification process suppressed sending notifications to users when exceptions were detected in a database. The directory_entry_name indicates the name of the directory entry for which notifications were suppressed.

System action
Processing continues.

User response
None. This message is informational.

End of change

Publication Number

SC19-4374-04

[{"Line of Business":{"code":"LOB35","label":"Mainframe SW"},"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Product":{"code":"SSS8US","label":"IMS Tools Base for z\/OS"},"ARM Category":[{"code":"a8m0z000000cvYQAAY","label":"IMS Tools Base for z\/OS"}],"ARM Case Number":"","Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"1.6.0"}]

Document Information

Modified date:
08 February 2021

UID

ibm16364939