Previous Topic: Customizing the Report List Web


Customizing Attributes

Attributes can be customized for the Report List Web Service.

Note: All repositories cannot use all the fields.

The following table describes attributes available for the customization in the Report List Web Service:

Attribute

Name

Data Type

Description

ARCDATE

Archive Date

(creation date)

Date, ten characters, in the format mm/dd/yyyy

The date of the report.

Depending on the remote repository, this date may represent the date the report ran (the

date of the MVS job) or the date the report was collected by the repository.

ARCTIME

Archive Time

(creation time)

Time, 11 characters, in the format hh:mm:ss:nn

The time of the report.

Depending on the remote repository, this time may represent the time the report ran (the

time of the MVS job) or the time the report

was collected by the repository.

Note: The time format hh:mm:ss:nn is required for CA Bundl.

CHECKSUM

Resource Checksum

Up to eight characters

The checksum of the resource associate with a multiple-part AFP report.

Note: This attribute has no meaning for other report types; the value will be null.

The CHECKSUM attribute, in conjunction with RESRC_SIZE, can be used to uniquely identify AFP resources. This allows for caching of resources.

Different reports can use the same resources; using a cached resource may improve report retrieval performance.

DOC_TYPE

Document Type

Up to eight characters

The type of report.

Values include:

AFP

An AFP/ACIF documents. Retrieves data and resource (if any) in binary mode.

TEXT

A text document. Retrieves data in text mode.

.XXX

XXX represents a PC-style file extension. This DOC_TYPE value is the actual PC extension; use this value to determine the application to display the document. Retrieves data in binary mode.

GEN

Report Generation

Numeric

The backup generation for the report for CA View.

For CA Bundl, the GEN attribute is a flag that indicates whether the report is indexed; GEN=0 indicates the report is not indexed and GEN=1 indicates the report is indexed.

JOBID

Job Identifier

One to eight characters

The ID of the job that created the report.

JOBNAME

Job Name

One to eight characters

The name of the job that created the report.

LINES

Lines in Report

Numeric

The total number of lines in the report.

For DOC_TYPE=.XX, LINES is the number of bytes in the report.

LPAGES

Pages in Report

Numeric

The total number of pages in the report.

ODEST

Output Destination

Up to 17 characters

The original report destination from the job that produced the report.

For CA Bundl, ODEST specifies the report’s mailcode.

ONDISK

On Disk

One character, Y or N

An indicator flag for report location; indicates if the report has a copy on disk.

ONDISK=Y

The report is on disk and ready for immediate access.

ONDISK=N

The report is not on disk and is offline.

Used in conjunction with ONOPTICAL and ONTAPE.

ONOPTICAL

On Optical

One character, Y or N

An indicator flag for the report location; indicates if the report has a copy on an optical device.

ONOPTICAL=Y

The report is on optical.

ONOPTICAL=N

The report is not on optical.

ONTAPE

On Tape

One character, Y or N

An indicator flag for the report location; indicates if the report has a copy on a tape or another long-term back-up media.

ONTAPE=Y

The report is on tape.

ONTAPE=N

The report is not on tape.

RESRC_SIZE

Resource Size

Numeric

The size, in bytes, of the resource file associated with a multiple part AFP report.

Note: This attribute has no meaning for other report types; the value will be blank or null.

The RESRC_SIZE attribute, in conjunction with CHECKSUM, can be used for uniquely identifying AFP resources to allow resource caching.

Different reports can use the same resources; using a cached resource may improve report retrieval performance.

RID

Report Identifier

32 characters for CA View. 20 characters for CA Bundl or CA Dispatch

The name of the report.

For CA View version 12.0 and up, RID can contain some special characters (refer to the CA View 12.0 Release Notes for the full list).

For CA Bundl, RID contains the CA Bundl application ID and the report name. The first 10 bytes of the RID is the application ID (blank padded); the second 10 bytes of the RID is the report name.

RPT_DESC

ReportDescription

Up to 24 characters

The description of the report.

For CA View, RPT_DESC contains the CA Deliver description if you are in EXP or EXPO mode; otherwise, RPT_DESC is blank.

RPT_HANDLE

Report Handle

Binary

A unique identifier for a report in a particular repository.

RPT_HANDLE is the primary key for accessing the report.

SEQ

Report Sequence

Numeric

The position of the report in its back-up generation.

Note: Applies to CA View only.

USERDATA

User Data

Length varies by Host Output Management product

For CA Bundl, USERDATA contains the mailcode and is used to filter the ReportList API request by the CA Bundl mailcode.

For CA Dispatch, USERDATA contains the recipient ID and is used to filter the ReportList API request by the CA Dispatch recipient.

Note: CA Dispatch does not use the ODEST field to return the recipient; CA Bundl does.

For CA View, USERDATA contains accounting information from the job that created the report if available.

VERSION

Version or Copy of the Report

Numeric

Identifies the version or copy of a particular report based on the report name (RID).

Note: VERSION applies to CA view only.

0 represents the most recent version of a report.1 is the next most recent.

XCODE

Exception Code

Up to six characters

The exception code for the job that printed the report (JCL errors, abends, and so forth).