IBM Support

Updates to IMS High Performance Unload for z/OS V1.2 User's Guide

Product Documentation


Abstract

Updates that apply to IMS High Performance Unload for z/OS V1.2 User's Guide (SC27-0936-08).

Content

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



Update 7
Date of change: February 2018
Change description: Documentation changes by APAR PI91820. This APAR adds support for the Language Environment preinitialization service (CEEPIPI).
Topics: Changes apply to multiple topics.

Topic: Unloading IMS databases > FABHFSU unload utility > FABHFSU input > FABHFSU CARDIN input data set > PSB control statement

Description for column 46 has been added as follows:

The PSB control statement for the standard mode identifies the characteristics of the output data sets to be created. From one to three PSB statements can be used for each execution of FABHFSU.



...
Position Description
1 ...
4-11 ...
...
46 Language environment option
    • L: Indicates that the user exit routine runs in the Language Environment (LE) using the CEEPIPI invocation.
      This option is effective when the user exit routine is written with Enterprise COBOL for z/OS. This option is not effective for user exit routines written in assembler or PL/I language.
      This option is mutually exclusive with the RTEXIT control statement. If you specify this option, the runtime environment exit routine specified for the RTEXIT control statement is not invoked.

Example
The following figure shows an example of the PSB control statement for the FABHFSU program that runs in the ULU region and invokes the user exit routine:
    • 'MYCOBEXT' in columns 24 - 31 is the name of the user exit routine.
    • 'Y' in column 32 activates the segment modification option.
    • 'Y' in column 34 activates the exit routine control option.
    • 'Y' in column 35 activates the DBR skip option.
    • 'L' in column 46 activates the language environment option.
Topic: Unloading IMS databases > FABHFSU unload utility > FABHFSU output: PRNTOUT output data set > FABHFSU Control Specifications report

Item "EXIT LE OPTION" has been added to the following example:

This report contains information about the parameters that were specified on the CARDIN control statements. This report is produced for each output data set that is defined by the PSB control statement in the CARDIN data set.

The following figure shows an example of the report.

Figure. FABHFSU Control Specifications report
(Figure 8 in PDF)


Topic: Unloading IMS databases > Parallel Scan Facility of FABHFSU > FABHPSFC program > FABHPSFC PRNTOUT output data set > FABHFSU PSF Scan Control Data Set report

Item "EXIT LE OPTION" has been added to the following example:

This report contains information about the parameters specified on the CARDIN control statements that were input to the scan control data set. This report is produced for each output data set defined by the PSB control statement in the CARDIN data set.

The following figure shows an example of this report.

Figure. FABHFSU PSF Scan Control Data Set report
(Figure 28 in PDF)


Topic: Unloading IMS databases > Parallel Scan Facility of FABHFSU > FABHPSFS program > FABHPSFS PRNTOUT output data set > FABHFSU PSF Summary report

Item "EXIT LE OPTION" has been added to the following example:

This report provides the summarized statistics for the entire scan. This report is produced for each output data set that is defined by the PSB control statement in the CARDIN data set.

The following figures show an example of the report.
Figure. FABHFSU PSF Summary report (Part 1 of 2)
(Figure 30 in PDF)



...
Topic: Unloading IMS databases > Options for HSSR Engine > RTEXIT control statement

This topic has been updated as follows:

The RTEXIT control statement is used to specify the name of a runtime environment exit routine that can initialize and terminate processing required by the user's environment, such as a COBOL II runtime environment.
The FABHRTEX module is provided as the default runtime environment exit routine, which is a dummy exit routine that returns to HSSR Engine without any processing. If any initialization or termination processing is required by your environment, you can modify this routine or write your own exit routine.

Note: IBM Enterprise COBOL Version 5 or later does not support the IGZERRE interface for the runtime environment setup. If the interface is used in your runtime environment exit routine, remove the RTEXIT control statement. Instead, specify a language environment option to invoke CEEPIPI provided by Language Environment not only for initialization and termination calls but also for each segment call of your user exit routine for unload utilities. For more information, see "EXIT control statement" for FABHURG1 or "PSB control statement" for FABHFSU.

The runtime environment exit routine is called before and after an HSSR application program is invoked. If no RTEXIT control statement is specified, the IBM-supplied FABHRTEX module or the user-written FABHRTEX module is called as the runtime environment exit routine. For more information about FABHRTEX, see Runtime Environment exit (FABHRTEX).
...
Topic: Tuning and customizing HSSR application jobs > System programming interfaces > Runtime Environment exit (FABHRTEX)

This topic has been updated as follows:

With IMS High Performance Unload, you can develop a runtime environment exit routine, named FABHRTEX, which enables you to do your own initialization and termination processing for your application programs or your exit routines for unload utilities.

The runtime environment exit routine is called during the initialization of the IMS High Performance Unload program controller before the application program is called; the routine is called once more after, control is returned from the application program to the program controller.

Notes:
    • For details of system structure, see "IMS High Performance Unload system structure".
    • The runtime environment exit is not invoked when the language environment option is specified on the EXIT control statement of the FABHURG1 unload utility or the PSB control statement of the FABHFSU unload utility.

You can use an exit routine that has a different name, by specifying the RTEXIT control card in the HSSROPT data set. Use this control statement if you need to set up a special runtime environment for a special application or for an exit routine for FABHURG1 or FABHFSU.
...
Topic: Tuning and customizing HSSR application jobs > System programming interfaces > User record-formatting routine > Special-purpose SYSIN control statements for user exits > EXIT control statement

Description for column 17 has been added as follows:

This optional control statement specifies the name of the optional user exit routine.



Position Description
1 ...
6 ...
...
17 Language environment option
  • L 
    • Indicates that the user exit routine runs in the Language Environment (LE) using the CEEPIPI invocation.
      This option is effective when the user exit routine is written with Enterprise COBOL for z/OS. This option is not effective for user exit routines written in assembler language.
      This option is mutually exclusive with the RTEXIT control statement. If you specify this option, the runtime environment exit routine specified for the RTEXIT control statement is not invoked.
Topic: Troubleshooting > Messages and codes > Messages > FABH messages

The following new messages have been added:

FABH0287E LOAD FAILED FOR MODULE: module

Explanation: Load failed for the indicated module.
System action: Program FABHURG1 or FABHFSU ends abnormally.
User response: Check the contents of the load module library. Correct the error and rerun the job.

---

FABH0289E CEEPIPI ERROR OCCURRED. FUNC=function, RC=return_code

Explanation: IMS HP Unload invoked the Language Environment CEEPIPI service, but the CEEPIPI service returned a non-zero return code.
System action: IMS HP Unload ends abnormally.
User response: When function shows INIT, the function of CEEPIPI is init_sub or identify_entry. When function shows CALLSUB, the function of CEEPIPI is call_sub. For the return codes, see the topic about preinitialization services in the Language Environment Programming Guide (SA22-7561).
Correct the error and rerun the job.

---

FABH0296E LE OPTION IS NOT ALLOWED WHEN THE RUN TIME ENVIRONMENT EXIT ROUTINE IS BEING INVOKED

Explanation: If the RTEXIT control statement is specified for a user runtime environment exit routine, the language environment option cannot be specified to activate the Language Environment.
System action: IMS HP Unload ends abnormally.
User response: Remove the RTEXIT control statement and rerun the job.


Update 6
Date of change: December 2017
Change description: Documentation changes by APAR PI89050. This APAR enables IMS HP Unload to offload processing to System z Integrated Information Processor (zIIP).
Topics: Changes apply to multiple topics.

 

 

Topic: Unloading IMS databases > Options for HSSR Engine > Overview of HSSROPT control statements

ZIIPMODE keyword has been added to the following table:

Summary of HSSROPT control statements

Table. List of HSSROPT control statements for HSSR Engine
(Table 28 in PDF)
Used for
Keyword
Function
Description
... ... ... ...
Others HPIO ... ...
RTEXIT ... ...
ZIIPMODE Specifies whether to offload eligible workloads to zIIP processors. See ZIIPMODE control statement.
Topic: Unloading IMS databases > Options for HSSR Engine

The following new topic has been added:

ZIIPMODE control statement

The ZIIPMODE control statement specifies whether HSSR engine offloads eligible VSAM ESDS I/O workloads to zIIP processors.

Position
  • Description
1
  • Code the ZIIPMODE keyword.
10
  • Specify one of the following keywords:
    NEVER
      • Does not offload any workload to zIIP processors. NEVER is the default to avoid unexpected performance degradation.
    COND
      • Offloads VSAM ESDS I/O workloads to zIIP processors when all of the following conditions are met:
        • zIIP processor are available.
        • The SGLXLOAD library of Tools Base is specified to the STEPLIB or JOBLIB.
        • VSAM ESDS is to be read using Media Manager. For details, see "HPIO control statement"
        If any of these conditions is not satisfied, the job runs using the main CPs.
Topic: Tuning and customizing HSSR application jobs > Site default options > How the runtime parameters are determined

ZIIPMODE keyword has been added to the following table:

Runtime parameters that can be replaced

Defaults for options listed in the following table can be specified by replacing the default option table.
Table. Options for which default values can be specified
(Table 46 in PDF)
Function
Keyword
Description
Related data set
... ... ... ...
HSSR Engine options CABSTAT CAB statistics report option HSSROPT
... ... ...
PCBLIST Type of PCB list HSSROPT
ZIIPMODE Specifies whether to offload eligible workloads to zIIP processors. HSSROPT
Buffer handlers BUFDEFAULT ... ...
Topic: Tuning and customizing HSSR application jobs > Site default options > FABHTOPT macro statements

This topic has been updated as follows:

The rules for coding the FABHTOPT macro are the same as those for coding macro statements in Assembler language.
FABHTOPT must be preceded and followed by at least one blank space, and parameters must be separated by commas.



COMPAT=
  • This optional keyword specifies the basic setting of FABHTOPT. IMS™ High Performance Unload provides three basic settings: HPU, DBT, and 5787LAC. The default basic setting is HPU. The following table shows the options to be set by the three basic settings:
    Table. Basic settings of FABHTOPT options
    (Table 47 in PDF)
    Keyword
    COMPAT=HPU
    COMPAT=DBT
    COMPAT=5787LAC
    ... ... ... ...
    PCBLIST= HSSR HSSR HSSR
    ZIIPMODE= NEVER NEVER NEVER
    Note: The number is determined from the block size of the output data set by each unload
    utility.
    ...
...
PCBLIST=
  • This optional keyword specifies the type of PCB list that is passed to the application program.
ZIIPMODE=
  • This optional keyword specifies the default for the ZIIPMODE option in HSSROPT.
Topic: Troubleshooting > Messages and codes > Messages > FABH messages

The following new messages have been added:

FABH0645I ZIIP TIME (HH:MM:SS.THMIJU) WAS: hh:mm:ss.thmiju

Explanation: This informational message shows the CPU time consumed by zIIP processors for the IMS HP Unload job.
System action: Processing continues.
User response: None. This message is informational.

---

FABH0646E ERROR RETURNED FROM GEXAPI00: FUNC=xxxxxxx, SERVICE CODE=xxxx, RC=xxxx, RSN=xxxx

Explanation: HSSR Engine called the GEXAPI00 module, but an error return code was returned from GEXAPI00.
System action: If ZIIPMODE=FORCE is specified, HSSR Engine ends abnormally. If ZIIPMODE=COND is specified and the error occurred during initialization (FUNC=INIT), processing continues.
User response: Search for GEX error messages to identify the cause. If the cause is not clear, collect the dump and contact IBM Software Support.

---

FABH0698E INCORRECT ZIIPMODE CONTROL STATEMENT IS SPECIFIED

Explanation: An incorrect operand on the ZIIPMODE control statement is specified in the HSSROPT data set.
System action: The incorrect statement is ignored.
User response: Correct the ZIIPMODE statement.

---

FABH0856E LOAD FAILED FOR GEXAPI00

Explanation: A LOAD error occurred when HSSR Engine tried to load the GEXAPI00 module.
System action: If ZIIPMODE=FORCE is specified, HSSR Engine ends abnormally. If ZIIPMODE=COND is specified, processing continues.
User response: Ensure that GEXAPI00 module exists and is available in the SGLXLOAD library of Tools Base. If it is not available, make it available and rerun the job.

---

FABH2017E INCORRECT ZIIPMODE= PARAMETER IS SPECIFIED

Explanation: The value specified for the ZIIPMODE keyword parameter is incorrect.
System action: The assembly of the option table ends with return code 8. The option table is not replaced.
User response: See "ZIIPMODE control statement" and correct the value on the ZIIPMODE keyword.

 

 

 



Update 5
Date of change: September 2017
Change description: Documentation changes by APAR PI83671. This APAR enables IMS HP Unload to use database definitions in the IMS catalog instead of DBD libraries when IMS-managed ACBs is enabled.
Topics: Changes apply to multiple topics.

 

 

 

Topic: IMS High Performance Unload overview > Introduction to IMS High Performance Unload > IMS High Performance Unload system structure

"IMS DD" has been changed to "IMS DD or IMS catalog directory" in the following figure:

Figure. System structure and data flow
(Figure 1 in PDF)


Topic: Unloading IMS database > Introduction to the unload utilities > Considerations for using the unload utilities

The following new topic has been added:

Considerations for IMS-managed ACBs environment

When the IMS management of ACBs is enabled, IMS reads database descriptors (DBDs) from the IMS catalog instead of from the DBD library that is specified in the IMS DD statement.

Refer to the following JCL examples when you prepare IMS HP Unload JCL to run an unload job in an IMS-managed ACBs environment. For more information about coding IMS HP Unload JCL, see "Basic job control language".

Example 1: Specifying the DFSDF= parameter and DBRC=Y


DFSDF=CAT parameter is specified on the EXEC statement. This parameter specifies the DFSDFCAT member that enables IMS-managed ACBs. The name of the IMS.PROCLIB data set in which the DFSDFCAT member exists is specified on the PROCLIB DD statement.

You must allocate the catalog partition definition data set when unloading a database with DBRC=NO. To do so, add the DFSHDBSC DD statement or the DFSMDA member with the TYPE=CATDBDEF statement.

Example 2: Using the IMS Catalog Definition exit routine


The DFS3CDX0 exit routine must be bound into IMS.SDFSRESL or a concatenated library.

You must allocate the catalog partition definition data set when unloading a database with DBRC=NO. To do so, add the DFSHDBSC DD statement or the DFSMDA member with the TYPE=CATDBDEF statement.
Topic: Unloading IMS databases > Basic job control language > Preparing the basic JCL

Step 3 has been added as follows:

1...
2...
3. If any of the following conditions apply, follow the instructions in these topics:
    • "Considerations for a logical parent's concatenated key"
    • "Considerations for an unloaded data set used for reorganization"
    • "Considerations for database sharing"
    • "Considerations for HALDB Online Reorganization capable partitions"
    • "Considerations for using a secondary index"
    • "Considerations for unloading an IMS catalog"
    • "Considerations for IMS-managed ACBs environment"
Topic: Unloading IMS databases > Parallel Scan Facility of FABHFSU > Overview of Parallel Scan Facility

The restrictions section has been updated as follows:

Restrictions

The restrictions that apply to FABHFSU in standard mode also apply to FABHFSU in PSF mode. For those restrictions, see "Restrictions for IMS High Performance Unload".

Additionally, the following restrictions apply to PSF mode:
    • FABHFSU does not support the unloading of an HISAM database under PSF mode.
    • PSF mode does not support IMS-managed ACBs.
Topic: Troubleshooting > Messages and codes > Messages > FABH messages

The following new messages have been added:

FABH0639E IMS TOOLS CATALOG INTERFACE ERROR: FUNCTION=func RC=rc RSN=rsn

Explanation: HSSR Engine received an error return code from IMS Tools Catalog Interface.
System action: HSSR Engine ends abnormally.
User response: Contact IBM Software Support.

---

FABH0640E DBD=dbdname IS NOT FOUND IN THE IMS DIRECTORY DATA SETS

Explanation: HSSR Engine could not find the indicated DBD in the IMS directory data sets.
System action: HSSR Engine ends abnormally.
User response: Ensure that the correct DBD name is specified on the EXEC statement and rerun the job.

 

 

 



Update 4
Date of change: April 2017
Change description: Documentation changes by APAR PI77214. This APAR adds new control statement CABBASE, which specifies the basic size of I/O buffers that the CAB buffer handler allocates.
Topics: Changes apply to multiple topics.

 

 

 

Topic: Unloading IMS databases > Options for HSSR Engine

The following new topic has been added:

CABBASE control statement

This optional control statement specifies, in number of tracks, the basic size of I/O buffers that the CAB buffer handler allocates.

The RANSIZE and NBRDBUF values are determined from the CABBASE control statement value and the CI/block size of the database data set. If the RANSIZE control statement or the NBRDBUF control statement is specified in the HSSRCABP data set, the RANSIZE control statement value or the NBRDBUF control statement value has precedence over the CABBASE control statement value.



Position
  • Description
1
  • Code the CABBASE keyword.
9
  • Code a numeric value for trk. The value must be a left-aligned decimal number in the range of 1 - 255.
    For VSAM sequential buffering, the value must be in the range of 1 - 15.
13
  • ALL
      • Indicates that this statement applies to all ESDS or OSAM data sets.
        ALL is the default.
    VSAM
      • Indicates that this statement applies to all ESDS data sets.
    OSAM
      • Indicates that this statement applies to all OSAM data sets.
18
  • ALL
      • Indicates that this statement applies to both sequential buffering and direct buffering.
        ALL is the default.
    SEQ
      • Indicates that this statement applies to sequential buffering.
    DIR
      • Indicates that this statement applies to direct buffering.

The default value is determined based on the access method as follows:
    • For OSAM sequential buffering: 1 track (CABBASE 1 OSAM SEQ)
    • For OSAM direct buffering: 2 tracks (CABBASE 2 OSAM SEQ)
    • For VSAM sequential buffering: 8 tracks (CABBASE 8 VSAM SEQ)
    • For VSAM direct buffering: 15 tracks (CABBASE 15 VSAM DIR)

If the VSAM CI size is smaller than 2 KB, the CAB buffer handler applies the following values:
    • For sequential buffering: 4 tracks (CABBASE 4 VSAM SEQ)
    • For direct buffering: 8 tracks (CABBASE 8 VSAM DIR)

Tips:
    • The following statement is recommended to improve the performance of CAB sequential I/O buffering for OSAM data sets. This statement changes the basic size of OSAM sequential buffers from one track to eight tracks: CABBASE 8 OSAM SEQ
    • The default of this control statement can be changed by replacing the default option table (FABHOPT). For details, see "Site default options".
Topic: Tuning and customizing HSSR application jobs > Site default options > How the runtime parameters are determined

CABBASE_xx keywords have been added to the table as follows:

Table. Options for which default values can be specified
(Table 46 in PDF)
Function Keyword Description Related data set
HSSR Engine options CABBASE_OS CABBASE option for OSAM sequential buffering HSSROPT
CABBASE_OD CABBASE option for OSAM direct buffering HSSROPT
CABBASE_VS CABBASE option for ESDS sequential buffering HSSROPT
CABBASE_VD CABBASE option for ESDS direct buffering HSSROPT
Topic: Tuning and customizing HSSR application jobs > Site default options > FABHTOPT macro statements

CABBASE_xx keywords have been added as follows:



COMPAT=
  • ...
    Table. Basic settings of FABHTOPT options
    (Table 47 in PDF)
    Keyword COMPAT=HPU COMPAT=DBT COMPAT=5787LAC
    CABBASE_OS= 1 1 1
    CABBASE_OD= 2 2 2
    CABBASE_VS= defnum
    (see Note 2)
    defnum
    (see Note 2)
    defnum
    (see Note 2)
    CABBASE_VD= defnum
    (see Note 2)
    defnum
    (see Note 2)
    defnum
    (see Note 2)
    Notes:
    • 1. The number is determined from the block size of the output data set by each unload utility.
      2. The number is determined from the CI size of the database data set.



  •  
You can use the following keywords to override the values set by the basic settings:
...

CABBASE_OS=
  • This optional keyword specifies the default for the 'CABBASE nnn OSAM SEQ' option in HSSROPT.
CABBASE_OD=
  • This optional keyword specifies the default for the 'CABBASE nnn OSAM DIR' option in HSSROPT.
CABBASE_VS=
  • This optional keyword specifies the default for the 'CABBASE nnn VSAM SEQ' option in HSSROPT.
CABBASE_VD=
  • This optional keyword specifies the default for the 'CABBASE nnn VSAM DIR' option in HSSROPT.

...
Topic: Troubleshooting > Messages and codes > Messages > FABH messages

Message FABH0056W has been updated as follows:

FABH0056W NUMBER OF BUFFERS IN A SEQ_BUF xxx CHANGE TO yyy

Explanation: The number (xxx) of CIs to be read by one sequential read for the data set identified by ddname is too large. The number xxx is the one that was specified by the RANSIZE control statement or the CABBASE control statement. The ESDS cannot chain CCWs for that number of CIs in a single start I/O. The maximum number of CIs (yyy) that can be read depends on the CI size and is displayed in the message.
System action: The processing continues with the maximum number (yyy) of CIs.
User response: Specify the value yyy indicated in the message for RANSIZE.


The following two messages have been added:

FABH0697E INCORRECT CABBASE CONTROL STATEMENT IS SPECIFIED

Explanation: An incorrect operand on the CABBASE control statement is specified in the HSSROPT data set.
System action: The incorrect statement is ignored.
User response: Correct the CABBASE statement.

---

FABH2016E INCORRECT CABBASE_xx= PARAMETER IS SPECIFIED

Explanation: The value specified for the CABBASE_xx= keyword parameter is incorrect. It must be in the range of 1 - 255.
System action: The assembly of the option table ends with return code 8. The option table is not replaced.
User response: Correct the error.

 

 

 



Update 3
Date of change: May 2016
Change description: Documentation changes by APAR PI60116. This APAR fixes DBRC database authorization issues of HSSR Engine.
Topics: Changes apply to multiple topics.

 

 

Topic: Unloading IMS databases > Introduction to the unload utilities > Restrictions for IMS High Performance Unload

A new item has been added to the list as follows:

Restrictions common to all HSSR applications
The following restrictions apply to all HSSR application programs including the FABHURG1 utility and the FABHFSU utility:
  • Logical DBD is not supported.
  • A sensitive virtual logical child (LCHILD) is not supported.
  • Field sensitivity for an HSSR PCB is not supported.
  • For the restrictions of DBRC authorization for database access, see "Support of database level sharing".
  • ...
Topic: Unloading IMS databases > Application programming interface for using HSSR Engine > Consideration for database sharing

A new paragraph has been added as follows:

Support of database level sharing

IMS High Performance Unload provides the same support for database level sharing as IMS. This support requires that DBRC be installed and active, and that the database be registered in the DBRC RECON data sets.

Application program running in DLI or DBB region

For an HSSR application program running in DLI or DBB region, DBRC authorizes database access to the job step under the same conditions as a normal IMS batch job step.

Authorization for the database access depends on the following:
  • The database processing intent as specified through PROCOPT during PSBGEN
  • The database-sharing level defined in the RECON data sets
  • The current status indicators of the database, as recorded in the RECON data sets

You have the following options during PSBGEN:
  • You can specify a read processing intent (PROCOPT=G) in order to have read integrity. DBRC then prevents concurrent execution of the HSSR application program with an IMS subsystem that updates the database.
  • You may specify a read-only processing intent (PROCOPT=GO) to be able to run your application program concurrently to other IMS subsystems that update the database. In this case, no read integrity is provided.
You can also specify an exclusive processing intent (PROCOPT=GE) in order to have exclusive usage of the database.

Restriction: If two or more database PCBs (DBPCBs) are defined in the PSB and the IMSDALIB DD statement specifies the library of DFSMDA members for dynamic allocation of the database data sets, HSSR Engine does not send the DBRC authorization request for database access. If two or more DBPCBs are defined in the PSB, you must concatenate the library of DFSMDA members to the STEPLIB DD statement.
Topic: Troubleshooting > Messages and codes > Messages > FABH messages

The following new message has been added:

FABH0670W DB-ACCESS NOT AUTHORIZED BY DBRC: DB=dbdname

Explanation: The DBRC authorization request for database access was not sent. When two or more database PCBs (DBPCBs) are defined in the PSB and the library of DFSMDA members for dynamic allocation of the database data sets is specified on the IMSDALIB DD statement, HSSR Engine does not send the DBRC authorization request.
System action: HSSR Engine continues processing without obtaining DBRC authorization.
User response: Specify the library of DFSMDA members on the STEPLIB DD statement.

 

 



Update 2
Date of change: April 2016
Change description: Documentation change by APAR PI59811. A new message has been added.

 

 

 

Topic: Troubleshooting > Messages and codes > Messages > FABH messages


FABH0855E COMPRESSION EXIT ROUTINE nnnnnnnn INITIALIZATION ERROR - Uaaaa REASON rrrrrrrr


Explanation: An initialization error was detected by a Segment Edit/Compression exit routine. In the message text:

nnnnnnnn


  • Name of the exit routine.

Uaaaa

  • The IMS user abend code generated by the exit routine.

rrrrrrrr

  • The unique label at which the error was detected. This label corresponds to the error reason code. Find the meaning of the reason code in the user's guide of the Segment Edit/Compression exit routine or contact the supplier of the Segment Edit/Compression exit routine.

System action: HSSR Engine ends abnormally.

User response: Determine the cause of the error and correct the problem.

 

 

 



Update 1
Date of change: January 2016
Change description: Documentation changes by APAR PI51721. This APAR adds a new control statement, COMPAUTH, which specifies to call the segment compression exit in supervisor state. 
Topics: Changes apply to multiple topics.

 

 

 

 

 

Topic: Unloading IMS databases > Options for HSSR Engine

The following new control statement has been added:

COMPAUTH control statement

The COMPAUTH control statement specifies whether to call the segment compression exit in supervisor state.

If you also specify the DECN control statement, this control statement is ignored because HSSR Engine does not call the segment compression exit.

If you use an encryption exit of InfoSphere Guardium Data Encryption for DB2 and IMS Databases as the segment compression exit, specifying COMPAUTH YES reduces performance degradation.
 
 
 Position  Description
 1
  • Code the COMPAUTH keyword.
 10
  • Specify one of the following keywords:
    YES
      • Specifies to call the segment compression exit in supervisor state.
    NO
      • Specifies to call the segment compression exit in problem state. NO is the default.
 
To enable COMPAUTH YES, the following conditions must be met:
  • · All of the STEPLIB libraries are APF-authorized.
    · The first load module is link-edited with an authorization code of AC=1. This is the same as how FABHX034 load module is link-edited.
 
Tip: The default of this control statement can be changed by replacing the default option table (FABHOPT). Specify the COMPAUTH=YES parameter on the FABHTOPT macro statement. For details, see Site default options.
Topic: Unloading IMS databases > FABHURG1 unload utility > IMS HD Reorganization Unload JCL for running FABHURG1

The following item has been added to the list of restrictions:

Restrictions
  • · ... 
    · The following control statements are ignored:
      • l COMPAUTH YES in the HSSROPT data set
        l HPIO YES in the HSSROPT data set
 
Topic: Tuning and customizing HSSR application jobs > Site default options > How the runtime parameters are determined

COMPAUTH keyword has been added to the following table:

Table. Options for which default values can be specified
(Table 46 in PDF)
Function Keyword Description Related data set
... ... ... ...
HSSR Engine options CABSTAT ... ...
COMPAUTH State option for segment compression exit call HSSROPT
LSR ... ...
... ... ...
... ... ... ...

 
Topic: Tuning and customizing HSSR application jobs > Site default options > FABHTOPT macro statements

COMPAUTH keyword has been added as follows:


Table. Basic settings of FABHTOPT options
(Table 47 in PDF)
Keyword COMPAT=HPU COMPAT=DBT COMPAT=5787LAC
COMPAUTH= NO NO NO

You can use the following keywords to override the values set by the basic settings:
...

COMPAUTH=
  • This optional keyword specifies the default for the COMPAUTH option in HSSROPT.
Topic: Troubleshooting > Messages and codes > Messages > FABH messages

The following new messages have been added:

FABH0660W COMPAUTH YES IS IGNORED IN UNAUTHORIZED PROGRAM
 
Explanation: Although one or more segments are compressed, the COMPAUTH YES option in the HSSROPT data set is ignored because of one of the following reasons:
  • · One or more STEPLIB libraries are not APF-authorized. 
    · Authorization code 1 (AC=1) is not assigned to the first module. This condition occurs when, for example, EXEC PGM=DFSRRC00 is specified in the JCL.
System action: HSSR Engine ignores the COMPAUTH YES option and continues processing with the COMPAUTH NO option.
User response: To apply the COMPAUTH YES option, APF-authorize all the STEPLIB libraries and specify the program name of FABHX034 on the PGM parameter of the EXEC statement.

-----

FABH0676E INCORRECT COMPAUTH CONTROL STATEMENT IS SPECIFIED
 
Explanation: In the HSSROPT data set, an incorrect operand is specified for the COMPAUTH control statement. The operand must be YES or NO.
System action: HSSR Engine ignores the COMPAUTH control statement and continues processing.
User response: Correct the COMPAUTH control statement.

-----

FABH2015E INCORRECT COMPAUTH= PARAMETER IS SPECIFIED

Explanation: The value specified for the COMPAUTH keyword is incorrect. It must be YES or NO.
System action: The assembly of the option table ends with return code 8. The option table is not replaced.
User response:  Correct the value of the COMPAUTH keyword.

-----
The user response section of the following message has been updated as follows:

FABH0581E OPEN OF DBD=dbdname DDN=ddname
        • --- "yyyy" "text"

Explanation: ...
System action: ...
User response: The following list provides the subtext (yyyy and text), explanation, and the user response for each  subtext:
...
  • ...
"KSDS" "MODCB RPL, RECLEN...... FAILED"
  • ...
 "KSDS" "EXTENDED ADDRESSABILITY IS NOT SUPPORTED"
  • The KSDS is an SMS data set with the extended addressability attribute. IMS does not support such a data set.
 

Publication Number

SC27-0936-08

Copyright Date

2000, 2015

Original Publication Date

2016-01-14


Cross reference information
Product Component Platform Version Edition
IMS Tools IMS Database Solution Pack z/OS 2.1.0, 2.2.0
IMS Tools IMS Database Utility Solution z/OS 1.1.0, 2.1.0

Document information

More support for: IMS Tools

Component: IMS Database Solution Pack, IMS Database Utility Solution, IMS HP Unload

Software version: 1.1.0, 1.2.0, 2.1.0, 2.2.0

Operating system(s): z/OS

Reference #: 7047424

Modified date: 26 July 2018