Space announcements

   

This space provides the same content as before, but the organization of the home page has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.

Installation option descriptions


This topic contains detailed descriptions of each installation option.

If an installation option has a default value, the default value is shown following the option name. Also noted is SYSIN syntax, if available, to override the setting of the installation option at runtime, with a reference to more information.

ALPOFDSN=

Specifies the location of a data set that contains the Log Master product options file (POF). Log Master can read this optional file to obtain certain default values for the online interface. In the current version of Log Master, the POF supports default values that are related to output data set names or STEPLIB information (data set names on the Output Defaults, Automated Drop Recovery Defaults, or Generate JCL panels). This option has no default value.

The value for ALPOFDSN can be a data set or a member of a partitioned data set. Log Master does not require a specific name for the data set or member.

You can specify multiple POF data sets, such as one per DB2 subsystem or data sharing group, by using the following symbolic variables:

  • &SSID (subsystem ID)

  • &GATN (group attach name)

Use this file to establish subsystem-wide default values that apply to all users of the Log Master online interface. Many environments use the POF to match default data set names with site naming conventions. For the default values currently supported in the POF, see Sample POF with supported default values.

The following considerations apply to the POF:

  • Log Master also stores online interface defaults in your ISPF profile. If you change a default value during an online session, your change will be preserved for any future sessions under your TSO ID. The order of precedence for online defaults is ISPF profile value, POF value, and product base default values.

  • For the current version, the Log Master POF does not apply to any other products from BMC Software.

  • The POF is not generated during installation. To create and use a POF, you must complete the following tasks:

    • Set the ALPOFDSN installation option equal to your desired POF data set name.

    • Edit the job that is stored in member HLQ.DBSAMP(ALPPOFX) to insert your POF name. (The HLQ value represents a qualifier that your environment assigns during installation.)

    • Submit the job. Log Master creates a POF with Log Master base default values.

    • Edit the POF to set your desired default values. (The POF stores default values in the form of XML elements and attribute values.)

The next time you run the Log Master online interface, POF default values will appear (unless your TSO profile already contains a default value for a particular field). To remove the TSO default value for a field, run the online interface, delete the content in that field, and exit the interface.

The figure shows a sample POF with all currently supported POF default values.

Sample POF with supported default values

<!--?xml version='1.0' ?-->

<bmcoptions>

<optionset>

</optionset>

<!-- Log Master Options... -->

<optionset product="ALP">

<option name="UNDOSQLDSNMODEL" value="&SYSUID..D&DATE..T&TIME..UNDO.SQL"></option>

<option name="UNDOSQLDSNTMPLT" value="&SYSUID..D&DATE..T&TIME..UNDO.TPL"></option>

<option name="REDOSQLDSNMODEL" value="&SYSUID..D&DATE..T&TIME..REDO.SQL"></option>

<option name="REDOSQLDSNTMPLT" value="&SYSUID..D&DATE..T&TIME..REDO.TPL"></option>

<option name="MGRTSQLDSNMODEL" value="&SYSUID..D&DATE..T&TIME..MGRT.SQL"></option>

<option name="MGRTSQLDSNTMPLT" value="&SYSUID..D&DATE..T&TIME..MGRT.TPL"></option>

<option name="REPORTDSNMODEL" value="&SYSUID..D&DATE..T&TIME..REPORT.&RPTTYPE"></option>

<option name="LLOGDSNMODEL" value="&SYSUID..D&DATE..T&TIME..LLOG.DATA"></option>

<option name="LLOGDSNCNTRL" value="&SYSUID..D&DATE..T&TIME..LLOG.CNTL"></option>

<option name="LOADDSNMODEL" value="&SYSUID..D&DATE..T&TIME..LOAD.DATA"></option>

<option name="LOADDSNCNTRL" value="&SYSUID..D&DATE..T&TIME..LOAD.CNTL"></option>

<option name="MGRTDDLDSN" value="&SYSUID..D&DATE..T&TIME..MIGRATE.DDL"></option>

<option name="UNDODDLDSN" value="&SYSUID..D&DATE..T&TIME..UNDO.DDL"></option>

<option name="DRREPORTDSN" value="&SYSUID..D&DATE..T&TIME..DROPREC.RPT"></option>

<option name="DRRECREATEDDLDSN" value="&SYSUID..D&DATE..T&TIME..DRDDL.DATA"></option>

<option name="DRRECOVERPLUSDSN" value="&SYSUID..D&DATE..T&TIME..RPLUS.DATA"></option>

<option name="DRDSN1COPYDSN" value="&SYSUID..T&TIME..DR.DSN1COPY.DATA"></option>           

<option name="DRPOSTRECSQLDSN" value="&SYSUID..T&TIME..DRPREC.SQL.DATA"></option>

<option name="DRPOSTRECREBINDDSN" value="&SYSUID..T&TIME..DR.PREC.REBIND.DDL"></option>

<option name="DRPOSTRECCHECKDSN" value="&SYSUID..T&TIME..DRPREC.CHECK.CMDS"></option>

<option name="DRPOSTRECRUNSTATSDSN" value="&SYSUID..T&TIME..DRPREC.RUNSTATS.CMDS"></option>

<option name="MGRTCOMMANDDSN" value="&SYSUID..D&DATE..T&TIME..MIGRATE.CMDS"></option>

<option name="UNDOCOMMANDDSN" value="&SYSUID..D&DATE..T&TIME..UNDO.CMDS"></option>

<option name="DRPOSTRECREPAIRDSN" value="&SYSUID..DROPREC.REPAIR.CMDS"></option>

<steplib product="DB2">

<option name="DSN" value="&SSID..DB2.DSNLOAD"></option>

<option name="DSN" value="&SSID..DB2.DSNEXIT"></option>

</steplib>

<steplib product="ALP">

<option name="DSN" value="product.libraries"></option>

</steplib>

</optionset>

</bmcoptions>

AMSGLEV=0

Determines the type of messages that Log Master issues when a job encounters a DB2 security exception as it processes either DB2 log or logical log input. This installation option is related to the DB2AUTH and LLOGAUTH options. Values for AMSGLEV are as follows:

  • 0—Log Master issues minimal messages. The messages do not indicate that log records are suppressed in the output. The default value is 0.
  • 1—Log Master issues summary messages. The messages indicate that log records are suppressed, but do not specify the tables that are involved or how many records are suppressed.
  • 2—Log Master issues detailed messages. The messages indicate that log records are suppressed, which tables contain the suppressed records, and how many records are suppressed.

ANPCT=20

Specifies the percentage of key store memory that is allocated to the anomaly (AN) key store. Enter an integer value between 0 and 98. For more information about specifying all xxPCT installation option values, see the considerations cited in the description of the URPCT=20 installation option.

In the AN key store, Log Master maintains information used to produce the Backout Integrity report. If a job does not specify a Backout Integrity report as output, Log Master redistributes this memory evenly to the FC and BC key stores. The default value is 20.

Before changing the distribution of key store memory, see related material in STOREOPTS statement, MEMPERCENT syntax option.

APFONLIN=YES

Determines whether the online interface runs as an authorized TSO command, and whether Log Master checks to ensure that it has proper APF authorization. When the Log Master online interface runs as an authorized TSO command, Log Master can dynamically obtain the data set name of the BSDS from DB2. The default value is YES. Values for APFONLIN are as follows:

  • YES—Indicates that the online interface runs as an authorized TSO program. Log Master verifies that it has the proper APF authorization, and can dynamically obtain the name of the BSDS from DB2. For more information, see APF authorization for the online interface.
  • NO—Indicates that the online interface does not run as an authorized TSO program. If you set APFONLIN to NO, Log Master cannot dynamically obtain the name of the BSDS from DB2. You must enter the name and location of the BSDS on the Product Options panel (option 41 on the Main Menu).

BCPCT=10

Specifies the percentage of key store memory that is allocated to the backward completion (BC) key store. Enter an integer value between 0 and 98. For more information about specifying all xxPCT installation option values, see the considerations cited in the description of the URPCT=20 installation option.

In the BC key store, Log Master maintains copies of complete row images that might be used for row completion processing. The default value is 10.

Before changing the distribution of key store memory, see related material in STOREOPTS statement, MEMPERCENT syntax option.

BINDOWN=

Specifies an authorization ID that Log Master uses to bind an application plan when Log Master executes generated SQL statements. This authorization ID must have BINDADD authority for the DB2 subsystem where the SQL statements are executed.

If you do not define a value for BINDOWN, Log Master uses the primary authorization ID of the job.

You can override the installation option value at runtime by specifying the EXECSQL statement, BINDOWNER syntax option

BINDQUALIFIER=ALPvvr

Specifies a qualifier value that Log Master uses during execution to dynamically bind internal packages that are distributed with Log Master. This value also determines which set of synonyms Log Master uses. Log Master does not use this installation option when it binds packages to execute input SQL statements or when it generates SQL statements.

Specify any value that is valid for the QUALIFIER option of the DB2 BIND command, up to 16 bytes in length. The default value is ALPvvr, where vv represents a two-character version number and r represents a one-character release number.

BYPASSLL=NO

Determines whether Log Master includes or excludes certain database changes in Summary reports. When a DB2 Load utility is run with the LOG option set to YES, the DB2 log contains log records that reflect each page that the utility loads into a table space ('page format' log records). Log Master processes these log records to derive and report an INSERT action for each row that is loaded into each table. In some situations or environments, you might want to exclude these INSERT actions from your Summary reports to concentrate on more pertinent information.

Log Master ignores the value of this installation option when a log scan includes any form of output other than a Summary report.

  • YES—Indicates that Log Master should generate Summary reports that exclude the INSERT actions that result from a LOAD LOG YES action.
  • NO—Indicates that Log Master should generate Summary reports that include the INSERT actions that result from a LOAD LOG YES action. The default value is NO.

CMPLGRNG=YES

Indicates whether Log Master uses the SYSIBM.SYSLGRNX tables to reduce the amount of log that Log Master reads during row completion processing. During row completion processing, Log Master might need to read additional log records to assemble a complete image for all log records that are selected in your log scan. If this installation option is set to YES, Log Master can use the SYSLGRNX tables to determine which portions of the log contain no activity related to the log records that it needs to complete. Log Master can then avoid reading unnecessary log ranges and improve performance.

Values for CMPLGRNG are as follows:

  • YES—Indicates that Log Master can use the SYSLGRNX tables to reduce the amount of log that Log Master reads during row completion processing. The default value is YES.
  • NO—Indicates that Log Master does not use the SYSLGRNX tables to reduce the amount of log that Log Master reads during row completion processing.

Specifying YES normally improves Log Master performance. However, Log Master can experience degraded performance reading the SYSLGRNX table if you do not maintain that table (with a DB2 Modify utility). Use the elapsed time value that is provided by message BMC097168 to determine the performance of Log Master SYSLGRNX processing. To improve performance in this situation, specify NO.

CSTFILE=2000

Defines the relative cost of processing an additional data set, expressed in terms of reading one page from the DB2 log. This installation option works with the CSTMOUNT, CSTSEG, and IMAGESRC options. The default value is 2000.

When Log Master must choose between opening a data set (for example, a table space) and reading more pages in the log, Log Master uses the CSTFILE value to help make the decision. For example, the default value indicates that the cost in your environment to open and process a single data set is equivalent to reading 2000 pages from the log.

The value of CSTFILE must be between 0 and 1000000:

  • A value of 0 indicates that the cost of opening a data set is the same as reading one page of the DB2 log.

  • A value of 1000000 indicates that opening a data set is equivalent to reading 1,000,000 pages of the DB2 log.

Note

BMC Software recommends consulting BMC Software Customer Support before changing the default value.

To improve performance, as Log Master chooses between available image copy data sets, it assigns a lower CSTFILE value to any Instant Snapshot image copies that are available. Instant Snapshot image copies are created on intelligent hardware storage devices by the BMC Next Generation Technology Copy for DB2 for z/OS product with SNAPSHOT UPGRADE FEATURE (SUF).

You can override the installation option value at runtime by specifying the OPTION statement, FILECOST syntax option.

CSTMOUNT=25000

Defines the relative cost of a single tape mount, expressed in terms of the cost to read one page from the DB2 log. This installation option works in conjunction with the CSTFILE, CSTSEG, and IMAGESRC options.

When Log Master must choose between mounting a single tape and reading more pages in the log, Log Master uses the CSTMOUNT value to help make the decision. For example, the default value indicates that the cost in your environment to mount a single tape is equivalent to reading 25,000 pages from the log.

The value of CSTMOUNT must be between 0 and 1000000, as follows:

  • A value of 0 indicates that the cost of mounting a tape is the same as reading one page of the DB2 log.

  • A value of 1000000 indicates that mounting a tape is equivalent to reading 1,000,000 pages of the DB2 log.

Note

BMC Software recommends consulting BMC Software Customer Support before changing the default value.

You can override the installation option value at runtime by specifying the OPTION statement, FILECOST syntax option.

CSTSEG=2000000000

Assigns a relative cost to obtaining information from a segmented table space, expressed in terms of the cost to read one page from the DB2 log. The default value is 2,000,000,000.

Use this installation option to manage the risks associated with segmented or universal table spaces that are affected by mass delete actions (DELETE statements with no WHERE clause, or TRUNCATE statements). If Log Master uses a segmented or universal table space as a source for row completion, and a mass delete action affects that table space, Log Master cannot successfully complete log records.

Set the CSTSEG value higher to avoid failures in completion processing, but be aware that jobs requiring row completion might run slower, because Log Master tends to use image copies for row completion rather than the table space. Set the CSTSEG value lower to improve the performance of jobs that require row completion, but be aware that you are increasing the risk of row completion failure.

The value of CSTSEG must be between 0 and 4000000000, as follows:

  • A value of 0 indicates that the cost of reading a segmented or universal table space is the same as reading one page of the DB2 log.

  • A value of 4000000000 indicates that reading a segmented or universal table space is equivalent to reading 4,000,000,000 pages of the DB2 log.

Note

BMC Software recommends retaining the default value unless you know how many mass delete actions your environment experiences.

You can override the installation option value at runtime by specifying the OPTION statement, FILECOST syntax option.

DASDDSNS=10

Determines the maximum number of recalled data sets that Log Master maintains on DASD at one time. Use this installation option to minimize DASD requirements for large numbers of archived files. Enter a maximum number of data sets. To avoid imposing a limit, enter zero.

To honor the DASDDSNS value, Log Master issues requests to migrate any recalled data sets to their original migration status and level. If a job requires more data sets than this value, Log Master issues requests to migrate data sets even if the value of the MIGRATE keyword is NO.

Depending on how quickly your environment processes migrate requests, for short periods of time, the number of recalled data sets on DASD might be greater than the DASDDSNS value. Log Master can migrate only data sets that are managed by the IBM product DFSMShsm. If DFSMShsm is not available in your environment, Log Master might not be able to honor the DASDDSNS limit value.

You can override the installation option value at runtime by specifying the OPTION statement, DASD DATASETS syntax option.

DB2AUTH=NO

Determines whether Log Master honors DB2 security at the table level when a job accesses DB2 log input. If you enable this type of security and a Log Master job does not have the authorization that is required to access a given table, Log Master suppresses log records relating to the table in the job’s output. Depending on the message level set by the AMSGLEV installation option, the job might not receive any notification that records have been suppressed. Values for DB2AUTH are as follows:

  • YES—Indicates that Log Master honors DB2 security as it processes DB2 log input.
  • NO—Indicates that Log Master does not honor DB2 security. The default value is NO.

Note

  • When you enable DB2 security, ensure that your jobs have the proper security attributes. With this type of security, Log Master jobs that access DB2 log records that are related to a given database object must run under an authorization ID that has one of the following authorities:

    • SYSADM or SYSCTRL authority (checked once per job)

    • DBADM or DBCTRL authority for the database that contains the object (checked once per database, if required)

    • SELECT authority for the object (declared by specific GRANT statements stored in the SYSIBM.SYSTABAUTH table, checked once per table if required)

  • Log Master cannot perform authorization checking for dropped objects while running in overtime mode with DB2AUTH=YES. Specify DB2AUTH=NO to process logs for dropped objects.

Log Master honors either native DB2 security or external security (the DSNX@XAC exit provided by RACF, CA-ACF2 for DB2, CA-Top Secret for DB2, or other security packages).

DB2CAT=NO

Defines whether Log Master processes log records that are created as a result of updates to DB2 catalog tables. Values for DB2CAT are as follows:

  • NO—Log Master does not process log records for the DB2 catalog unless the job specifically sets the value of the DB2CAT keyword to YES in the LOGSCAN statement. For compatibility with earlier versions, the default value is NO.
  • YES—Log Master processes log records for the DB2 catalog if they meet the specified filter criteria.
  • NEVER—Log Master does not process log records for the DB2 catalog.

When a job operates on objects in the DB2 catalog, Log Master performs row completion processing on related log records. The large number of log records that are related to the catalog can cause a job to perform more row completion and run longer than a job that does not read the DB2 catalog. If you frequently operate on DB2 catalog objects, you can improve performance by creating more frequent image copies of the catalog, or by defining tables in the DB2 catalog with Data Capture Changes (DCC). The following table lists some DB2 catalog table spaces and a recommended data capture setting for each. To improve performance of jobs that read the DB2 catalog, define the catalog tables within the table space with the recommended setting.

DB2 catalog table spaces and recommended data capture settings for tables

DB2 catalog table space

DCC / DCN setting for tables within table space

DSNDB06.SYSCONTX

DCC

DSNDB06.SYSCOPY

DCC

DSNDB06.SYSDBASE

DCC

DSNDB06.SYSDBAUT

DCC

DSNDB06.SYSDDF

DCN

DSNDB06.SYSGPAUT

DCC

DSNDB06.SYSGROUP

DCC

DSNDB06.SYSOBJ

DCC

DSNDB06.SYSPKAGE

Optional

DSNDB06.SYSPLAN

Optional

DSNDB06.SYSROLES

DCC

DSNDB06.SYSSEQ

DCC

DSNDB06.SYSSEQ2

DCC

DSNDB06.SYSSTATS

DCN

DSNDB06.SYSSTR

DCC

DSNDB06.SYSTARG

DCC

DSNDB06.SYSUSER

DCC

DSNDB06.SYSVIEWS

DCC

You can override the installation option value at runtime by specifying the LOGSCAN statement, DB2CATALOG syntax option.

DB2DIR

Defines weather Log Master processes log records that are created as a result of updates to DB2 directory tables. Values for DB2DIR are as follows:

  • NO—Log Master does not process log records for the DB2 directory unless the job specifically sets the value of the DB2DIRECTORY keyword to YES in the LOGSCAN statement. For compatibility with earlier version, the default value is NO.
  • YES—Log Master processes log records for the DB2 directory if they meet the specified filter criteria.
    DB2 directory information is limited to Quiet Point and Summary All Activity report outputs.
  • NEVER—Log Master does not process log records for the DB2 directory.

DBCS=NO

Directs Log Master to use only uppercase characters in the online interface and the product-generated portions of reports (for example, in report headings and field labels). BMC Software provides this installation option for environments that display or print double-byte characters. This option prevents Log Master from inadvertently displaying or printing lowercase characters as incorrect double-byte characters.

  • NO—Log Master displays and prints both uppercase and lowercase characters. The default value is NO.
  • YES—Log Master displays and prints only uppercase characters.

DDLOBJ=NO

Determines whether Log Master includes data definition language (DDL) information in all output logical log files. When this installation option is set to YES, Log Master writes objects representing the DDL activity that is selected by your filter into the logical log data file.

The DDL objects that Log Master writes in an output logical log file are not the same as the DDL statements that it writes in an output DDL (or SQL) file. A DDL object can represent multiple DDL statements, and a DDL statement can represent multiple insert, update, or delete actions against several tables in the DB2 catalog. A DDL object written by Log Master can be interpreted as input by either Log Master itself (using the LLOG keyword of the INPUT statement) or by the High-speed Apply Engine that is distributed with Log Master.

Values for DDLOBJ are as follows:

  • YES—Directs Log Master to include DDL information in output logical log files.
  • NO—Directs Log Master to exclude DDL information from output logical log files. The default value is NO.

You can override the installation option value at runtime by specifying the LOGSCAN statement (LOGSCAN logical log output definition), INCLUDE DDL syntax option.

DDPRMBR=YES

Specifies the scope of the DASDDSNS value. This installation option applies only in a data sharing environment. Values for DDPRMBR are as follows:

  • YES—Indicates that the value is a maximum limit for each member of a data sharing environment. The default value is YES.
  • NO—Indicates that the value is a maximum limit for the entire data sharing group.

You can override the installation option value at runtime by specifying the OPTION statement, PER MEMBER syntax option.

DSNSYMPRE=YES

Forces the prefix for &TABNAME and &WORKID in input and output data set names. Values for DSNSYMPRE are as follows:

  • YES—Always adds the prefix. The default value is YES.
  • NO—Adds the prefix only if the first character of the node is not an alphabetic or a national character.

ERLYRCL=YES

Directs Log Master to issue requests to recall archived data sets before it needs the data sets for log processing. This action decreases delays in log processing by giving storage management software in your environment time to retrieve the required data sets. The default value is YES. You must set ERLYRCL to YES to enable any of the other Log Master early recall installation options (such as MIGRATE or DASDDSNS).

The SMSTASKS installation option limits the number of early recall requests that Log Master issues at any one time. Before you enable early recall of archived data sets, evaluate the settings of the SMSTASKS, MIGRATE, and DASDDSNS options to ensure that they are appropriate for your environment.

The Log Master early recall feature works with most storage management software. (The related data set migration feature can migrate only data sets that are managed by the IBM product DFSMShsm.) Values for ERLYRCL are as follows:

  • NO—Prevents Log Master from issuing early recall requests.
  • YES—Directs Log Master to issue early recall requests.

You can override the installation option value at runtime by specifying the OPTION statement, EARLY RECALL syntax option.

EXECMODE=CURRENT

Determines whether Log Master processes log records for DB2 objects that have been dropped and possibly re-created. Values for EXECMODE are as follows:

  • CURRENT—Specifies that Log Master processes DB2 log records only for objects that are currently defined in the DB2 catalog.
  • OVERTIME—Specifies that Log Master can process DB2 log records for objects that are no longer defined in the DB2 catalog. For more information about processing in overtime mode, see Overtime mode, or the section on objects over time in the Log Master for DB2 documentation .

You can override the installation option value at runtime by specifying the OPTION statement, EXECUTION MODE syntax option.

FCPCT=10

Specifies the percentage of key store memory that is allocated to the forward completion (FC) key store. Enter an integer value between 0 and 98. For more information about specifying all xxPCT installation option values, see the considerations cited in the description of the URPCT=20 installation option.

In the FC key store, Log Master maintains copies of complete row images that might be used for row completion processing. The default value is 10.

Before changing the distribution of key store memory, see related material in STOREOPTS statement, MEMPERCENT syntax option.

FCUSE=YES

Determines whether Log Master uses the forward completion (FC) key store to perform a type of row completion processing called heuristic completion. This type of processing is separate from and different than the more extensive row completion processing that Log Master performs. To determine the effects of heuristic completion in your environment, examine your job’s output for a series of messages that start with message BMC97396 and list the key store as FCUSE.

Note

BMC Software recommends consulting BMC Software Customer Support before changing the default value.

  • YES—Allows Log Master to perform heuristic completion. The default value is YES.
  • NO—Prevents Log Master from performing heuristic completion.

You can override the installation option value at runtime by specifying the OPTION statement, HEURISTIC FORWARDCOMPLETION syntax option.

FLTRMTHD=STATIC

Determines how and when Log Master obtains DB2 catalog information (DBIDs, OBIDs, or PSIDs) for the DB2 objects that are named in a filter. Log Master reads the DB2 catalog to resolve the names of DB2 objects into numeric identifiers. Log Master can read the catalog either once during the initial analyze phase of processing for all objects, or repeatedly as it encounters each object in the DB2 log.

  • STATIC—Directs Log Master to obtain DB2 catalog information one time (during the analyze phase of processing). Log Master obtains information for all DB2 objects that the filter explicitly names. The default value is STATIC.
  • DYNAMIC—Directs Log Master to obtain DB2 catalog information dynamically, as it scans the DB2 log. Log Master obtains information for the DB2 objects that are present in the scanned log records, and selects log records for only the objects that are named in the filter.

Note

BMC Software recommends retaining the default value unless you experience degraded performance during the Log Master analyze phase. To determine the performance of the analyze phase, use the elapsed time values that are provided by the message, BMC097024 ANALYZE FINISHED

For more information about performance considerations, see the OPTION statement, FILTER METHOD syntax option.

GENMDEL=YES

Determines what output Log Master generates when it encounters the DB2 log records that reflect a LOAD REPLACE action. When a DB2 Load utility runs with the REPLACE option, the log contains records that Log Master can interpret as a 'mass delete' action (similar to a DELETE statement with no WHERE clause or a TRUNCATE statement). Using the following options, this installation option controls whether Log Master includes the mass delete action in your generated output:

  • YES—Indicates that Log Master should include the mass delete action in the generated output. The default value is YES.
  • NO—Indicates that Log Master should not include the mass delete action.
    Use this option to prevent Log Master from including a generated DELETE or TRUNCATE statement in some situations. For example, for a LOAD REPLACE LOG NO action, DB2 writes log records corresponding to the mass delete action, but does not write subsequent log records that Log Master can interpret as a 'load' action (a series of INSERT statements). If you generate MIGRATE SQL in this situation and apply it to a target database, the generated statement removes all previous data from a table, but there are no generated INSERT statements to provide the loaded data. In some environments (such as with auditing or historical databases) the mass delete action is not appropriate.

You can override the installation option value at runtime by specifying the OPTION statement, GENERATE MASSDELETE syntax option.

IMAGESRC=ANY

Determines how Log Master attempts to perform row completion processing. The default value is ANY. For more information about row completion, see IMAGESOURCE or the section on Log Master for DB2 expert information in the Log Master for DB2 documentation .

Values for IMAGESRC are as follows:

  • ANY—Directs Log Master to determine the best approach for completing or decompressing rows based on available resources. The CSTFILE, CSTMOUNT, and CSTSEG installation options influence the approach that Log Master takes when you specify ANY.
  • TABLESPACE—Specifies that Log Master performs row completion or decompression only by locating the row on the table space and rolling back intervening log records. This choice increases the risk that Log Master can terminate with either BMC097386 'unable to decompress' or one of several 'unable to complete' error messages.
  • SYSCOPY—Specifies that Log Master uses the SYSIBM.SYSCOPY table in the DB2 catalog to locate resources to perform row completion or decompression. SYSCOPY resources include image copies or other events, such as LOAD LOG YES actions. Log Master obtains a row image from the image copy or log records of the event, and then applies any intervening log records. Log Master cannot use DFSMS concurrent image copies for row completion or decompression. For more information, see Reading image copies.
  • LOGONLY—Specifies that Log Master performs row completion or decompression using only information available on the log. This method of row completion or decompression is successful only when the entire row is logged within the range of the log scan.

You can override the installation option value at runtime by specifying the OPTION statement, IMAGESOURCE syntax option.

Jn

Specify the Julian day n, where n is a value from 1 through 365. This format does not account for leap days; that is, in all years, including leap years, February 28 is day 59 and March 1 is day 60. You cannot explicitly refer to February 29.

In the following example, DST begins on April 1 at 12:34:56 p.m., and ends on November 1 at 2:34:56 a.m.:

TZRULE='J91/12:34:56,J305/2:34:56'

KEYDSNAM=

Specifies the name of the key data set that is used for encrypted image copies. The BMC Next Generation Technology Copy for DB2 for z/OS product can create encrypted image copies. When the name of the key data set is provided through this option, Log Master can use encrypted image copies for row completion processing, or to obtain compression dictionaries. (Both Log Master and NGT Copy must use the same instance of the BMC Software table BMC_BMCXCOPY.)

This installation option does not have a default value. For more information about encrypted image copies, including the format of the key data set and suggestions for managing them, see the sections on encrypted image copies in the Next Generation Technology Copy for DB2 documentation .

KSMEMORY=100M,10M

Specifies the target maximum aggregate amount of below-the-bar memory (REGION) that Log Master uses for temporary working storage areas called key stores. The memory is used to hold log record, unit of recovery (URID), row image, and anomaly report information as required during log scan processing.

The KSMEMORY installation option requires you to specify two values:

  • The first value specifies the amount of memory used for the data in the key stores.
  • Prior to PTF BQU0316, this value is required, but not in use.
    (PTF BQU0316 applied) The index value specifies the target amount of memory used for the indexes in the key stores.

If the first value or (PTF BQU0316 applied) either value is exceeded, Log Master will offload (or "spill") the excess to above-the-bar storage which might result in a slight decrease in performance. The product adheres to the specifications provided in most cases. However, when large volumes of data are processed or when the specification is lower than the default values, the amount of below-the-bar memory used might exceed the specifications.

Enter both values as the number of bytes, kilobytes (using the suffix K) or megabytes (using the suffix M).

The amount of memory you allocate is distributed among key stores based on the values of the xxPCT installation options or the values specified in the MEMPERCENT keyword of the STOREOPTS statement. For more information, see the  URPCT=20  installation option (in this topic) or the  MEMPERCENT  (STOREOPTS statement).

LLOGAUTH=NO

Determines whether Log Master honors DB2 security at the table level when a job accesses logical log input. Log Master can read input from logical log files at a time after the files were originally created, or on a different DB2 subsystem, or in a different security environment. If you enable this type of security and a Log Master job does not have the authorization needed to access a given table, Log Master suppresses log records that relate to the table in the job’s output. Depending on the message level set by the AMSGLEV installation option, the job might not receive any notification that records have been suppressed.

Values for LLOGAUTH are as follows:

  • YES—Indicates that Log Master honors DB2 security when it processes logical log input.
  • NO—Indicates that Log Master does not honor DB2 security. The default value is NO.

Note

When you enable DB2 security, ensure that your jobs have the proper security attributes. With this type of security, Log Master jobs that access DB2 log records that relate to a given database object must run under an authorization ID that has one of the following authorities:

  • SYSADM or SYSCTRL authority (checked once per job)

  • DBADM or DBCTRL authority for the database that contains the object (checked once per database, if required)

  • SELECT authority for the object (declared by specific GRANT statements stored in the SYSIBM.SYSTABAUTH table, checked once per table, if required)

Log Master honors either native DB2 security or external security (the DSNX@XAC exit provided by RACF, CA-ACF2 for DB2, CA-Top Secret for DB2, or other security packages).

LOADEX=YES

Tells Log Master whether load output should include exchange records that are found in the scan range.

  • YES—The Log Master load output includes exchange records that are found in the scan range. The default value is YES.
  • NO—The Log Master load output does not include exchange records that are found in the scan range.

Note: These records, when included in the load output, do not have the column values found in other records. You should account for such short records if the load output is used as input in any post Log Master processing, or if the output is used to load the data into target tables.

LOADFMT=LOGMAST

Specifies the format of load data files and load control files. Several formats are available to help you move log information to other platforms or database software. Values for LOADFMT are as follows:

  • LOGMAST—Indicates that Log Master formats load data files and load control files using its own internal format. The BMC Software LOADPLUS for DB2 product can also read a load file in this format. The default value is LOGMAST.
  • UNLOADP—Indicates that Log Master formats load data and load control files using the native format of the BMC Software UNLOAD PLUS for DB2 product.
    For more information about the differences between the LOGMAST and ULOADP formats, see FORMAT.
  • CSV—Indicates that Log Master formats load data files and load control files using the Comma Separated Value (CSV) format. Individual fields in the load records are separated by commas.
  • SDF—Indicates that Log Master formats load data files and load control files using the Standard Definition Format (SDF) format. Individual fields in the load records are filled so that each field has the same position and length in all load records.

You can override the installation option value at runtime by specifying the LOGSCAN statement, LOAD FORMAT syntax option.

LOADMD=YES

Tells Log Master whether load output should include mass delete (LOADMD) records that are found in the scan range. Values for LOADMD are as follows:

  • YES—The Log Master load output includes mass delete (LOADMD) records that are found in the scan range. The default value is YES.

  • NO—The Log Master load output does not include mass delete (LOADMD) records that are found in the scan range.

Note

These records, when included in the load output, do not have the column values found in other records. You should account for such short records if the load output is used as input in any post Log Master processing, or if the output is used to load the data into target tables.

LOBALLOC=CYLINDERS

Specifies the units that Log Master uses to allocate LOB or XML VSAM files. Log Master creates these files to store data from LOB columns in selected log records. The default value is CYLINDERS, which specifies cylinders. Use the TRACKS keyword to specify tracks.

You can override the installation option value at runtime by specifying the LOBOPTS statement, CYLINDERS | TRACKS syntax option for LOB data, or the XMLOPTS statement, CYLINDERS | TRACKS syntax option for XML data.

LOBDATA=

Specifies a valid Data Facility Storage Management System (DFSMS) data class that Log Master uses to allocate LOB or XML VSAM files. Log Master creates these files to store data from LOB or XML columns in selected log records.

Specify any valid DFSMS data class.

Note

When one of the following conditions exists, you must specify a value for LOBDATA, LOBSTOR, or LOBVOLS:

  • You generate DDL in DB2 Version 10 new-function mode. (DB2 catalog changes require LOB processing to accommodate DDL for which text strings were moved to LOB columns.)

  • You use Log Master to process LOB column data in any version of DB2.

If you specify a value for LOBVOLS, do not specify a value for LOBSTOR or LOBDATA.

You can override this installation option value at runtime by specifying the LOBOPTS statement, DATACLAS syntax option for LOB data, or the XMLOPTS statement, DATACLAS syntax option for XML data.

LOBDUPDS=ERROR

Determines how Log Master responds to a duplicate data set condition as it attempts to create a LOB or XML VSAM file. This option determines the severity of the message that Log Master displays, and whether Log Master continues processing.

The following list shows the message severity classifications:

  • INFO—Specifies that Log Master issues an informational message, overwrites the existing file, and continues processing.
  • WARN—Specifies that Log Master issues a warning message, overwrites the existing file, and continues processing.
  • ERROR—Specifies that Log Master issues an error message, saves any temporary LOB or XML VSAM file files permanently to disk, and terminates processing. The default value is ERROR.

You can override the installation option value at runtime by specifying the LOBOPTS statement, DUPLICATE DATASET syntax option for LOB data, or the XMLOPTS statement, DUPLICATE DATASET syntax option for XML data.

LOBPREF=&&SYSUID..LOB

Specifies a prefix that Log Master uses in the names of LOB VSAM files. Log Master constructs the data set name by using this prefix, the database identifier (DBID) of the LOB column, the page set identifier (PSID) of the column, and a sequentially incremented data set number. To avoid duplicate data sets during repeated log scans, consider using symbolic values such as &DATE. and &TIME. in the prefix that you define.

Values for LOBPREF are as follows:

  • Any valid name up to 34 characters long.

  • A symbolic substitution (such as &SYSUID).

Note

If you use a symbolic substitution, such as &SYSUID, enter &&SYSUID in the actual option macro to prevent the assembler from flagging the definition as an error.

You can override the installation option value at runtime by specifying the LOBOPTS statement, PREFIX syntax option.

LOBLIMIT=10

Determines the maximum number of LOB or XML VSAM files that Log Master can create to store the LOB data of one LOB column (or one partition of one LOB column). Log Master allocates a new LOB or XML VSAM file only when it has filled the initial data set and all possible extents, but more LOB column data remains to be written. If the number of data sets required to store a LOB column’s data exceeds this limit, Log Master issues an error message, saves any temporary LOB or XML VSAM files permanently to disk, and terminates processing.

Specify a number of data sets between 1 and 26. The default value is 10.

You can override the installation option value at runtime by specifying the LOBOPTS statement, LOBLIMIT syntax option for LOB data, or the XMLOPTS statement, XMLLIMIT syntax option for XML data.

LOBMGMT=

Specifies a valid DFSMS management class that Log Master uses to allocate LOB or XML VSAM files. Log Master creates these files to store data from LOB or XML columns in selected log records. This option has no default value.

Specify any valid DFSMS management class.

You can override the installation option value at runtime by specifying the LOBOPTS statement, MGMTCLAS syntax option for LOB data, or the XMLOPTS statement, MGMTCLAS syntax option for XML data.

LOBSPACE=(10,10)

Specifies the primary and secondary amounts of space that Log Master uses to allocate LOB or XML VSAM files. Log Master creates these files to store data from LOB or XML columns in selected log records. This installation option works with the LOBALLOC option. The default values of LOBSPACE are 10 and 10. Allocation amounts can be either tracks or cylinders.

Allocation amounts are site specific. However, if you allocate insufficient space to store all of the LOB or XML data in the log records that are selected by a log scan, your Log Master job can fail with an allocation error.

You can override the installation option value at runtime by specifying the LOBOPTS statement, SPACE syntax option for LOB data, or the XMLOPTS statement, SPACE syntax option for XML data.

LOBSTOR=

Specifies a valid DFSMS storage class that Log Master uses to allocate LOB or XML VSAM data sets. Log Master creates these files to store data from LOB or XML columns in selected log records.

Specify any valid DFSMS storage class.

Note

When one of the following conditions exists, you must specify a value for LOBDATA, LOBSTOR, or LOBVOLS:

  • You generate DDL in any version of DB2. (DB2 catalog changes require LOB processing to accommodate DDL for which text strings were moved to LOB columns.)

  • You use Log Master to process LOB column data in any version of DB2.

If you specify a value for LOBVOLS, do not specify a value for LOBSTOR or LOBDATA.

You can override the installation option value at runtime by specifying the LOBOPTS statement, STORCLAS syntax option for LOB data, or the XMLOPTS statement, STORCLAS syntax option for XML data.

LOBVOLS=

Specifies the volumes that Log Master uses to allocate LOB or XML VSAM files. Log Master creates these files to store data from LOB columns in selected log records. Log Master uses the volumes that you enter in the VOLUMES parameter of a DEFINE CLUSTER command.

Specify any valid VOLSER as a value for LOBVOLS.

Note

When one of the following conditions exists, you must specify a value for LOBDATA, LOBSTOR, or LOBVOLS:

  • You generate DDL in DB2 Version 10 new-function mode. (DB2 catalog changes require LOB processing to accommodate DDL for which text strings were moved to LOB columns.)

  • You use Log Master to process LOB column data in any version of DB2.

If you specify a value for LOBVOLS, do not specify a value for LOBSTOR or LOBDATA.

You can override the installation option value at runtime by specifying the LOBOPTS statement, VOLUME syntax option for LOB data, or the XMLOPTS statement, VOLUME syntax option for XML data.

LOCCPSEL=(FC,LP,LB)

When running in a local site, specifies the order in which Log Master uses image copy resources for both completion processing and compression dictionary access for data decompression. The default sequence is IBM FlashCopy (FC), local primary (LP), and local secondary (LB). You can specify one to five values from FC, LP, LB, RP (remote primary), and RB (remote secondary) in the sequence in any order.

Note

 The image copy resources are registered in SYSCOPY and BMCXCOPY. FlashCopies are registered in SYSCOPY and are associated with the IBM DB2 COPY utility. Only one FC exists for a given table space/RBA.

LOGSORT=WHENEVER

Determines how Log Master will process DB2 log data sets from multiple members of a DB2 data sharing group. Values for LOGSORT are as follows:

  • WHENEVER—Directs Log Master to use the value of the LOGTAPES installation option to determine whether to sort the DB2 log data sets. If you specify this value, Log Master always uses the LOGTAPES value, regardless of the type of storage device on which the log data sets are stored. The LOGSORT option and the LOGTAPES option work together. For a description of their interaction, see LOGSORT. The default value is WHENEVER.
  • NEVER—Directs Log Master to avoid sorting the log. Log Master processes all log data sets concurrently. When this installation option is NEVER, Log Master ignores any LOGTAPES value and allocates as many units as it needs to perform a merge (not a sort) action. Depending on the number of data sharing members and the number of tape units in your environment, this value can cause contention for tape units.
  • ALWAYS—Directs Log Master to always sort the log. Log Master does not attempt to process multiple log data sets concurrently.

You can override the installation option value at runtime by specifying the LOGOPTS statement, LOGSORT syntax option.

LOGTAPES=0

Specifies the maximum number of tape units or DASD data sets that Log Master allocates for reading log files. LOGTAPES does not limit the number of physical tape devices that Log Master can use, only the number of tape units that Log Master allocates for log processing at any one time. The default value is zero.

Log Master allocates the value that you specify or a value equal to the number of members in the data sharing group, whichever value is less.

This installation option applies only in a data sharing environment. When the LOGSORT installation option is set to NEVER, Log Master ignores any LOGTAPES value. This option interacts with the LOGSORT value in other ways as well. For more information about how the options work together, see LOGSORT.

Note

LOGTAPES is ignored if DB2 log files to be read are DASD files, or the number of actual tape units is not greater than the LOGTAPES value in a subsystem with mixed tapes/DASD log files.

Values for LOGTAPES are as follows:

  • nnnn—Any numeric value between one and the total number of tape drives that are accessible to the system.
  • 0—Log Master sets LOGTAPES to the number of members within the data sharing group. The default value is 0.

You can override the installation option value at runtime by specifying the LOGOPTS statement, LOGTAPES syntax option.

LRPCT=40

Specifies the percentage of key store memory that is allocated to the log record (LR) key store. Enter an integer value between 1 and 99. For more information about specifying all xxPCT installation option values, see the considerations cited in the description of the URPCT=20 installation option.

In the LR key store, Log Master maintains a copy of log records that require row completion processing. The default value is 40.

Before changing the distribution of key store memory, see STOREOPTS statement, MEMPERCENT syntax option.

MIGRATE=YES

Directs Log Master to request your storage management software to migrate any recalled data sets to their original status. Log Master issues migrate requests at the end of a log scan or when a job requires a greater number of data sets than the DASDDSNS value. Values for MIGRATE are as follows:

  • YES—Directs Log Master to issue migrate requests. The default value is YES.
  • NO—Prevents Log Master from issuing migrate requests (unless the DASDDSNS value is exceeded).

The DASDDSNS value defines limits for this installation option. If a job requires more data sets than the DASDDSNS value permits, Log Master migrates data sets even when this installation option is set to NO.

Log Master always attempts to migrate the data set back to its original migration level. The Log Master data set migration feature can migrate only data sets that are managed by the IBM product DFSMShsm. (The related early recall feature works with most storage management software.)

Before you enable migration of recalled data sets, evaluate the settings of the SMSTASKS, ERLYRCL, and DASDDSNS options to ensure that they are appropriate for your environment.

You can override the installation option value at runtime by specifying the OPTION statement, MIGRATE syntax option.

MIGRWAIT=NO

Determines whether Log Master terminates at the end of processing, or waits for data set migration requests to complete. Values for MIGRWAIT are as follows:

  • YES—Indicates that your Log Master job does not terminate until all data set migration requests are complete.
  • NO—Indicates that your Log Master job terminates at the end of processing, regardless of the status of any data set migration requests. The default value is NO.

You can override the installation option value at runtime by specifying the OPTION statement, WAIT syntax option.

MINLOGPT=NO

Specifies how Log Master determines the log scan end point when it runs in a data sharing environment. Set this installation option to YES to obtain the same end point across all members of the data sharing group. This installation option applies only in a data sharing environment.

Values for MINLOGPT are as follows:

  • NO—Indicates that Log Master does not require a common end point for all members. Log Master uses the end point that you specify. The default value is NO. When you run an ongoing log scan in a data sharing environment, Log Master dynamically sets the value of this option to YES (regardless of the value that you specify).
  • YES—Indicates that Log Master requires a common end point for all members of the data sharing group. A common end point is important for ongoing log scans, where Log Master requires common end points and start points to select all desired log records across multiple runs.

    For each member, Log Master determines an end point based on the logging activity for that member. Log Master then uses the earliest end point found on any member of the data sharing group.

    The following figure shows the end points that Log Master selects depending on the value of MINLOGPT. Note that when MINLOGPT is YES, Log Master selects only some of the log records on MEMBER01 and does not select any of the log records on MEMBER03. If the log scan is an ongoing log scan, subsequent runs select the log records omitted during this run

    MINLOGPT Options flow


You can override the installation option value at runtime by specifying the OPTION statement, MINLOGPT syntax option.

MTPRMBR=NO

Specifies the scope of the SMSTASKS value. This installation option applies only in a data sharing environment. Values for MTPRMBR are as follows:

  • YES—Indicates that your SMSTASKS value applies to each member of a data sharing environment. If you specify YES, and the SMSTASKS value is currently set to zero, and the following conditions apply:
    • Log Master runs in a non-data sharing environment, Log Master sets SMSTASKS to one
    • Log Master runs in a data sharing environment, Log Master sets SMSTASKS equal to the number of members in the data sharing group
  • NO—Indicates that your SMSTASKS value applies to the entire data sharing group. The default value is NO.

You can override the installation option value at runtime by specifying the OPTION statement, PER MEMBER syntax option.

OPNDB2ID=YES

Determines how Log Master opens the data sets that DB2 addresses directly (such as the VSAM files that contain table spaces and the archive log files). Values for OPNDB2ID are as follows:

  • YES—Log Master uses the ID of the DB2 DBM1 address space as defined in Resource Access Control Facility (RACF) instead of using the RACF ID of the user who is running the product.
  • NO—Log Master uses the ID of the user who is running the product to access DB2 data sets (such as table space files and log files). The ID must have the proper access to all required DB2 objects.

For more information, see RACF authority.

OSRCHCNT=3

Determines how Log Master responds if the user running the online interface does not enter a log file name when specifying DB2 log data sets. This installation option applies only to the online interface, and only in a data sharing environment.

This option determines how many members of the data sharing group Log Master searches for eligible log files. Depending on the OSRCHCNT value, Log Master displays a list of eligible log file names for each member of the data sharing group. The user running the online interface can then select log files. The default value is 3. Use the following guidelines when specifying a value for OSRCHCNT:

  • If the value is less than or equal to the number of members in the data sharing group, Log Master lists the eligible log file names for each data sharing member.

  • If the value is greater than the number of members in the data sharing group, Log Master does not list the eligible log file names.

PARMSTOR=

Specifies a valid Data Facility Storage Management System (DFSMS) storage class that Log Master uses for dynamic allocation of data sets other than sort work data sets. This option does not have a default value. Do not specify a value of VIO for this option.

You can override the installation option value at runtime by specifying the SORTOPTS statement, PARMOPTS STORCLAS syntax option.

PARMUNIT=

Specifies a unit name that Log Master uses for dynamic allocation of data sets other than sort work data sets. Specify any unit name where you can allocate temporary data sets. This option has no default value. If you do not specify a value, the storage management software in your environment uses its default values.

You can override the installation option value at runtime by specifying the SORTOPTS statement, PARMOPTS UNIT syntax option.

PLANALPB=ALPBvvr

Specifies the batch execution DB2 plan for Log Master. The default value is ALPBvvr, where vvr represents the version and release level of Log Master. You can specify any valid DB2 plan name.

PLANALPO=ALPOvvr

Specifies the online interface DB2 execution plan for Log Master. The default value is ALPOvvr, where vvr represents the version and release level of Log Master. You can specify any valid DB2 plan name.

PLANESQL=ALP

Specifies either a prefix or an eight-character plan name that Log Master uses to execute generated SQL. Log Master invokes the DB2 BIND command to create the actual plan dynamically before executing any generated SQL. The default value is ALP. Other valid values for PLANESQL are as follows:

  • Plan name prefix (1-7 characters)—If you choose to specify a prefix, Log Master dynamically binds and frees the plan when the job starts and ends. Log Master interprets any character string from one to seven characters long as a plan prefix.
  • Plan name (8 characters)—If you use a plan name that is eight characters long, Log Master binds the plan each time a job is run, but does not free the plan. This enables a user with BINDADD authority to create the selected plan, and allows other users to execute under this plan if they have BIND REPLACE authority for the plan.

You can override the installation option value at runtime by specifying the EXECSQL statement, PLAN NAME syntax option.

PUBLICPLAN=YES

Determines whether Log Master grants the authority to run Log Master (execute against the Log Master base plan) to PUBLIC. Use this option to avoid specific grants of authority to individual users. Valid values include:

  • YES—Log Master grants EXECUTE authority to PUBLIC. All users have authority to run Log Master. The default value is YES, and BMC Software recommends that you use this value.
  • NO—Log Master avoids granting EXECUTE authority to PUBLIC. You must grant EXECUTE authority to specific users as required.

QUIESCEAGING=–1

Excludes members of a data sharing subsystem from being considered during processing if they have been quiesced. This prevents Log Master from accessing BSDS and log data set information from long dormant members.

If QUIESCEAGING is set to –1 (the default value), Log Master does not exclude quiesced members. If QUIESCEAGING is set to any other value, Log Master subtracts that number of days from the current date and time for comparison with the timestamps of quiesced members.

Do not select a value that excludes members whose log data might be required during LOGSCAN or row completion processing.

Note

 If member DSG3 was quiesced four days ago but you are using an image copy from six days ago for row completion processing, excluding DSG3 could result in completion errors.

You can override the installation value at runtime by specifying QUIESCE AGING  on the OPTION statement.

REBUILD=NO

Determines the keyword that Log Master includes in the recovery syntax that it generates as part of an automated drop recovery job step. To accomplish a drop recovery, Log Master creates syntax for the BMC Next Generation Technology Recover for DB2 for z/OS product. NGT Recover supports two keywords for recovering indexes.

Values for REBUILD are as follows:

  • NO—Indicates that Log Master includes the RECOVER INDEX keyword in the NGT Recover syntax. The default value is NO.
  • YES—Indicates that Log Master includes the REBUILD INDEX keyword in the NGT Recover syntax.

REMCPSEL=(RP,RB,FC)

When running in a remote site, specifies the order in which Log Master uses image copy resources for both completion processing and compression dictionary access for data decompression. The default sequence is remote primary (RP), remote secondary (RB), and IBM FlashCopy (FC). You can specify one to five values from FC, LP (local primary), LB (local secondary), RP, and RB in the sequence in any order.

Note

The image copy resources are registered in SYSCOPY and BMCXCOPY. FlashCopies are registered in SYSCOPY and are associated with the IBM DB2 COPY utility. Only one FC exists for a given table space/RBA.

RESINV=0K

Specifies the amount of memory (below the 16-MB line) that Log Master instructs the sort routine to reserve for processing other than sort processing.

BMC Software recommends that you always specify this parameter as zero (the default value). This action allows Log Master to use default values to allocate sort memory. You can enter a value as a number of bytes, kilobytes (using the suffix K), or megabytes (using the suffix M).

You can override the installation option value at runtime by specifying the SORTOPTS statement, RESINV syntax option.

RETAINTIME=ALL

(PTF BQU2282 applied)

Specifies the number of days that Log Master keeps ongoing and history records in the Repository tables for a specified work ID.

Values for RETAINTIME are as follows:

  • ALLLog Master bypasses record deletion and retains all records in the ongoing and history Repository tables for a specified work ID.
  • NONELog Master deletes all records in the ongoing and history Repository tables for a specified work ID..
  • Numeric value between 1 and 32767Log Master deletes records that are older than n days from the ongoing and history repository tables for a specified work ID. Valid numeric value for n are 1 through 32767.

The RETAINTIME installation option is applied only when:

  • WORKID and LOGSCAN statements are defined
  • The REPOS DELETE statement is not defined
  • The LOGSCAN statement includes an ONGOING HANDLE, in which case the option is applied only to the ongoing Repository table.

This option applies to the ongoing Repository table named ALPURID and to the following history Repository tables:

  • ALPWHIS
  • ALPWLSH
  • ALPRPTF
  • ALPLOGF
  • ALPSQLF
  • ALPDDLF
  • ALPCMDF
  • ALPLODF
  • ALPADRF

Note

You can override the installation option value at runtime by specifying the OPTION statement, RETAIN TIME option.

SMCORE=0M,0K

Specifies the maximum amount of memory that the sort routine can use. The SMCORE installation option requires you to specify two values:

  • The first value specifies the total amount of memory that is used both below and above the 16-MB line.

  • The second value specifies only the amount of memory that is used below the 16-MB line.

You can enter either value as a number of bytes, kilobytes (using the suffix K), or megabytes (using the suffix M).

BMC recommends that you specify zero for both SMCORE values (as 0M or 0K). This action specifies the Log Master default values (currently 6M, 384K if a FILSZ value is not specified) for the amount of storage to allocate above and below the 16-MB line.

If FILSZ estimate syntax is coded under SORTOPTS, Log Master determines the default SMCORE values by using the minimum storage required by BMCSORT when all of the following conditions exist:

  • You accept the default values of 0 for the SMCORE installation option.

  • You specify a value for the FILSZ keyword in the SORTOPTS statement.

  • You do not specify SMCORE values in the SORTOPTS statement.

The value of the SMCORE option affects the performance of Log Master sort actions. To further affect the performance of sort actions, you can also do the following:

You can override either installed SMCORE value at runtime. For more information, see SORTOPTS statement, SMCORE syntax option.

SMSTASKS=0

Limits the number of early recall subtasks that Log Master creates. Use this installation option to optimize performance when log processing requires large numbers of migrated files.

Enter a maximum number of subtasks. To allow Log Master to determine the number of subtasks, enter 0 (the default value). When you specify 0, Log Master sets the SMSTASKS value as follows:

  • In a non-data sharing environment, Log Master sets SMSTASKS to 1.

  • In a data sharing environment, Log Master sets SMSTASKS equal to the number of data sharing members.

You can override the installation option value at runtime by specifying the OPTION statement, SMSTASKS syntax option.

SORTDYN=USE

Indicates whether Log Master uses the sort routine’s dynamic allocation rules or allows a user to specify allocation characteristics. Values for SORTDYN are as follows:

  • USE—This value allows a user to override the sort routine’s dynamic allocation of space that is used for sort work data sets. The default value is USE.
  • SYSTEM—This value indicates that the sort routine always determines the dynamic allocation of space that is used for sort work data sets.

You can override the installation option value at runtime by specifying the SORTOPTS statement, SORTDYN syntax option.

TAPES=(tape device name list)

Specifies the tape device names of data sets that Log Master allocates for reading log files. Enter a list of valid tape device names and separate multiple names with commas. The default values are CART and TAPE.

Note

LOGTAPES is ignored if DB2 log files to be read are DASD files, or the number of actual tape units is not greater than the LOGTAPES value in a subsystem with mixed tapes/DASD log files.

TRCHARS=>>

Specifies the character string that Log Master uses to indicate truncated DB2 object names within the online interface. When DB2 object names are longer than the fields that you use to view or edit them, Log Master initially displays truncated versions of the names. These characters identify truncated names and mark the position of the truncated portion. To display the complete DB2 object names, position the cursor in a field and press F4.

Enter a string up to 8 characters long. The default value is >>.

TRPOS=END

Defines which part of DB2 object names Log Master truncates for display within the online interface. When DB2 object names are longer than the fields that you use to view or edit them, Log Master initially displays truncated versions of the names. Use this installation option to include the meaningful or unique parts of DB2 object names in the truncated names, depending on the object naming standards in your environment. Values for TRPOS are as follows:

  • BEGIN—Log Master truncates the start of DB2 object names and displays the ending characters of the names.
  • MIDDLE—Log Master truncates the middle part of names and displays both the start and end of DB2 object names.
  • END—Log Master truncates the end of DB2 object names and displays the starting characters of DB2 object names. The default value is END.

TZRULE=NONE

Defines the rule to determine when DST begins and ends, enabling Log Master to calculate the dates and times for the changes each year.

This installation option enables Log Master to adjust day and time values when you run Log Master after a DST change, but scan log records that are from a period before the time change, which is called scanning across a DST boundary.

The default value, NONE, indicates that your locale does not observe DST or that you do not want Log Master to make adjustments for DST. To enable DST adjustment, you must define day and time values as a character string in the following format, including quotation marks:

'startDayRule/time,endDayRule/time'
Specifying TZRULE

This section describes valid formats for specifying TZRULE. In all formats, each time field describes the local time in effect when the change from one time to the other occurs. Enter the time in the format hh[:mm[:ss]]. The value is always interpreted as a decimal number. The hour (hh) is required and must be a value between 0 and 23. The minutes (mm) and seconds (ss) are optional and can be a value between 0 and 59.

  • M m.n.d—This is the standard format for most countries. Using this format, specify the month, week, and day of the week on which DST begins and ends, as follows:
    • The variable m represents the month; valid values are 1 through 12 (January through December).

    • The variable n represents the week of the month in which the day d occurs; valid values are 1 through 5. Week 1 is the first week in which day d occurs, and week 5 specifies the last d day in the month.

    • The variable d represents the day; valid values are 0 through 6 (Sunday through Saturday).

    In the following example, DST begins on the second Sunday of March at 2:00 a.m., and ends on the first Sunday of November at 2:00 a.m.:

    TZRULE='M3.2.0/2,M11.1.0/2'

    The default conversion time is 2:00 a.m.; therefore, the following example, which omits the time specification, is also valid:

    TZRULE='M3.2.0,M11.1.0'
  • n—Specify the zero-based Julian day n, where n is a value from 0 through 365. In this format, leap days are counted, and you can refer to February 29.

    In the following example, DST begins on April 1 (leap years), or April 2 (nonleap years) at 12:34:56 p.m., and ends on November 1 at 2:34:56 a.m.:

    TZRULE='91/12:34:56,305/2:34:56'
Considerations for DST adjustment

To understand DST adjustment, remember that Log Master uses the operating system to translate date and time values into the operating system’s store clock format. For example: assume that you are in the northern hemisphere, you run Log Master in May (after the change to DST), and you define a scan range from 15:00 to 16:00 on February 14 (before the time change).

  • If you set TZRULE to enable adjustment, Log Master knows that the time zone offset in May is different from the time zone offset that was used when DB2 wrote the log records in February (the difference is one hour). Log Master adjusts for this difference, selects log records from 15:00 to 16:00 on February 14, and prints the time values of those records in reports starting with 15:nn.

  • If you do not set TZRULE to enable adjustment, Log Master uses the time zone offset for May. Because the offset was different in February, Log Master selects log records from 14:00 to 15:00 on February 14, and prints the time value of those log records in reports starting with 15:nn. The discrepancy in the time zone offset creates a discrepancy between the log records that you request and the log records that Log Master provides in output.

Be aware of the following additional points regarding DST adjustment and the TZRULE installation option:

  • Log Master provides adjustment because the operating system does not account for changes in the time zone offset that have occurred in the past. The operating system always uses the current time zone offset when it converts a date and time value into store clock format.

  • By default, adjustment is not enabled. To enable it, set the TZRULE installation option value.

  • The options migration feature of the Installation System cannot carry over DST installation option values from a previous release of Log Master. You must provide a value for TZRULE if you want to enable DST adjustment.

  • You might not need DST adjustment. Without adjustment, a difference of one hour occurs when you scan across a DST boundary. If you define scan ranges in terms of days or weeks, the one-hour difference might not be significant.

  • Log Master adjusts only date and time values that you enter as you define a scan range. The discrepancies do not occur (and Log Master does not adjust values) when you define a scan range with RBA/LRSN values or log mark names.

  • Adjustment can compensate for one-hour changes for DST if your environment adjusts the operating system’s clock by exactly one hour.

    If your environment adjusts the operating system’s clock in increments other than one hour, and you do not set the option to enable automatic adjustment, Log Master might experience discrepancies in selecting log records. You can avoid the discrepancies by using log mark names or RBA/LRSN values to define your scan range. If you are aware of the time changes in your environment, you can also adjust accordingly the date and time values that you enter.

  • Adjustment affects only how Log Master handles the standard timestamp values that DB2 stores in all log records (using the operating system’s store clock format). Adjustment does not affect any DATE, TIME, or TIMESTAMP columns that you define in your database, nor does it affect any column-level filtering.

ULOGORD=ASCENDING

Specifies the order in which Log Master reads any DB2 log files that you explicitly define. (To explicitly define log files, use the DB2LOG keyword of the INPUT statement.) Log Master can read the log files in the order that you specify, or it can reverse your order (reading the last-specified log file first). The default value is ASCENDING.

Values for ULOGORD are as follows:

  • ASCENDING—Log Master reads log files in the order in which you specify them with the INPUT DB2LOG keyword. When ULOGORD is ASCENDING, you must list the DB2 log files in order, from lowest RBA/LRSN value to highest. For example, three DB2 log files in sequence from the lowest RBA/LRSN value to highest are LOGFILE01, LOGFILE02, and LOGFILE03. If the ULOGORD value is ASCENDING, the correct order in the INPUT statement is as follows:

    INPUT DB2LOG (LOGFILE01, LOGFILE02, LOGFILE03)
  • DESCENDING—Log Master reads log files starting with the last file that you specified and reads in reverse order. When ULOGORD is DESCENDING, you must list the DB2 log files from highest RBA/LRSN value to lowest. For example, three DB2 log files in sequence from the lowest RBA/LRSN value to highest are LOGFILE01, LOGFILE02, and LOGFILE03. If the ULOGORD value is DESCENDING, the correct order in the INPUT statement is as follows:

    INPUT DB2LOG (LOGFILE03, LOGFILE02, LOGFILE01)

    Log Master expects to read log files from the lowest RBA/ LRSN value to the highest. Therefore, if you specify a list of log files that is not in RBA/LRSN order after Log Master applies the ULOGORD setting, you might encounter errors.

UNITWAIT=YES

Determines whether Log Master sets the z/OS allocation flags to direct the operating system to wait for allocation to occur in the event of an unavailable unit, volser, or data set, or immediately fail allocation.

Values for UNITWAIT are as follows:

  • NO—Directs Log Master to immediately fail allocation.
  • YES—Directs Log Master to wait for the required resources to become available. The default value is YES.

URIDTHR=0

Specifies the maximum number of data changes that Log Master processes within one unit of work, as represented by one unit of recovery identifier (URID). In this context, a data change is an insert, update, or delete action that affects one or multiple rows in a database. When a change affects multiple rows, Log Master counts one change for each affected row.

Use this installation option to limit the negative results that can occur when a URID contains an excessive number of data changes. Use this installation option only if you experience such negative results.

When Log Master scans a URID that contains an extremely large number of data changes, Log Master can require more memory than is available, and perform poorly or terminate abnormally. The point where these results occur depends on factors in your environment, such as the amount of memory that you allocate to Log Master or the size of your log records. Values for URIDTHR are as follows:

  • 0—Log Master processes any number of data changes, and does not check for a threshold value. The default value is 0.
  • nnnn—Log Master checks the number of data changes within any single URID against the value that you enter. If the number of changes exceeds your threshold value, Log Master takes the following actions:
    • Issues a warning message
    • Ignores any remaining data changes within the current URID
    • Continues processing the next URID

If Log Master ignores data changes within a URID, it might not be able to complete all of the log records that it requires. When Log Master cannot complete all log records, it terminates with an error message.

Note

To help you detect URIDs that contain large numbers of changes, Log Master does not honor the URIDTHR installation option value when it generates an Object Activity Summary report.

You can override the installation option value at runtime by specifying the OPTION statement, URID THRESHOLD syntax option.

URPCT=20

Specifies the percentage of key store memory that is allocated to the URID (UR) key store. Enter an integer value between 1 and 99. The default value is 20.

In the UR key store, Log Master maintains information about each unit of recovery that it encounters within the range of a log scan.

Before changing the distribution of key store memory, see STOREOPTS statement, MEMPERCENT syntax option.

Considerations for all xxPCT values:

  • All xxPCT values represent percentages of the total amount of key store memory (for more information, see KSMEMORY=100M, 10M). The percentage values of the xxPCT installation options (URPCT, LRPCT, FCPCT, BCPCT, and ANPCT) must add up to 100 percent, including any default values that you do not specify explicitly. To avoid confusion, specify a value for all xxPCT options even if you are not changing the default value.

  • When a job reads input from a logical log file, Log Master redistributes all available key store memory to the UR key store, regardless of your specifications. Log Master takes this action because it does not require the other key stores to process logical log input.

USELGRNG=NO

Indicates whether Log Master uses the SYSIBM.SYSLGRNX tables to determine the ranges for a log scan. Use this installation option only in a data sharing environment. Log Master can use the SYSLGRNX tables during the initial log scan to determine whether the DB2 log of a data sharing member contains information about your selected database objects. Log Master reads the SYSLGRNX table only when a WHERE clause or filter refers to specific DB2 objects (columns, tables, table spaces, or databases).

Values for USELGRNG are as follows:

  • NO—Indicates that Log Master does not use the SYSLGRNX tables to determine valid ranges for a log scan. The default value is NO.
  • YES—Indicates that Log Master uses the SYSLGRNX tables to determine valid ranges for a log scan.

You can override the installation option value at runtime by specifying the OPTION statement, USELGRNG syntax option.

USELOGS=(ACT1,ACT2,ARCH1,ARCH2)

Specifies the order in which Log Master reads active and archive log files. For all log scans, Log Master searches the log files in the order that you enter. Specify log keywords in any order. Omit keywords for log files that you do not want Log Master to consider. If you omit keywords, Log Master can terminate with error messages if it cannot find required log records in the log files that you have specified. The default order is ACT1, ACT2, ARCH1, and ARCH2.

You can override the installation option value at runtime by specifying the OPTION statement, RESOURCE SELECTION LOGS syntax option.

Values for USELOGS are as follows:

  • ACT1—Indicates the primary active log file.
  • ACT2—Indicates the dual (secondary) active log file.
  • ARCH1—Indicates the primary archive log file.
  • ARCH2—Indicates the dual (secondary) archive log file.

USEUTILITYDELETES=YES

Specifies whether Log Master should process and use the delete record logged by the DSNUTILB utility when invoked by the DB2 LOAD or REPAIR utilities or by the EXEC SQL statement.

  • YES—Directs Log Master to process and use the delete records logged by the DSNUTILB utility.
  • NO—Directs Log Master to ignore delete records logged by the DSNUTILB utility.

You can override the installation option value at runtime by specifying the OPTION statement, USE UTILITY DELETES syntax option.

UTILPLNS=

Specifies the plan names of any third-party DB2 load or reorganization utilities. If Log Master knows the plan names of these utilities, it can recognize and process log records that they create.

If your environment uses third-party load or reorganization utilities, enter the plan names for the utilities. For the BMC Software LOADPLUS for DB2 product and the REORG PLUS for DB2 product, use the value of the PLAN installation option. The default value of PLAN is PPPvvrm, where PPP represents the product code (AMU or ARU), vv represents the version level, r represents the release level, and m represents the maintenance level of the product.

This option has no default value. If you do not enter the plan names for these utility products, Log Master does not interpret their log records.

WKSTOR=

Specifies a valid DFSMS storage class that Log Master uses for dynamic allocation of large temporary files and sort work data sets. This option has no default value.

Specify any valid DFSMS storage class.

You can override the installation option value at runtime by specifying the SORTOPTS statement, WORKOPTS STORCLAS syntax option.

WKUNIT=

Specifies the unit name that Log Master uses for dynamic allocation of sort work data sets. Specify any unit name where you can allocate temporary DASD data sets. This option has no default value. If you do not specify a value, the storage management software in your environment uses its default values.

Specify any valid unit.

You can override the installation option value at runtime by specifying the SORTOPTS statement, WORKOPTS UNIT syntax option.

WORKNUM=0

Specifies the number of sort work data sets that Log Master uses. The default value is 0, which indicates that the number of data sets is set dynamically by the sort routine. You can specify any number from 1 to 255.

You can override the installation option value at runtime by specifying the SORTOPTS statement, WORKOPTS NUM syntax option.

XMLPREF=&&SYSUID..XML

Specifies a prefix that Log Master uses in the names of XML VSAM files. Log Master constructs the data set name by using this prefix, the database identifier (DBID) of the XML column, the page set identifier (PSID) of the column, and a sequentially incremented data set number. To avoid duplicate data sets during repeated log scans, consider using symbolic values such as &DATE. and &TIME. in the prefix that you define.

Values for XMLPREF are as follows:

  • Any valid name, up to 34 characters long

  • A symbolic substitution (such as &SYSUID)

Note

If you use a symbolic substitution, such as &SYSUID, enter &&SYSUID in the actual option macro to prevent the assembler from flagging the definition as an error.

You can override the installation option value at runtime by specifying the XMLOPTS statement, PREFIX syntax option.

ZIIP=ENABLED

Controls whether Log Master attempts to use IBM System z Integrated Information Processors (zIIPs). Log Master 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 Log Master jobs. To enable and use zIIP processing with Log Master, the following conditions must exist:

  • You must have an installed and authorized version of the EXTENDED BUFFER MANAGER (XBM) product or the SNAPSHOT UPGRADE FEATURE (SUF) technology

  • You must start and maintain an XBM subsystem in your environment

  • You must have a zIIP available in your environment

For more information about the XBM component that enables the use of zIIPs, see the SNAPSHOT UPGRADE FEATURE for DB2 documentation .

Values for zIIP are as follows:

  • ENABLED—If a zIIP is available, Log Master attempts to offload eligible processing to the zIIP. If the zIIP is busy or not available, normal processing continues on a general-purpose processor. The default value is ENABLED.
  • DISABLED—Log Master will not attempt to use zIIP processing.

You can override the installation option value at runtime by specifying the OPTION statement, zIIP syntax option.

Was this page helpful? Yes No Submitting... Thank you

Comments