Reference: BJTCFG configuration parameters

Configuration value hierarchy

Because some values can be specified for multiple subsystem configurations (different subsystem names and subsystem types), it is important to consider which values take precedence. When a value is specified for more than one subsystem configuration, the value for the more-specific configuration is used first. The value used is based on the following hierarchy:

Values for more-specific configurations always take precedence over values specified for less-specific configurations: even when the more-specific value is blank. If a parameter is specified with a blank value, the default is used. This means that if you specify a parameter with a blank value in a "named subsystem / specific subsystem type" configuration, and you specify that same parameter with a specific value in a generic configuration (* subsystem name, and * subsystem type), the default value will be used because the more-specific configuration takes precedence. If you want to use the value specified in a more generic configuration, completely omit the parameter from the more-specific configurations.

When configuration changes are applied

Output Manager configuration parameters

USE_DISTRIBUTION_LIST_PRINTER [YES|NO]

Specifies whether or not to use the printer associated with the distribution list when capturing report-level dynamic printer attributes. This parameter only controls the capture of the report-level dynamic attributes.

YES – When capturing the report-level dynamic printing parameters, use the distribution list printer. If the distribution list printer is not defined, use the report printer.

NO – When capturing the report-level dynamic printing parameters, use the report printer if it is defined. NO is the default option.

• Required: No. If not specified, the default is used.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: NO

DEFAULT_OUTPUT_CLASS A

Establishes a default SYSOUT class for reports that are printed by Output Manager when the class is missing from the printer or the recipient definition. If a print file is generated without a class, the DEFAULT_OUTPUT_CLASS value is used. If this parameter is not specified, the default class for print files is class A. A valid class value is one alphanumeric character, A-Z or 0-9.

• Required: No. If not specified, the default is used.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: A

DEFAULT_ARCHIVE_CHARSET charset

This optional parameter is used to support foreign code page conversion to UTF-8. Specify the character set (charset) to assume for archive data sets if there is no other information in the archive data set or history database that is more specific. USA English sites do not need this option, the default code set is sufficient. Set the argument to the code page for your local language environment.

• Required: No.
• Relevant subsystem types: ITOMWeb, and * (default subsystem)
• Default value: 1047

ISPF_OUTPUT_CLASS

Used for troubleshooting, this parameter specifies an output class for capturing trace information when a problem is being analyzed. Specify an output class that does not immediately discard what is written to it. The default, *, writes to the output class that is assigned by default in your system configuration.

• Required: No.
• Relevant subsystem types: ISPF, and * (default subsystem)
• Default value: *

PRINT_PDS ?SAMPHLQ?.SBJTSAMP

This required parameter specifies the data set name of the library that contains the Output Manager JCL for printing, re-printing, and bundle printing (BJT@PRAP, BJT@PBN1, and BJT@PBN2). During customization, it was recommended to leave these members in the library that contains all of your customized SBJTSAMP members: ?BJTHLQ?.SBJTSAMP. If you moved these members to a different library, specify that library.

• Required: Yes
• Relevant subsystem types: ISPF, STC, and * (default subsystem)
• Default value: None

DEFAULT_BANNER_PAGE BJT.BANNER.PDS.NAME(MEMBER)

Use this parameter to specify the default banner page to be used when batch printing archives via the 'PJ' line command from the Archived Reports panel. Specify the data set name and member name of the banner as the parameter value.

• Required: No
• Relevant subsystem types: ISPF, ITOMWeb, and * (default subsystem)
• Default value: None

IGNORE_BLANK_LINES [YES|NO]

Specifies whether or not to ignore blank lines while line counting when matching data for custom reports with the layout and for index value generation. When YES is specified, all carriage control that skips lines will only count as a single line if it contains printable data. If the line is blank, it will not be counted. When NO is specified, blank lines are included in the line count.

• Required: No
• Relevant subsystem types: STC
• Default value: NO

DESCRIPTOR_CODE and ROUTE_CODE

The write-to-operator (WTO) descriptor and route code for issuing WTO messages.

• Required: No
• Relevant subsystem types: Can be specified only in generic "*" subsystem name and type (*/*)
• Default value: None

Security configuration parameters

SAF_CLASS [FACILITY | XFACILIT]

Specify the SAF class used by RACF®. Valid values include FACILITY or XFACILIT.

• Required: Yes
• Relevant subsystem types: Can be specified only in generic "*" subsystem name and type (*/*)
• Default value: FACILITY

REPORT_ACCESS_ID user_ID

Specify this optional parameter to enable Report Access ID security, and identify an external security user ID to be temporarily used when a user elects to view or print a report. The user ID specified will access the underlying archive data set(s) when a user requests a report associated with an archive (rather than the RACF user ID of the user). The user ID will then switch back to the original user ID after the data has been accessed. Because it is the temporary user ID that accesses the underlying archive data set(s), individual user IDs do not need access to these data set(s). This feature can be used to allow users to access reports based on archives inside of Output Manager, while preventing users from accessing the underlying archives the reports are based on outside of Output Manager. Your security product will prevent users from browsing the archives.

The user ID specified for the REPORT_ACCESS_ID must have access authority to the underlying archive data set(s).

The recommended value for this parameter is: REPORT_ACCESS_ID user_ID STCUSERID, where STCUSERID is the user ID that the Output Manager started task runs under. It is also recommended that this user ID is granted full access to the Output Manager archive data sets.

• Required: No.
• Relevant subsystem types: * (default subsystem) only
• Default value: None
  Note: If REPORT_ACCESS_ID user_ID is specified and you are using the ISPF interface to access reports, you must specify a non-zero value for ARA_PORT and recycle the started task and the ISPF address spaces prior to viewing reports.

VARCHIVE [ALL | NOREPORT]

This parameter globally controls which archives are presented to the user when they open the View Archives panel: either all archives, or only archives that do not have associated reports. When ALL is specified, all archives (based on the current search criteria) are displayed. When NOREPORT (the default) is specified, only archives that do not have any reports based on the archive are displayed. This parameter does not override permission privileges determined by RACF profiles.

• Required: No. If not specified, the default is used.
  Note: This may only be specified in the hte */* policy.
• Relevant subsystem types: Can be specified only in generic "*" subsystem name and type (*/*)
• Default value: NOREPORT

ARCFILTER [ENABLE|DISABLE]

When ENABLE is specified, the list of archives that a user sees is limited by their list of Archive Access IDs (defined in their Output Manager recipient ID). If any of the user’s Archive Access IDs match an archive name, either generic, or fully-qualified, that user can view that archive.

When DISABLE is specified, the list of archives that a user sees is not filtered by Archive Access IDs. Archive Access IDs do not need to be defined if ARCFILTER is set to DISABLE.

• Required: No.
• Relevant subsystem types: Can be specified only in generic "*" subsystem name and type (*/*)
• Default value: DISABLE

Dynamic printing configuration parameters

DYNAMIC_PRINTER_ATTRIBUTE_CAPTURE [DEFINED | ALL | ARCHIVES | REPORTS]

(Optional) Controls whether or not dynamic printing attributes are captured for archives, reports, or both.

• DEFINED: Capture the dynamic printing parameters only when Dynamic Print is set to YES (for archives) or REPORT (for reports) for that archive or report. For archives, dynamic print is set in the associated archive attribute; for reports, it is set is in the report definition.
• ALL : Capture the dynamic printing parameters for all archives and all reports, regardless of how the Dynamic Print field is set in the individual archive attributes and report definitions.
• ARCHIVES: Capture the dynamic printing parameters for all archives, and for any reports that are based on a report definition in which the Dynamic Print field is set to Report.
• REPORTS: Capture the dynamic printing parameters for all defined reports, and for any archives that are based on a set of archive attributes in which the Dynamic Print field is set to Report.

Dynamic printing parameters include the JCL parameters CLASS, DEST, FCB, FORMDEF, FORMS, PAGEDEF, PRMODE, OPTCD=J (a DCB subparameter), TRC, and UCS. Output Manager can dynamically capture these parameters from SYSOUT data sets and the static sets of printer attributes defined and associated with a report.

The captured parameters are stored in the BJTDAT table. You can control the capture of these parameters in the following ways: 1) by specifying this configuration parameter, and 2) by setting the Dynamic Print field within the sets of archived attributes and report definitions. This parameter can force the capture of the dynamic printing parameters globally, across all reports or all archives or all reports and archives, even when the Dynamic Print field is set to No for these objects.

Note: The DYNAMIC_PRINTER_ATTRIBUTE_CAPTURE parameter controls only the capture of the dynamic printing parameters, not their use for printing. The Dynamic Print settings will still control the actual use of these parameters. If you want to control both the capture and use of the dynamic printing parameters globally, specify the DYNAMIC_PRINTER_ATTRIBUTE_USE parameter instead.

• Required: No
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

DYNAMIC_PRINTER_ATTRIBUTE_USE [DEFINED | ALL | ARCHIVES | REPORTS]

(Optional) Controls the objects for which dynamic printing parameters are captured and used for printing.

• DEFINED: Captures and uses the dynamic printing parameters only when Dynamic Print is set to YES (for archives) or REPORT (for reports) for that archive or report. For archives, dynamic print is set in the associated archive attribute; for reports, it is set is in the report definition. This option is the default option.
• ALL: Capture and use the dynamic printing parameters for all archives and all reports, regardless of how the Dynamic Print field is set in the individual archive attributes and report definitions.
• ARCHIVES: Capture and use the dynamic printing parameters for printing all archives, and for printing any reports that are based on a report definition in which the Dynamic Print field is set to Report.
• REPORTS: Capture and use the dynamic printing parameters for printing all reports, and for printing any archives that are based on a set of archive attributes in which the Dynamic Print field is set to Report.

Output Manager can dynamically capture certain printing parameters from SYSOUT data sets and the static sets of printer attributes that you define from the Output Manager ISPF interface and associate with a report. The parameters are stored in the BJTDAT table. You can control both the capture and use of these parameters in the following ways: 1) by specifying this parameter, and 2) by setting the Dynamic Print field within the sets of archived attributes and report definitions that you define. This parameter can force the capture and use of the dynamic printing parameters globally, across all reports or all archives or all reports and archives, even when the Dynamic Print field is set to No for these objects.

Note: The DYNAMIC_PRINTER_ATTRIBUTE_USE parameter controls both the capture and the use of the dynamic printing parameters globally. If you want to control only the capture of the dynamic printing parameters, specify the DYNAMIC_PRINTER_ATTRIBUTE_CAPTURE parameter instead.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

ISV recall configuration parameters

RECALL_MEMBER (proc)

(Optional) Specifies the PROC name that you customized to perform recall operations. SBJTSAMP member BJT@PRV is provided as a configurable sample.

Note: This PDS is typically allocated as FB LRECL = 80.

• Required: No
• Relevant subsystem types: STC, ISPF, ITOMWeb, and * (default subsystem)
• Default value: None

RECALL_JOB_N

Specify valid job cards for your installation. ITOMweb dynamically builds and submits a batch job to recall reports when requested. N is a single digit, 1-6, to allow you to specify up to 6 job cards.

• Required: Yes
• Relevant subsystem types: STC, ISPF, ITOMWeb, and * (default subsystem)
• Default value: None

RECALL_JOBNAME_PATTERN jobname_pattern

This attribute allows Output Manager to perform multiple recall operations with different names. If you use BJT@PRV, specify the job name pattern in BJT@PRV. If you use only one job name for recall jobs, specify the fully-qualified job name. Specifies the recall procedures that the Output Manager started task initiates whenever you request the recall of an archive data set that is in third-party format. RECALL_JOBNAME specifies the procedure name that is defined in the member BJT@PRV. For more information, see ISV recall installation and customization.

• Required: Yes
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

RECALL_PDS SBJTSAMP

Library that contains the recall PROC member for ISV recall and DFSMShsm recall. If you have configured Output Manager to process DFSMShsm recalls and ISV recall recalls through batch jobs, you must use this parameter to declare where the recall procs are located. If necessary, change SBJTSAMP to the data set that contains the SBJTSAMP members BJT@PRV, and BJT@PRVV.

Note: It is recommended to leave these members in SBJTSAMP and keep the default RECALL_PDS value of SBJTSAMP.

• Required: Yes
• Relevant subsystem types: STC, ITOMWeb, ISPF, and * (default subsystem)
• Default value: SBJTSAMP

Archive SYSOUT options

ARCTIME [CAPTURE | JOB | DATASET]

Controls the date and time associated with archives.

CAPTURE: Uses the time that Output Manager captured the spool data set.

JOB: Uses the execution start time of the job.

DATASET: Uses the data set availability time. This is either the job end-time or the data set deallocation time. See the JCL reference, DD statement, SPIN parameter for more information.

• Required: No
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: CAPTURE

DEFAULT_GENERATIONS nnn

When included, this parameter defines the default limit of generations to retain. nnn is a numerical value in the range of 0 through 999 (inclusive) that specifies the value of the default limit for archive attributes where the base does not exist. Setting DEFAULT_GENERATIONS to 0 (the default) is the equivalent of disabling the dynamic creation of GDG bases. If DEFAULT_GENERATIONS is set to 0 and an archive attribute specifies the use of a GDG but the base is not defined, archiving will fail.

• Required: No
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: 0

DETECT_CARRIAGE_CONTROL [OFF | ON]

Specifies whether or not Output Manager should detect carriage control if a sysout does not declare carriage control in the RECFM.

OFF: Output Manager archive data sets always use carriage control. If the sysout does not declare carriage control, Output Manager assumes that ASA carriage control is used, and inserts a blank at the beginning of every line. This is the default.

ON: If the sysout does not declare carriage control, Output Manager reads the first 1000 lines of the sysout to detect the carriage control. If Output Manager finds only valid ASA carriage control, the character 'A' is added to the RECFM. If Output Manager finds only valid machine carriage control, the character 'M' is added to the RECFM. If Output Manager finds any line that begins with a character that is neither valid ASA nor machine carriage control, it does not modify the carriage control.

Note: Output Manager does not consider channels 2-12 when detecting carriage control.

• Required: No
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: OFF

CONDITION_CODE [LASTNONZERO | HIGHEST]

(Optional) Specifies the option for reporting condition codes. If you specify LASTNONZERO, Output Manager will report the last non-zero condition code from a job on the Archived Reports panel. If you specify HIGHEST, Output Manager will report the highest non-zero condition code from a job. If this parameter is not specified, Output Manager uses LASTNONZERO as the default option.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: LASTNONZERO

Email configuration parameters

ENABLE_EMAIL

Specify YES or NO to indicate whether distribution via email is enabled.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: NO

EMAIL_DEFAULT_PDF_PAGE_GEOMETRY

Specify the default page orientation and geometry of PDF pages distributed by email. Valid values include: Letter (for 8.5" x 11.0"); Letter landscape (for 11.0" x 8.5"); A4 (for 210 x 297 mm); and A4 landscape (for 297 x 210 mm).

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: Letter

EMAIL_DISCLAIMER

(Optional) This configuration parameter can be used to add a disclaimer message to the end of the message body text for each email sent from Output Manager. Include the disclaimer message in a partitioned data set member or sequential data set, and then specify that data set as the value in this configuration parameter. The contents of the data set is used as the email disclaimer.

EMAIL_SUBJECT_INCLUDES_REPORT_NAME

Specify YES or NO to indicate whether or not report distributions by email will include the report name in the email subject line.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: No

EMAIL_SUBJECT_INCLUDES_REPORT_DESCRIPTION

Specify YES or NO to indicate whether or not report distributions by email will include the report description in the email subject line.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: No

EMAIL_SMTP_ADDRESS

This parameter is required for email distribution support. Specify the host name of the email server that Output Manager will use. Consult your network administrator for the correct SMTP server IP address or DNS name for your local email server and specify the SMTP server in this parameter.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

EMAIL_SMTP_PORT

Configuration option for report email distribution. Consult your network administrator for the correct SMTP port value for your local mail server and specify the SMTP port in this parameter.

Note: This port is usually 25 or 587. Authentication may be enabled on either or both of these ports.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: 25

EMAIL_FROM_ADDRESS itomadmin@yourcompany.com

The email address specified in this parameter is used as the FROM address for Output Manager report email distribution. It is recommended to use a valid email address to allow recipients to respond to the distribution. Additionally, some email server authentications require a valid email address. Consult your local email administrator.

Tip: To prevent report email distributions from being marked as spam or junk mail by your email server, ask your email administrator to add this address to your email server's global Safe Sender List. If this can not be configured globally, users may need to add this email address to the safe sender list or contact list in their email client if their filter flags messages sent from this sender as spam.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

EMAIL_SMTP_USER

Specify the SMTP email user ID assigned to the Output Manager email service.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

EMAIL_SMTP_PASSWORD

Specify the SMTP password of the email user ID assigned to the Output Manager email service.

• Required: Only required if your SMTP server requires a password.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

EMAIL_ITOMWEB_URL http://mysystem:8081/OM

This parameter is required if you wish to provide links to reports in ITOMweb when distributing via email. Specify the homepage URL of your ITOMweb service.

• Required: No.
• Relevant subsystem types: STC, and * (default subsystem)
• Default value: None

Combine Sysouts

COMBINE_SYSOUTS_EODS_WAIT_1

This option applies only to the first sysout in CS=YES archive.

Default is 3000 (30 seconds). Units are 0.01 seconds.

COMBINE_SYSOUTS_EODS_WAIT_N

This option applies after the first sysout of a CS YES archive, unless the _E or _R option applies. For example, third party recalls, syslogs, or jobs that got errors before running.

Default is 25 (250 ms). Units are 0.01 seconds.

Note:

• This option affects the throughput of OM capturing. It is not recommended that you change this option.
• If ALLOW_SELECT_BY_NODE is NO, and the job is remote, COMBINE_SYSOUTS_EODS_WAIT_N is used instead.

COMBINE_SYSOUTS_EODS_WAIT_E

This option applies after the first sysout of a CS YES archive, for jobs that have completed execution. Time is measured from the end time of the job. For JES2, this is the time that the $HASP395 message is issued.

Default is 500 (5 seconds). Units are 0.01 seconds.

If you are using a JES2 Multi Access Spool, depending on certain performance considerations, you may need to use 10 seconds (1000) or 15 seconds (1500) for this parameter. If the job was completed long enough ago that there would be no wait, then COMBINE_SYSOUTS_EODS_WAIT_N will determine the wait time.

COMBINE_SYSOUTS_EODS_WAIT_R

This option applies after the first sysout of a CS YES archive, for jobs that are still running.

Default is 25 (250 ms). Units are 0.01 seconds.

Configure a value that is greater than the maximum time between when a job produces spun output, and when that job terminates. For example, if you have a job that runs for 5 minutes, and produces spun output in the first step, you should use 5 minutes for this parameter.

If you are using a JES2 Multi Access Spool, depending on certain performance considerations, you may need to increase this value by up to 15 seconds. Find the $HASP165 message in the system log, and note the time, and compare it to the time of the fist TIMEOUT line for the jobid.

Note: It is not recommended that this option be configured with a very large value. This is because a very long running job could cause a long pause in one of the Output Manager selectors.

ARA protocol parameters

The Output Manager Archive and Report Access (ARA) protocol is required when the Report Access ID security feature is used. ARA protocol provides the Output Manager ISPF interface with access to archives and reports, uses TCPIP to connect to the started task for processing. ARA also allows authorized Output Manager users to activate or change the configuration of active selector rules and subselector rules via the POLICY ACTIVATE command in ISPF.

ARA_PORT tcpip_port_for_ara

Specify the number of an available TCPIP port. ARA allows ITOM ISPF to access archive data sets in a secure manner, supplies information about the ITOM started task, allows authorized ITOM ISPF users to perform a POLICY ACTIVATE, activates the policy, and recycles the started task. When port 0 is specified, you can access archives without the started task being up.

When this attribute is specified, it applies to the default subsystem and type (subsystem *, type *).

• Required: No.
• Relevant subsystem types: * (default subsystem)
• Default value: 0

How to choose a port for the ITOMweb and ARA protocols:

ITOM uses two types of TCP protocols: the web server for ITOMweb, and the ARA (Archive and Report Access) protocol for the Output Manager ISPF interface. The most common ports used for web servers are port 80, 8080, and 8081. Ask your site’s Internet or network administration which port to use. If your site does not have an Internet or network administrator, choose a port that is not already in use. You can use the NETSTAT command to determine the ports that are already in use. The NETSTAT command finds the ports used by all listeners, and is available in both TSO and USS:

• The TSO command: NETSTAT SOCKETS (IPADDR 0.0.0.0
• The USS command: netstat -s -I 0.0.0.0

Tips:

• If you receive the message EZZ2376I, identify the name of the TCPIP address space that you wish to use (for example, using SDSF) and then use NETSTAT ALLC TCP tcpaddrspacename (for TSO), or netstat -a -p tcpaddrspacename (for USS).
• If you receive the message "bind errno=1115 EDC8115I Address already in use", find the port that it used in one of the previous lines in the log, then use the TSO command NETSTAT SOCKETS (IPPORT 0.0.0.0+port) or the USS command netstat -s -B 0.0.0.0+port, where port is the port number that it used.
• If you receive other messages, talk to your security administrator.

When to choose a non-zero ARA port:

You should specify a non-zero ARA port if any of the following situations are true:

• You are using REPORT_ACCESS_ID
• You want to perform LOAD CONFIG and POLICY ACTIVATE/DEACTIVATE commands from ISPF
• You use USE_SERVER_FOR_HSM_RECALL set to YES
• You use USE_SERVER_FOR_ISV_RECALL set to YES

In all other use cases, it is recommended to use ARA_PORT=0.

ARA_HOST host name

The TCPIP host name of the LPAR on which Output Manager is running. The host name of the system running the started task.

The host name is where the ARA server is running. This must be the same host on which the started task is running. The default value is localhost.