z/OS Job log data

This reference lists the configuration values that you can update for the z/OS® Job log data collection in stream mode. It also describes how to use wildcard characters in the job name field for this data stream. The job log data contains Generic z/OS Job Output data, CICS® EYULOG data, CICS EYULOG DMY data, CICS EYULOG YMD data, CICS User Messages data, CICS User Messages DMY data, CICS User Messages YMD data, WebSphere® SYSOUT data, and WebSphere SYSPRINT data.

Global Setting

Pattern discovery interval
In the process of streaming data, the number of minutes that the Data Collector waits before it checks for new data sources that match wildcard specifications. This value can be updated in Global setting window and applies to all job log data streams from the Data Collector.
The value must be an integer in the range 0 - 1440. The default value is 10 (minutes). The value 0 specifies that the Data Collector checks for a new job only once when the Data Collector is started.
Discovery interval
In the process of streaming data, the number of minutes that the Data Collector waits before it checks for a new log file in the data stream. This value can be updated in Global setting window and applies to all data streams from the Data Collector, although it can be overridden on some individual streams.
The value must be an integer in the range 0 - 1440. The value 0 specifies that the Data Collector checks for a new log file only once when the data gatherer is started. The default value is 1 (minute).

Data Resource Setting

Data source
You can define the specific data source that you want to collect in the Add/Edit data resource window. In this case, select Job log.
Data source type
Defines the data source type that should be collected. This parameter is required. You can specify one of the following values for data source type:
  • zOS-JOB-LOG (Generic z/OS Job Output data)
  • zOS-WAS-SYSPRINT (WebSphere SYSPRINT data)
  • zOS-WAS-SYSOUT (WebSphere SYSOUT data)
  • zOS-CICS-MSGUSR (CICS User Messages data)
  • zOS-CICS-MSGUSRYMD (CICS EYULOG YMD data)
  • zOS-CICS-MSGUSRDMY (CICS User Messages DMY data)
  • zOS-CICS-EYULOG (CICS EYULOG data)
  • zOS-CICS-EYULOGYMD (CICS EYULOG YMD data)
  • zOS-CICS-EYULOGDMY (CICS EYULOG DMY data)
Job name
Defines the name of the server job from which to gather data. This value can contain wildcard characters. For more information about the use of wildcard characters, see Use of wildcard characters in the Job name field.
DD names
Defines the data definition (DD) names for the job log.
Note:
  • The DD Names for CICS EYULOG data, CICS EYULOG DMY data, and CICS EYULOG YMD data are fixed as [EYULOG].
  • The DD Names for CICS User Messages data, CICS User Messages DMY data, and CICS User Messages YMD data are fixed as [MSGUSR].
  • The DD Name for WebSphere SYSPRINT data is fixed as [SYSPRINT].
  • The DD Name for WebSphere SYSOUT data is fixed as [SYSOUT].
Discovery interval
Defines the discovery interval for discovering new log files for the job.
The value must be an integer in the range 0 - 1440. The value 0 specifies that the Data Collector checks for a new log file only once when the data collector is started. The default value is 1 (minute). When it is set here, it can override the value in global setting.
Topic name
Defines the topic name for Job Output data. The default value is IBM-CDP-DASHBOARDS-{dataSourceType}, of which, dataSourceType will be parsed to the data source type: zOS-WAS-SYSPRINT, zOS-WAS-SYSOUT, zOS-CICS-MSGUSR, zOS-CICS-MSGUSRYMD, zOS-CICS-MSGUSRDMY, zOS-CICS-EYULOG, zOS-CICS-EYULOGYMD, and zOS-CICS-EYULOGDMY.
Output format
The output format of Job output data collection. The value can be key-value or csv. The default value is csv.
File Path
A unique identifier that represents the data origin. The default value is jobName/ddName.
Data source name
The name that uniquely identifies the data source. The default value is jobName-ddName.
Tip: If you use the Auto-Qualify field in the system configuration to fully qualify the data source name, this dataSourceName value is automatically updated with the fully qualified data source name. For more information about the values that you can select in the Auto-Qualify field, see System configuration.

Use of wildcard characters in the Job name field

In the Job name field for this data stream, you can use the following wildcard characters:
Wildcard character What the character represents
? Any single character. There must be one and only one character.
* Any sequence of characters, including an empty sequence.

If you use wildcard characters in the job name, the job name value becomes a pattern, and the data stream definition becomes a template. When the Data Collector starts, it searches the Job Entry Subsystem (JES) spool for job names that match the pattern, and it creates a separate data stream for each unique job name that it discovers. After the Data Collector initialization is complete, the Data Collector continues to monitor the job names on the JES spool. As it discovers new job names that match the pattern, it uses the same template to create more data streams.

For example, if the job name value is ABCD????, and the JES spool contains the following jobs, two data streams are created, one for job name ABCD1234 and one for job name ABCDE567:
JOBNAME JobID
ABCD1234 STC00735
DEFG1234 STC00746
ABCDE567 STC00798
DEFG5678 STC00775
ABCD123 STC00772
DEFG456 STC00794
HBODSPRO STC00623
HBOPROC STC00661
SYSLOG STC00552
Tip:
  • To avoid gathering data from job logs that you do not intend to gather from, use a job name pattern that is not too broad. If you want the wildcard characters to match a fixed number of characters, use the ? as your wildcard.
  • The Data Collector might discover jobs from other systems if spool is shared between systems or if JES multi-access spool is enabled. Although the data stream does not include data for the jobs that run on other systems, the Data Collector creates a data stream for that data. Therefore, ensure that the wildcard pattern does not match jobs that run on other systems.
Each resulting data stream is based on the template and has the same configuration values as the template, with the exception of the following values:
Template field Value
Job Name The discovered job name
Data Source Name The value of the Data Source Name field in the template, with _jobName_ddName appended to that value. The jobName is the discovered job name, and the ddName is the DD name for the job log.
File Path The value of the File Path field in the template, with /jobName/ddName appended to that value. The jobName is the discovered job name, and the ddName is the DD name for the job log.