Previous Topic: ExampleNext Topic: Setting Up Print Attributes


Types of Symbolic Variables

The following list describes symbolic variables:

Symbolic Variable

Abbrev.

Char. Length

Purpose

Anm

None

72

Used to insert the one‑ to three‑ digit position number of the distribution identifier within a group of distribution identifiers (n), and the one-digit number of the address line of a distribution identifier (m)

For example, A124 inserts address line 4 of the 12th distribution identifier in the group.

For non-bundled report banner pages, the group comprises distribution identifiers grouped in the report definition.

For bundled reports and bundle banner pages, the group comprises identifiers defined for the bundle in which reports actually exist.

For distribution banner pages, the group comprises the single identifier for which reports are being printed.

For report banner pages, the group comprises the single identifier for which the report is printed.

If a group does not contain "m" identifiers, the value of this symbolic variable is blank.

This variable does not work in banner pages for reports that contain control breaks.

ARCHID

None

32

Used to insert the archival identifier name for the report

If the archive identifier name is not specified in the report definition, the report identifier name is used.

You can use this variable only on the report banner page and bundle report banner page. Blanks are substituted on the bundle banner page and bundle distribution banner page.

BAm

None

72

Used to insert the one-digit number of the address line of a distribution identifier (m) specified in the bundle definition

Blank is substituted for this variable in non-bundled report banner pages.

This variable does not work in banner pages for reports that contain control breaks.

BHDN

None

10

Used to insert the history detail number of a bundle of reports, which remains the same for the entire bundle

This variable does not work in banner pages for bundles that consist of reports that contain control breaks.

BID

None

32

Used to insert the identifier for the bundle

Blank is substituted for this variable in non-bundled report banner pages.

You can also specify BID+nn to select the starting point for variable substitution. For example, BID+16 causes substitution to begin with the 17th character of the bundle identifier.

This variable does not work in banner pages for reports that contain control breaks.

BSNO

None

5

Used to insert the bundle sequence number

Blank is substituted for this variable in non-bundled report banner pages.

This variable does not work in banner pages for reports that contain control breaks.

CDATE

None

8

Used to insert the creation date of the report or reports in the default date format with a two-digit year, for example, 10/01/02

For non-bundled report banner pages, the creation date is identical to the print date except if the report is archived; in this case the creation date corresponds to the date the report was archived.

For bundled reports and distribution and bundle banner pages, the creation date is identical to the print date.

For report banner pages, the creation date is identical to the date the report bundle holding copy was created.

This variable does not work in banner pages for reports that contain control breaks.

CDATE4

None

10

Used to insert the creation date of the report or reports in the default date format with a four-digit year, for example, 10/01/2002

For non-bundled report banner pages, the creation date is identical to the print date except if the report is archived; in this case the creation date corresponds to the date the report was archived.

For bundled reports and distribution and bundle banner pages, the creation date is identical to the print date.

For report banner pages, the creation date is identical to the date the report bundle holding copy was created.

This variable does not work in banner pages for reports that contain control breaks.

CLASS

C

1

Used to insert the SYSOUT class of the report or reports

COPIES

None

3

Used to insert the number of copies of the report

For non-bundled report banner pages, the number of copies to be distributed is inserted. For bundled reports, 0 is inserted.

This variable does not work in banner pages for reports that contain control breaks.

CTIME

None

8

Used to insert the time when a report is created in a hh:mm:ss format, for example, 10:45:59

For non-bundled report banner pages, the creation time is identical to the print time except if the report is archived; in this case the creation time corresponds to the time the report was archived.

For bundled reports and distribution and bundle banner pages, the creation time is identical to the print time.

For report banner pages, the creation date is identical to the time the report bundle holding copy was created.

This variable does not work in banner pages for reports that contain control breaks.

CTIMEP

None

8

Used to insert the time when a report is created in a hh.mm.ss format, for example, 10.45.59

For non-bundled report banner pages, the creation time is identical to the print time except if the report is archived; in this case the creation time corresponds to the time the report was archived.

For bundled reports and distribution and bundle banner pages, the creation time is identical to the print time.

For report banner pages, the creation time is identical to the time the report bundle holding copy was created.

This variable does not work in banner pages for reports that contain control breaks.

DATE

None

8

Used to insert the date when the report or reports are printed in the default date format with a two-digit year, for example, 10/01/02

DATE4

None

10

Used to insert the date when the report or reports are printed in the default date format with a four-digit year, for example, 10/01/2002

DDNAME

DD

8

Used to insert the DDname for the report or reports

Blank is substituted for this variable in bundle and distribution banner pages.

DESC

None

40

Used to insert the description of a report or bundle from the DESC field on either the Report or Bundle Definition Attributes panel

Blank is substituted for this variable in bundle and distribution banner pages.

DEST

None

8

Used to insert the SYSOUT destination of a report or bundle

DHDNn

None

10

Used to insert the history detail number for a report within a group of reports for a specific distribution identifier, identified by n (a DHDN is created for each report in a bundle of reports)

This variable does not work in banner pages for reports that contain control breaks.

Note: Use this symbolic variable on report banner pages only.

DISTn

None

32

Inserts the one‑ to three‑digit position number of the distribution identifier within a group of distribution identifiers (n)

You need not specify the first distribution identifier; DIST and DIST1 are identical.

For non-bundled report banner pages, the group comprises distribution identifiers grouped in the report definition.

For bundled reports and bundle banner pages, the group comprises identifiers defined for the bundle in which reports actually exist.

For distribution banner pages, the group comprises the single identifier for which reports are being printed.

For report banner pages, the group comprises the single identifier of the printed report.

You can also specify DIST+nn to select the starting point for variable substitution. For example, DIST+16 causes substitution to begin with the 17th character of the bundle identifier.

Note: This only works with the form DIST, not with DISTn.

DLVRID

None

32

Used to insert the Deliver identifier name for the report

You can use this variable only on the report banner page and bundle report banner page. Blanks are substituted on the bundle banner page and bundle distribution banner page.

FORMS

None

8

Used to insert the name of the forms used

HDNn

None

10

Used to insert the HDN (history detail number) of each report in a bundle of reports identified by n

An HDN is created for each report in a bundle of reports.

This variable does not work in banner pages for reports that contain control breaks.

Note: Use this symbolic variable on report banner pages only.

INSTm

None

72

Used to insert the one‑ to three‑digit number of the instruction line (m) specified either on the Special Instructions sub-panel of the Report Definition Attributes panel for a report, or on the Special Instructions sub-panel of the Bundle Definition Attributes panel for a bundle

You need not specify the first distribution identifier; INST and INST1 are identical.

For distribution banner pages, the instructions printed are the instructions specified for the first report for the distribution identifier.

If instruction lines are not defined, blank is inserted for this variable.

JOBID

JID

8

This variable specifies the subsystem job identifier of a report

Blank is substituted for this variable in bundle and distribution banner pages.

JOBNAME

None

8

This variable specifies the job name for a report

Blank is substituted for this variable in bundle and distribution banner pages.

LINES

None

9

This variable specifies the number of lines in a report, an entire bundle of reports, or all reports for a distribution identifier

0 is inserted for this variable on start banner pages; the correct number of lines is inserted on end banner pages.

NAME

None

8

Used to insert the name of the model banner page member used as the basis for a banner page

PAGES

None

12

Used to insert the number of pages in a report, an entire bundle of reports, or all reports for a distribution identifier

0 is inserted for this variable on start banner pages; the correct number of pages is inserted on end banner pages.

PREVRUN

None

6

Used to insert the words RUN nn, where nn represents the number of times you have run the job during the current cycle

PREVRUN is inserted only on banner pages of most recently run reports.

Blank is substituted for this variable if a report is a non-bundled, spooled copy.

Blank is substituted for this variable in bundle and distribution banner pages.

Note: Use this symbolic variable on report banner pages only.

PROCNAME

PN

8

Used to insert the procedure step name for a report

Blank is substituted for this variable in bundle and distribution banner pages.

RERUN

None

9

Used to insert the word CORRECTED only on banner pages of most recently rerun reports

Blank is substituted for this variable if a report is a non‑bundled, spooled copy.

Blank is substituted for this variable in bundle and distribution banner pages.

RHDNn

None

10

Used to insert the report history detail number of a report based on its distribution identifier, identified by n (an RHDN is created for each report in a bundle of reports)

This variable does not work in banner pages for reports that contain control breaks.

Note: Use this variable on report banner pages only.

RIDn

None

32

Used to insert the one‑ to three‑digit number of a report identifier in a group of report identifiers (n)

You need not specify the first report identifier; RID and RID1 are identical.

For non-bundled report banner pages, the group comprises the single report identifier being printed.

For bundled reports and bundle banner pages, the group comprises all identifiers of the reports in the bundle that are actually being printed.

For distribution banner pages, the group comprises all identifiers for reports that are actually being printed for the distribution identifier.

For report banner pages, the group comprises the single identifier of the printed report.

You can also specify RID+nn to select the starting point for variable substitution. For example, RID+16 causes substitution to begin with the 17th character of the bundle identifier.

Note: This only works with the form RID, not with RIDn.

STEPNAME

SN

8

Used to insert the step name for a report

Blank is substituted for this variable in bundle and distribution banner pages.

TIME

None

8

Used to insert the time when a report is printed in a hh:mm:ss format, for example, 10:44:59

TIMEP

None

8

Used to insert the time when a report is printed in a hh.mm.ss format, for example, 10.44.59

USER

None

20

Used to insert the user accounting data for a report

Blank is substituted for this variable in bundle and distribution banner pages.

USERFLDn

None

Varies

Used to insert the user field identification text extracted from a report that contains control breaks where n is a number from 1–9

This value identifies the user field to be inserted on the Control Break Identification sub-panel on the Report Definition Attributes panel.