FDREPORT ACTIVATE Statement

ACTIVATE statement syntax

ACTIVATE statement

The ACTIVATE statement is used to activate predefined user fields in the FDREPORT field definition and processing table. Data for user fields comes exclusively from one or more user exits. The field activation is TEMPORARY only for the given invocation of the FDREPORT that they are specified.

Part of field activation requires setting the name of the exit. Control is passed to the exit via a “BALR 14,15” instruction. Normal save area conventions are followed and register 1 contains the address of a parameter list. Contents of the parameter list are described by the @RPTUSRX macro found in the FDR Installation FDRSAMP data set shipped with the FDREPORT install, as is a copy of the testing exit, F$REPIXT.

ACTIVATE statement required operands

DATALENGTH=

Specifies the length in bytes that the field occupies within the report record. The limits of the field vary, based on DATATYPE=. The limits are:

DATATYPE=

Specifies the type of data that the field contains. There are three types of data that are supported by FDREPORT and its formatting services for user fields:

Binary, considered to be numeric.

Character.

Hexadecimal.

FIELD=

Specifies the name of the field to be activated. The valid field names are:

Predefined user field 1.

Predefined user field 2.

Predefined user field 3.

Predefined user field 4.

Predefined user field 5.

Predefined user field 6.

Predefined user field 7.

Predefined user field 8.

Predefined user field 9.

Predefined user volume record field 1.

Predefined user volume record field 2.

Predefined user volume record field 3.

Predefined user volume record field 4.

Predefined user volume record field 5.

Predefined user volume record field 6.

Predefined user volume record field 7.

Predefined user volume record field 8.

Predefined user volume record field 9.

SOURCE=

Specifies where the contents of the field being activated is to be obtained. Two elements comprise the SOURCE= operand and both may be specified. The first element determines how the field contents are derived.

The field is derived from a user exit. When EXIT is specified for SOURCE=, it must be followed by the name of the exit to be invoked. The exit name is from 1 to 8 characters in length. When using EXIT, SOURCE= is coded as: SOURCE=(EXIT,exitname)

The field is already in the user portion of the data record and activation is required to process it.

The user field name is no longer required and is to be deactivated.

See the FDR Installation FDRSAMP member F$REPIXT for an example of a user exit.

ACTIVATE statement optional operands

DESCRIPTION=

Specifies the description of the field that is displayed when “HELP DESCRIPTION” is specified. The data may be from 1 to 44 bytes in length. Since the data may contain characters that can be considered delimiters, it is usually a quoted string.

This is an optional operand. A default description is displayed if requested.

FORMAT=

Specifies the extended formatting services required. Use of the FORMAT= operand is valid only when DATATYPE= is binary (BIN). There are two elements in the FORMAT= restricted to J3DATE, which defines the field as a 3-byte Julian date field. J3DATE, if the only value specified, causes the field to be formatted as yy.ddd. The second element is used to describe the desired output format. Possible values are:

MMDDYY -

MMDDYYYY - 

YYYYDDD -

DDMMYY -

DDMMYYYY -

YYDDD -

This is an optional operand, used only to provide access to common output date formatting routines.

HEADER=

Specifies the column headers for the generated reports and for use by the summary and control break routines. There are three headers possible but they are entered in the following sequence because most fields do not have a two line column header: 2, 3, 1. Where “2” is the normal one line column header, “3” is a single line header for RPTYPE=TABLE (as well as control breaks and summary), and “1” is the top line of a two line column header. The maximum number of significant characters that can be specified per header is 24, but only the value OUTPUTLENGTH= is used in generating the headers. The data is aligned to the left, so if you want leading blanks, then count columns.

This is an optional operand. If HEADER= is not specified, a blank field of the appropriate length is used.

OUTPUTLENGTH=

Specifies the number of bytes in the formatted output. The value limit is based on the contents of DATATYPE=. If DATATYPE=CHAR, the value for OUTPUTLENGTH= may be defaulted to the value of DATALENGTH=. If it is specified, it must be greater than zero but less than or equal to the value of DATALENGTH=. If DATATYPE=HEX, the value for OUTPUTLENGTH= must be an even number of bytes and no greater than twice the value of DATALENGTH=. If DATATYPE=BIN, the following limits apply:

Figure 54.2: OUTPUTLENGTH Dependencies for DATATYPE=BIN

This is a required operand except when DATATYPE=CHAR.

REDEFINE

Permits the changing of various field descriptive operands. It is not possible to change the characteristics of a previously activated user field unless REDEFINE is specified.