Basic UNLOAD PLUS installation options

The following table describes the basic UNLOAD PLUS installation options:

This topic describes each of the options.

For more information about setting the values of some of these options at runtime, see Command-and-syntax-reference. For more information about performance implications of these options, see Tuning-UNLOAD-PLUS-jobs. 

ANALYZE=(DB2STATS, NOLIMIT)

The ANALYZE option specifies whether UNLOAD PLUS uses statistics to estimate the number of rows for a specific table or partition to calculate space requirements for data sets during dynamic allocation. This option can direct UNLOAD PLUS to use a specific type and age for the statistics that it uses during the analysis.

Specify the first operand if you want UNLOAD PLUS to estimate the number of rows for a specific table and page set by using one of the following values:

• DB2STATS, to obtain information from the Db2 catalog statistics

• HURBA (high-used RBA) from the Db2 table space

  HURBA disables the statistics and uses the sizing information from the VSAM table space definitions. For details about the HURBA formula, see ANALYZE.

To specify the age of the statistics, you can specify one of the following values for the second operand:

• NOLIMIT, which tells UNLOAD PLUS to use the catalog information regardless of the age of the statistics
• A specific limit in number of days (an integer value)

Considerations

The following considerations apply to the ANALYZE option:

• If you are using DIRECT NO or INFILE processing, UNLOAD PLUS bypasses ANALYZE processing.
• If you are unloading LOB or XML data, UNLOAD PLUS ignores this option for any referenced files that it allocates.

Overriding this option

You can override the value for this option by using the ANALYZE command option (ANALYZE). 

CENTURY=(1950,2049)

The CENTURY option specifies the 100-year range that determines the century for the DATE and TIMESTAMP external formats that contain two-digit year values. The value for this option is two four-digit years in the format (ccyy,ccyy). The first four-digit year value must be less than the second four-digit year. You must specify both values, and these values must span 100 years.

Any two-digit year between the first yy specification and 99 uses the first cc value as a prefix to create a four-digit year. Any two-digit year between 00 and the second yy specification uses the second cc value as a prefix to create a four-digit year.

For example, if you specify CENTURY(1950,2049), UNLOAD PLUS places 19 in front of each two-digit year with a value 50 through 99, and places 20 in front of each two-digit year with a value 00 through 49. The date 99/12/31 becomes 1999/12/31 and 00/12/31 becomes 2000/12/31.

Overriding this option

You can override the value for this option by using the CENTURY command option (see CENTURY) or the CENTURY field specification option (see DATE or TIMESTAMP). 

CHANGE_CONSISTENT=NO

The CHANGE_CONSISTENT option specifies whether UNLOAD PLUS should attempt to maintain consistency with a point-in-time image of the data when using SHRLEVEL CHANGE. UNLOAD PLUS ignores the CHANGE_CONSISTENT option if you specify the SHRLEVEL REFERENCE command option or SHRLEVEL=REFERENCE installation option.

To maintain consistency with a point-in-time image of the data while enabling read/write access to the data, specify YES. UNLOAD PLUS provides this capability by using XBM or SUF to produce a snapshot image of the data in a table space. UNLOAD PLUS briefly restricts access to the object when externalizing pages. For more information, see Running-SHRLEVEL-CHANGE-CONSISTENT-YES.

Specify NO if you do not need to maintain consistency with a point-in-time image of the data when using SHRLEVEL CHANGE. When you specify NO, UNLOAD PLUS does not restrict access to the object except for the brief time required to externalize pages if you specify CHANGE_QUIESCE=YES. For more information about specifying NO, see the CHANGE_QUIESCE option.

Overriding this option

You can override the value for this option by using the CONSISTENT option of the SHRLEVEL CHANGE command option. See SHRLEVEL for more information. 

CHANGE_QUIESCE=NO

The CHANGE_QUIESCE option specifies whether UNLOAD PLUS should externalize pages for table spaces that are being unloaded using SHRLEVEL CHANGE CONSISTENT NO. To externalize these pages for table spaces, specify CHANGE_QUIESCE=YES. Specify CHANGE_QUIESCE=NO if you do not want to restrict access to the objects to externalize pages from the Db2 buffer pool.

UNLOAD PLUS ignores this option when SHRLEVEL REFERENCE or SHRLEVEL CHANGE CONSISTENT YES is in effect.

Overriding this option

You can override the value for this option by using the CONSISTENT NO QUIESCE option of the SHRLEVEL CHANGE command option. For more information, see SHRLEVEL . 

CMAX=16

The CMAX option specifies the maximum number of tasks that UNLOAD PLUS can execute concurrently when you specify Db2 dynamic SQL. A value of 16 for this option allows UNLOAD PLUS to run in optimized mode.

Overriding this option

You can override the value for this option by using the MAXCONNECT command option (MAXCONNECT). 

CMRATIO=50

The CMRATIO option specifies a percentage value that UNLOAD PLUS uses as a compression ratio to calculate the estimated number of rows for a table space when any of the following conditions exists:

• When ANALYZE HURBA is specified
• As a default because there are no Db2 statistics
• When the statistics are out of date

The value (1 through 100) that you specify for this option represents the percentage value to use. For example, if a page normally holds 10 rows in an uncompressed state, specifying a compression ratio of 50 indicates that these 10 rows occupy only 50% of the page so that the number of rows that fit in the page is now 20.

Overriding this option

You can override the value for this option or specify it at runtime by using the CMRATIO keyword of the ANALYZE command option (ANALYZE). 

CONSTRULES=BMC

The CONSTRULES option specifies the way that UNLOAD PLUS handles character constants in the SELECT list:

• Specify BMC if UNLOAD PLUS should treat character constants in the SELECT list according to the value of the DIRECT keyword. If you specify DIRECT YES, UNLOAD PLUS treats character constants as a character data type of fixed length. If you specify DIRECT NO, UNLOAD PLUS treats character constants as a character data type of variable length.
• Specify STANDARD for this option if UNLOAD PLUS should treat all character constants in the SELECT list as a character data type of variable length for both DIRECT YES and DIRECT NO. UNLOAD PLUS always uses STANDARD when you specify FORMAT DSNTIAUL. 

CURRENTDEGREE=NONE

The CURRENTDEGREE option specifies that UNLOAD PLUS can issue the SET CURRENT DEGREE command before executing dynamically executed SELECT statements. You can specify CURRENTDEGREE ANY or CURRENTDEGREE 1 to issue the command, or specify NONE if you do not want UNLOAD PLUS to issue it. With NONE, Db2 uses the system default value to unload the data.

UNLOAD PLUS ignores the CURRENTDEGREE option if DIRECT YES is in effect.

Overriding this option

You can override the value for this option by using the CURRENTDEGREE command option (CURRENTDEGREE).

DELFILES=YES

The DELFILES option tells UNLOAD PLUS whether to delete the SYSREC, SYSRED, SORTWK, and referenced files when the unload is unsuccessful. (For more information, see ON-FAILURE.)

You can specify one of the following options:

• A value of YES tells UNLOAD PLUS to delete the following data sets when the unload job fails to complete successfully:
  • All data sets whose ddnames match the SYSREC, SYSRED, and SORTWK ddnames or prefixes
  • All referenced file data sets
• A value of NO tells UNLOAD PLUS not to delete any of these files.

Additional considerations

Note the following considerations when you specify YES:

• UNLOAD PLUS does not delete files when the job terminates with an x22 abend.
• UNLOAD PLUS does not delete the following files:
  • If DIRECT NO is in effect, any referenced files
  • Any HFS referenced files
  • Any files that are defined with an abnormal allocation disposition other than DELETE
  • Any files that are defined with an expiration date or retention period that prevents the delete from being honored
• To specify the final disposition of tape files when you specify DELFILES=YES, see the TAPEDISP installation option.

Running in a worklist environment

If you are running the unload job in a worklist environment, UNLOAD PLUS functions differently. In this environment, UNLOAD PLUS ignores the value you set for the DELFILES installation option and, by default, does not delete the files. UNLOAD PLUS functions this way so that the files exist for subsequent executions in the worklist. If you specify DELETEFILES YES on the UNLOAD command in the worklist, UNLOAD PLUS deletes only the dynamically allocated SYSREC, SYSRED, or referenced file data sets.

Overriding this option

You can override the value for this option by using the DELETEFILES command option (DELETEFILES). 

DRNDELAY=1

After a drain times out, the DRNDELAY option specifies the minimum number of seconds that UNLOAD PLUS waits before it tries again to obtain the drain. The number of seconds can range from 1 through 1800.

Overriding this option

You can override the value for this option by using the RETRY_DELAY command option (RETRY_DELAY). 

DRNRETRY=255

The DRNRETRY option specifies the maximum number of times that UNLOAD PLUS attempts to obtain a drain before it terminates the job. The number of retry attempts can range from 0 through 255.

Overriding this option

You can override the value for this option by using the RETRY command option (RETRY). 

DRNWAIT=NONE

The DRNWAIT option specifies the drain timeout value to use. Specify one of the following values:

• NONE, which tells the drain request that UNLOAD PLUS issues to time out immediately if the drain cannot acquire the lock

  NONE prevents any application transactions from being queued during the drain process. We recommend that you specify NONE in high-transaction environments.

• UTIL, which tells UNLOAD PLUS to use the standard Db2 utility timeout value defined in DSNZPARMS for your site (IRLMRWT multiplied by UTIMOUT)

  The wait time applies to each object involved in the unload process.

• SQL, which tells UNLOAD PLUS to use the standard SQL timeout value (IRLMRWT) as the drain timeout value

  The wait time applies to each object involved in the unload process.

• Any integer value from 0 through 1800
  • 0 is equivalent to the value UTIL.
  • 1 through 1800 specifies the number of seconds to wait to obtain the drain for each drain retry before timing out.

If UNLOAD PLUS cannot drain all of the objects within the time period specified by DRNWAIT, UNLOAD PLUS completes the following process:

1. Releases the drains that it has obtained so far
2. Waits the length of time that you specify in the DRNDELAY installation option (or RETRY_DELAY command option)
3. Tries again to drain the objects for the number of times that you specify in the DRNRETRY installation option (or RETRY command option)

Overriding this option

You can override the value for this option by using the DRAIN_WAIT command option (DRAIN_WAIT). 

DSPLOCKS=DRNFAIL

The DSPLOCKS option tells UNLOAD PLUS what action to take regarding displaying claims and locks if a drain attempt times out. The following values are valid for this option:

• DRNFAIL tells UNLOAD PLUS to display the claims and locks once, after the final attempt to obtain the drain times out.
• NONE tells UNLOAD PLUS not to display any claims or locks.
• RETRY tells UNLOAD PLUS to display the claims and locks after each drain timeout.

Overriding this option

You can override the value for this option by using the DSPLOCKS command option (DSPLOCKS). 

EXCLDUMP=(X37,X22,X06)

The EXCLDUMP option allows you to limit the conditions under which UNLOAD PLUS generates a system dump when the SDUMP installation option contains values other than NO. The EXCLDUMP option tells UNLOAD PLUS to exclude the listed abend codes when generating the dump.

Specify a three-digit abend code, such as 806 or 222, or prefix an X to a two-digit abend code to exclude all abend types that end in those two digits. For example, if you specify X37, UNLOAD PLUS will not generate a system dump for all abend codes that end in 37 (such as B37 or E37). You can specify up to ten abend codes with the EXCLDUMP option.

Specify EXCLDUMP=0 (without parentheses) if you want all abend codes to be candidates for a system dump. 

FILEREFDN=SYSREF

The FILEREFDN option specifies the default output descriptor for any referenced files that UNLOAD PLUS will allocate or use.

We recommend that you use the default value for this option, SYSREF. The name that you specify must be different than any output descriptors or ddnames specified for the UNLOADDN installation or command option. 

FILL=NO

The FILL option specifies whether UNLOAD PLUS externalizes all leading zeros when it converts numeric columns to their external representations. You can specify one of the following options:

• Specify NO if you want to remove all leading zeros when converting numeric columns to their external representations.
• Specify YES to externalize all leading zeros when converting numeric columns to their external representations. As the sign of the number, the first character in the external representation of the number is either a minus sign ('-') or is blank. You can specify this option to ensure that the data format includes leading zeros so that applications such as COBOL can edit and check unloaded data properly.

Overriding this option

You can override the value for this option by using the FILL command option or by using the FILL option on the individual field specifications. 

FORCE=NONE

The FORCE option specifies whether to cancel Db2 threads that might prevent a drain process from completing. Specify one of the following options:

• NONE tells UNLOAD PLUS not to cancel Db2 threads.
• ALL tells UNLOAD PLUS to cancel both read and write claimers at the point specified by the FORCE_AT option.

You cannot use this option to cancel threads when UNLOAD PLUS is attempting to acquire a lock on a table. For information about when UNLOAD PLUS uses lock table processing instead of drain processing, see Drain-and-lock-table-processing.

Overriding this option

You can override the value for this option by using the FORCE command option. The FORCE command option provides an additional option, REPORTONLY, that tells UNLOAD PLUS to display a report of the threads that would have been canceled if you had specified FORCE ALL. For more information, see FORCE. 

FORCE_AT=(START,3)

The FORCE_AT option tells UNLOAD PLUS when to cancel Db2 threads that might prevent the drain process from completing. This option is applicable only when FORCE ALL or FORCE REPORTONLY is in effect.

The first parameter of this option indicates at which point during the drain process to begin canceling threads. The second parameter indicates how long to delay the start of the cancelation process from the specified point in the drain process.

For the first parameter of this option, specify one of the following values:

• START tells UNLOAD PLUS to start canceling threads when the drain request begins.
• RETRY tells UNLOAD PLUS to start canceling threads the first time the drain process times out and UNLOAD PLUS attempts to retry the drain.
• LASTRETRY tells UNLOAD PLUS to start canceling threads at the beginning of the last retry attempt following a drain process timeout. You can control the number of drain retry attempts with the RETRY command option or DRNRETRY installation option.

For the second parameter of this option, specify an integer value to indicate hundredths of a second. For example, specify 7 to tell UNLOAD PLUS to wait .07 seconds. Specify an integer value of 0 or greater. The default, 0, tells UNLOAD PLUS to start the cancelation process immediately upon reaching the point specified by the FORCE_AT option.

Overriding this option

You can override the value for the first parameter of this option by using the FORCE_AT suboption of the FORCE command option. You can override the value for the second parameter by using the FORCE_DELAY suboption of the FORCE command option. For more information, see FORCE. 

FORCE_RPT=NO

The FORCE_RPT option tells UNLOAD PLUS whether to display a report of the canceled threads.

Specify one of the following values for this option:

• YES tells UNLOAD PLUS to display the report. This value is applicable only when FORCE ALL is in effect.

  If your JCL includes a BMCFORCE DD statement, UNLOAD PLUS sends the canceled threads report to that data set. Otherwise, the report is displayed in the UNLOAD PLUS SYSPRINT.

• NO tells UNLOAD PLUS not to display the report.

UNLOAD PLUS ignores FORCE_RPT when you specify FORCE REPORTONLY on the UNLOAD command.

Overriding this option

You can override the value for this option by using the FORCE_RPT suboption of the FORCE command option. For more information, see FORCE. 

HISTORY=YES

The HISTORY option specifies whether to update the BMCHIST table. If you specify YES, UNLOAD PLUS updates the BMCHIST table for each table space. If you specify NO for this option, UNLOAD PLUS bypasses any updates to the BMCHIST table. 

IBUFFS=25

The IBUFFS option specifies a multiple of either 256 KB or 32 KB to use to define the amount of buffer pool storage that is allocated for image copy input data sets. Valid values are 1 through 255.

• For copy data sets on tape, UNLOAD PLUS uses a multiplier of 256 KB (to allow for block sizes greater than 32 KB). In this case, if the IBUFFS option has a value greater than 6, UNLOAD PLUS ignores that setting and uses 6.
• For all other copy data sets, UNLOAD PLUS uses a multiplier of 32 KB. 

INLINE=NO

The INLINE option specifies whether to unload data from an inline image copy. This image copy is associated with a ddname specified with the INFILE option. You can specify one of the following options:

• Specify YES to treat the specified image copy as an inline copy. This option enables UNLOAD PLUS to unload data from out-of-sequence pages. If you specify INLINE=YES, you can use the same production jobs to unload from standard copies.

• Specify NO to not treat the specified image copy as an inline copy.

  Warning

  UNLOAD PLUS supports unloading data from an inline image copy when you specify INFILE ddname and INLINE YES. Inline image copies can have out-of-sequence pages. However, UNLOAD PLUS cannot determine pages that might be out of sequence before processing begins unless you also specify INLINE YES. Using an inline copy that contains pages that are out of sequence can cause a serious page error (see message BMC50251S) if you specify INLINE NO.

Overriding this option

You can override the value for this option by using the INLINE option of the INFILE command option (INFILE). 

KEYDSNAM=

The KEYDSNAM option specifies the key data set name to use when unloading encrypted copies that were created by BMC AMI Copy.

For more information about unloading encrypted copies, see the IMAGECOPY option of the INFILE command option (INFILE). For more information about this key data set, see the BMC AMI Copy for Db2 documentation. 

LOADDECP=NO

When unloading rows from an image copy that was originally created in a subsystem that is different from the local subsystem, it might be necessary to also access the DSNHDECP from the subsystem where the image copy was created.

To reference a DSNHDECP that is different from the local subsystem default, specify LOADDECP=YES in the UNLOAD PLUS installation options module and include the library that contains the desired DSNHDECP in the STEPLIB concatenation of the UNLOAD PLUS job.

To obtain all Db2 installation default parameters (except SSID) from the DSNHDECP that resides in the local subsystem, specify LOADDECP=NO.

SSID is always obtained from the DSNHDECP in the STEPLIB regardless of the value of LOADDECP in the UNLOAD PLUS installation options module. 

LOCKROW=YES

The LOCKROW option tells UNLOAD PLUS which serialization method to use when updating the BMCSYNC and BMCUTIL tables:

• LOCKROW=YES tells UNLOAD PLUS to use MVS enqueues instead of the SQL LOCK TABLE statements for serialization. Using LOCKROW=YES should prevent most SQL -911 return codes that occur when multiple BMC products concurrently update the BMCSYNC and BMCUTIL tables.
• LOCKROW=NO tells UNLOAD PLUS to use SQL LOCK TABLE statements for serialization when updating the BMCSYNC and BMCUTIL tables.

Additional considerations

The following considerations apply to the LOCKROW option:

• Using LOCKROW=YES requires row-level locking. You must define the BMCSYNC and BMCUTIL tables with LOCKSIZE ROW to achieve row-level locking.
• The following BMC products must use the same LOCKROW value within a subsystem: CHECK PLUS, BMC AMI Copy, LOADPLUS, BMC AMI Recover, REORG PLUS, and UNLOAD PLUS. Regardless of the value assigned for LOCKROW, BMC AMI Copy and BMC AMI Recover always behave as if LOCKROW=YES.
• In a future version, UNLOAD PLUS will no longer require or support the LOCKROW installation option. 

MAXP=5

The MAXP option specifies the maximum number of partitions to unload concurrently from any one task. This option is also useful for limiting the number of tape drives that UNLOAD PLUS requires simultaneously if you specify the INFILE IMAGECOPY command option to unload from image copies on tape. 

MSGLEVEL=1

The MSGLEVEL option controls the messages that UNLOAD PLUS returns in the SYSPRINT and SYSPRIN2 data sets:

• MSGLEVEL=0 returns minimal messages.
• MSGLEVEL=1 returns additional messages to help you diagnose problems and fine-tune performance.

Overriding this option

You can override the value for this option by using the MSGLEVEL parameter on the EXEC statement. For more information about this parameter, see Utility parameters on the UNLOAD PLUS EXEC statement. 

NULLCHAR=?

The NULLCHAR option specifies the null indicator character in the output record. Specify one of the following values:

• ?
• Any valid character constant for C-type assembler language
• Any valid hexadecimal assembler constant, in the format X'xx'
• HIVAL, which fills the null indicator field with high values

This value signifies only a single byte. If the null indicator field is two bytes long, UNLOAD PLUS propagates the constant to the second byte.

When you are using the CNTLCARDS SQL/DS, SQL/DS-DDL, or SQL/DS-LOAD option, the only valid specification for NULLCHAR is ?. If you try to use any other NULLCHAR value, UNLOAD PLUS issues message BMC51610E and terminates.

Overriding this option

You can override the value for this option by using the NULLCHAR command option (NULLCHAR). 

NULLTYPE=T1

The NULLTYPE option specifies the location and length of the null indicator field in the output record. Specify one of the following values:

• T1 (the null indicator is one byte long and follows the column)
• T2 (the null indicator is two bytes long and follows the column)
• L1 (the null indicator is one byte long and precedes the column)
• L2 (the null indicator is two bytes long and precedes the column)

When you are using the CNTLCARDS SQL/DS, SQL/DS-DDL, or SQL/DS-LOAD option, the only valid specification for NULLTYPE is T1. If you try to use any other NULLTYPE value, UNLOAD PLUS issues message BMC51610E and terminates.

Overriding this option

You can override the value for this option by using the NULLTYPE command option (NULLTYPE). 

OPNDB2ID=YES

The OPNDB2ID option tells UNLOAD PLUS whether to use the Db2 RACF ID or the user’s RACF ID:

• OPNDB2ID=YES tells UNLOAD PLUS to use the Db2 RACF ID (instead of the RACF ID of the user who is running UNLOAD PLUS) when opening Db2 data sets.
• OPNDB2ID=NO tells UNLOAD PLUS to use the RACF ID of the user who is running UNLOAD PLUS. If you specify NO, the user must have the appropriate RACF authorization.

For any security system other than RACF, you should specify OPNDB2ID=NO so that UNLOAD PLUS uses the ID of the user who is running the utility. For more information, see Setting-UNLOAD-PLUS-authorizations. 

PLAN=ADU1120

The PLAN option specifies the name of the product plan. This plan contains the packages that provide the various capabilities of UNLOAD PLUS. 

RECFM=AUTO

The RECFM option allows you to override the record format for the unload data sets that UNLOAD PLUS determines to be optimal. You can specify one of the following keywords:

• AUTO tells UNLOAD PLUS to determine the optimal record format.

• VB tells UNLOAD PLUS to always use variable block record format (VB).

  Important

  If the record length of your unload file is greater than the system maximum block size, UNLOAD PLUS defines the data set as variable-block spanned (VBS) instead of VB, and issues message BMC51745W.

If you are unloading LOB or XML data, UNLOAD PLUS ignores this option for any referenced files that it allocates.

Overriding this option

You can override the value for this option by using the RECFM command option (RECFM). 

ROWSETSZ=100

This option is valid only if DIRECT NO is in effect.

The ROWSETSZ option tells UNLOAD PLUS how many rows to include in a rowset for a single FETCH request.

You can specify one of the following values:

• 0 or 1 tells UNLOAD PLUS to fetch a single row at a time.
• Any integer value from 2 through 200 tells UNLOAD PLUS to fetch the specified number of rows (as a rowset).

Restriction

UNLOAD PLUS ignores ROWSETSZ when you are unloading LOB or XML data.

Overriding this option

You can override the value for this option by using the DIRECT NO ROWSETSZ command option. 

SCHEMA=

Generates DDL with CNTLCARDS DB2/DB2DDL with an unqualified table name preceded by “SET CURRENT SCHEMA” statement, and generates the LOAD control cards with schema as qualifier of the table name.

Overriding this option

You can override the value for this option by using the SCHEMA option in CNTLCARDS DB2/DB2DDL. 

SDUMP=(ALLPSA,CSA,RGN,SQA,LSQA,SUM,TRT,IO)

The SDUMP option tells UNLOAD PLUS to generate a system dump, using the information listed in the option, if an unload job abnormally terminates. The values listed provide diagnostic information to BMC Customer Support. Although you can specify any values that IBM allows for the SDATA parameter on the SDUMPX macro, we recommend that you do not change the values that were shipped with the product. For a complete list and description of the values that you can specify for this option, see the IBM SDUMPX macro description.

UNLOAD PLUS uses the system-defined dump data set to hold the data. In cases where multiple abends occur, UNLOAD PLUS generates the dump for only the first abend. The SDUMP option allows you to generate a system dump, regardless of your access to storage keys 0 through 7.

You can also specify SDUMP=NO to not generate a system dump.

To limit the conditions under which UNLOAD PLUS generates the system dump, you can exclude selected abend codes by using the EXCLDUMP installation option. 

SHRLEVEL=REFERENCE

The SHRLEVEL option specifies the default SHRLEVEL that UNLOAD PLUS uses to unload objects. SHRLEVEL=REFERENCE restricts access to objects to read-only during UNLOAD PLUS processing. UNLOAD PLUS then externalizes the pages of the table space. When UNLOAD PLUS processing completes, the utility restores the object to its original status.

If you are unloading from a table space, specify SHRLEVEL=CHANGE to allow read/write access to the table space during unload processing. UNLOAD PLUS ignores the SHRLEVEL option if you specify the DIRECT NO or INFILE ddname command options.

Overriding this option

You can override the value for this option by using the SHRLEVEL command option (SHRLEVEL). 

SMAX=16

The SMAX option specifies the number of subtasks that can execute concurrently during an unload. If the unload requires sorting, this option limits the number of concurrent sorts.

A value of 16 allows UNLOAD PLUS to run in optimized mode. To reduce the amount of system resources that UNLOAD PLUS uses if other processing requirements constrain resources, you might need to specify a lower value for this option.

For more information, see Performance-considerations-for-sort-processing-options.

Overriding this option

You can override the value for this option by using the MAXSORTS command option (MAXSORTS). 

SMCORE=(0K,0K)

The SMCORE option specifies the amount of memory that you want each invocation of BMCSORT to use. BMC strongly recommends that you use the 0K and 0K values for this option. For more information, see Performance-considerations-for-sort-processing-options.

The values 0K and 0K tell UNLOAD PLUS to determine the appropriate amount of memory to use for each sort based on the following criteria:

• The number of sorts to process
• The amount of memory that is available during optimization
• The value specified for REGION in either your JCL or system exits

The first value specifies the total amount of memory to use both above and below the 16-megabyte line for each sort. You can specify this value in either kilobytes or megabytes. The following values are valid for this parameter:

• 0K (or 0M) tells UNLOAD PLUS to determine the appropriate amount.
• Any value from 4096K through 65536K (or 4M through 64M) tells UNLOAD PLUS to use the specified amount.

The second value specifies the amount of memory required below the 16-megabyte line for each sort. You can specify this value in either kilobytes or megabytes. The following values are valid for this parameter:

• 0K (or 0M) tells UNLOAD PLUS to determine the appropriate amount.
• Any value from 256K through 4096K (or 1M through 4M) tells UNLOAD PLUS to use the specified amount.

SORTNUM=32

The SORTNUM option affects the allocation of sort work files when BMCSORT is allocating your sort work files dynamically. You can specify any integer from 0 through 255. 

The following table describes the action that BMCSORT takes for each value that you can specify for this option. The table also provides any additional considerations for these values.

SORTNUM values

If the value of the third parameter in the BMCSORT DYNALOC installation option is OFF, specifying a value greater than 0 for the SORTNUM option turns BMCSORT dynamic allocation on, and BMCSORT allocates sort work files as needed. For information about when BMCSORT allocates your sort work files dynamically, see SORTWK-data-sets.

Overriding this option

You can override the value for this option by using the SORTNUM command option (SORTNUM). 

SQLDELAY=3

The SQLDELAY option specifies the number of seconds to wait between retry attempts after receiving an SQL -911 return code. This interval is in addition to the time that elapses when Db2 waits for a timeout or deadlock. The number of seconds can range from 1 to 655. 

SQLRETRY=100

The SQLRETRY option specifies the number of times to retry an SQL statement. The number of attempts can range from 1 to 255. 

SSREPORT (PTF BQU2214 applied)

SSREPORT determines which cases are written to the SmartSwitch tracking table. The values are as follows:

• REPORT_SWITCH: Cases are written to the tracking table only when ran under REPORT_SWITCH rule.
• ALL: Cases are written to the tracking table regardless of the rule they run under: REPORT_SWITCH, ALLOW_SWITCH, and FORCE_NO_SWITCH. 

SSEXCNTL

((SPE2005))

The SSEXCNTL option provides a list of CNTLCARDS formats that are precluded from switching to BMC AMI Unload.

If any of the values supplied are found in SYSIN, UNLOAD PLUS does not switch to BMC AMI Unload. If no values are specified to the SSEXCNTL, all supported CNTLCARDS formats switch to BMC AMI Unload. When printed in SYSPRINT, only the first four characters of the values are printed. 

Specify one of the following supported values: DB2LOAD, DB2, BMCLOAD, and DB2DDL. 

TAPEDISP=DELETE

The TAPEDISP option specifies the final disposition of tape files when the value of the DELETEFILES option is YES. TAPEDISP=DELETE specifies that each tape file will have a disposition of OLD, DELETE, DELETE when the tape is deallocated.

If you specify TAPEDISP=UNCATLG, each tape will have a disposition of OLD, UNCATLG, UNCATLG when the tape is deallocated. Depending on your tape management environment, using UNCATLG can prevent a tape remount. 

TAPES=NONE

The TAPES option specifies a list of tape units that tells UNLOAD PLUS to identify a unit as a tape device for dynamically allocated data sets. This option is not required in most circumstances because UNLOAD PLUS dynamically determines the device type for its output data sets. You should not need to specify the tape units unless UNLOAD PLUS is unable to identify your units automatically.

You can specify a list of tapes in the format (tape1,tape2,.......,tapen). 

TASKMAX=200%

The TASKMAX option specifies the maximum number of tasks to start and is the global setting for all tasks. You can specify one of the following values:

• An integer from 1 through 16, indicating that UNLOAD PLUS can start up to that number of tasks
• A percentage, indicating that UNLOAD PLUS can start that percentage of the number of online CPUs on the system

You can override this option with other options, such as UNLDMAX, for specific multitasking operations. 

UBUFFS=25

The UBUFFS option specifies a multiple of 32 KB to use to define the amount of buffer pool storage that is allocated for unload (SYSREC) data sets. Valid values are 1 through 255. For more information, see Performance-considerations-for-buffer-installation-options. 

UNLDMAX=*

The UNLDMAX option specifies the maximum number of tasks to start per CPU during the UNLOAD phase. Although you can specify an integer or percentage value, BMC strongly recommends that you accept the default of * and manage multitasking by using the TASKMAX and SMAX options. An asterisk value tells UNLOAD PLUS to use the value for the TASKMAX option.

Regardless of the value that you specify, UNLOAD PLUS does not start more than 16 tasks for this phase. 

UNLOADDN_ACTIVE=(YES,NO)

The UNLOADDN_ACTIVE option activates or deactivates dynamic allocation of the primary and secondary unload data sets. Specify YES for the primary or secondary parameter to activate dynamic allocation for the corresponding unload data set. Specify NO to deactivate dynamic allocation for the corresponding unload data set. You can specify the ACTIVE keyword following the UNLOADDN specification (for example, UNLOADDN(SYSREC,SYSRED) ACTIVE(YES,YES)) in the SYSIN command stream to override the specified installation value.

If you activate dynamic allocation in installation options, UNLOAD PLUS dynamically allocates any unload data sets that are required but are not specified in the JCL. If you specify all required unload data sets in the JCL, UNLOAD PLUS does not use dynamic allocation. 

UNLOADDN=(SYSREC, SYSRED)

The UNLOADDN option provides UNLOAD PLUS with one of the following pieces of information:

• The default ddname or ddname prefix for the primary and secondary unload data sets

  If you change the ddnames that BMC supplies, you must also change the names in your JCL or OUTPUT statements.

• The output descriptor or prefix to match to the OUTPUT statement (or $ADUOUTP macro) when allocating unload data sets dynamically

  During installation, the names that you specify for this option become the default output descriptor names (see Options-that-are-common-to-disk-and-tape-data-sets) that are associated with the dynamic allocation options for the primary and secondary unload data sets. For example, if you specify (OUT1, OUT2) for this option, the Installation System prompts you to supply dynamic allocation option values for OUT1 and OUT2.

The output descriptors or output descriptor prefixes for the primary unload data sets, secondary unload data sets, and referenced files must all be unique. (The FILEREFDN option specifies the default output descriptor for referenced files.)

Overriding this option

You can override the value for this option by using the UNLOADDN command option (UNLOADDN). 

USELRECL=NO

The USELRECL option specifies whether UNLOAD PLUS checks and uses the logical record length (LRECL) value either from the JCL DD DCB statement or the OUTPUT statement that you specify in your command options for the primary unload data set that corresponds to each SELECT statement. Specify NO if you want UNLOAD PLUS to use the calculated record length. Specify YES to use the specified LRECL.

If you specify YES, UNLOAD PLUS:

• Uses fixed block for the data set record format and pads it with spaces of the appropriate encoding scheme when necessary

  Important

  If you specify RECFM VB on your UNLOAD command (or it is in effect by default from the RECFM installation option) UNLOAD PLUS uses variable block format for the data set records.

• Forces the same DCB values in the corresponding secondary unload data set if you request or specify a secondary data set

• Calculates the LRECL if you did not specify an LRECL value on the DD statement or in the OUTPUT statement

  If UNLOAD PLUS calculates the LRECL value, the data set is fixed, variable, or variable-spanned according to the standard record length and record format calculations for UNLOAD PLUS.

Restrictions

Note the following restrictions on USELRECL=YES:

• If the specified LRECL is shorter than the length that is required to contain the largest formatted row, UNLOAD PLUS ends with error message BMC51649E.
• UNLOAD PLUS ignores USELRECL=YES if you specify any of the following options:
  • FORMAT CSV
  • FORMAT XML
  • FORMAT INTERNAL
  • FORMAT BMCLOAD
• If you are unloading LOB or XML data, UNLOAD PLUS ignores USELRECL=YES for any referenced files that it allocates.

Overriding this option

You can override the value for this option by specifying the USELRECL command option (USELRECL). 

UXSTATE=SUP

The UXSTATE option tells UNLOAD PLUS how to invoke Db2 user exits:

• UXSTATE=SUP specifies that UNLOAD PLUS should call Db2 user exits (such as EDITPROCs) in supervisor state (and PSW key=7).
• UXSTATE=PROB tells UNLOAD PLUS to call Db2 user exits in problem state (and PSW key=7).

The requirements of the exits dictate the UXSTATE setting. Check with the exit author (or vendor) before changing to UXSTATE=PROB. 

WORKUNIT=SYSALLDA

The WORKUNIT option specifies a temporary work data set and is used when running a SHRLEVEL CHANGE unload or during the dynamic bind process. VIO is an acceptable value for this option. 

XBMID=

The XBMID option identifies a specific XBM subsystem ID (SSID) to use for snapshot processing and zIIP processing in UNLOAD PLUS.

The SSID is the unique identifier that was specified when XBM or SUF was installed. If you are using XBM or SUF in a Db2 data sharing environment, you can use the value of the XBMGROUP parameter instead of the XBM SSID. The XBMGROUP name is the name of the cross-system coupling facility (XCF) group that is defined to the XBM subsystem, and its default value is XBMGROUP.

If you specify an XBM subsystem, it must be:

• Available
• At a supported maintenance level
• Enabled for the required function

If you do not specify an XBM subsystem (either here or with the XBMID installation option), UNLOAD PLUS automatically searches for an XBM subsystem that meets the same criteria. If you have multiple subsystems that meet these criteria, UNLOAD PLUS can use any one of these subsystems.

For more information about using XBM or SUF for snapshot processing with UNLOAD PLUS, see Running-SHRLEVEL-CHANGE-CONSISTENT-YES.

Overriding this option

You can override the value for this option by using the XBMID command option (XBMID). 

ZIIP=ENABLED

The ZIIP option tells UNLOAD PLUS whether to attempt to use IBM z Integrated Information Processors (zIIPs). UNLOAD PLUS can use enclave service request blocks (SRBs) to enable zIIP processing automatically while running jobs. Using zIIP processing can reduce the overall CPU time for UNLOAD PLUS jobs.

You can specify one of the following options:

• ENABLED tells UNLOAD PLUS to attempt to offload eligible processing to an available zIIP. If the zIIP is busy or not available, normal processing continues on a general-purpose processor.
• DISABLED tells UNLOAD PLUS to not attempt to use zIIP processing.

To enable and use zIIP processing with UNLOAD PLUS, you must

• Have an installed authorized version of XBM or SUF
• Start and maintain an XBM subsystem in your environment
• Have a zIIP available in your environment

Using XBM or SUF

You can specify a particular XBM subsystem to use by specifying a value for the XBMID installation or command option.

XBM and SUF are licensed, installed, and maintained separately from UNLOAD PLUS. You can use either XBM or SUF, depending on the license that you have obtained:

• A license for the full version of the XBM product authorizes you to use all features of XBM.
• A license for SUF authorizes you to use only the snapshot and zIIP-processing features of XBM.

For more information about XBM and SUF, see theEXTENDED BUFFER MANAGER for DB2 documentation.

Overriding this option

You can override the value for this option by using the ZIIP command option (ZIIP). 

ZONEDDECOVP=(C,D)

The ZONEDDECOVP option assigns overpunch values to decimal-zoned numeric values. The overpunched values can be positive or negative.

• The first operand specifies the zone overpunch value for positive numbers. Standard positive overpunch values are A, C, E, and F.
• The second operand specifies the zone overpunch value for negative numbers. Standard negative overpunch values are B and D.

This option can be useful when you plan to use the unloaded data with an application that requires a specific zone value that is not the traditional default.

To obtain the absolute value of a number or to ensure that the value is in data external format, specify ZONEDDECOVP (F,F).

Overriding this option

You can override the value for this option by using the ZONEDDECOVP command option (ZONEDDECOVP).