varname

Name of the AutoEdit, Database, or Local variable in which the extracted information is to be stored. Mandatory.

LEVEL

Level of the WHEN statement in the current WHEN criteria that is to be used as a reference for this extraction. The default is the current level (which can be specified as level 0). See statement WHEN for additional information. Optional.

LINE

Specifies how many lines Control-M/Analyzer should skip when positioning within the data source before extracting. A signed (+/-) 3-digit number must be specified. Mandatory. Valid values are specified and described in Table 226.

COL

Specifies the column range from which to extract data, comprised of:

• col_from – A 4-digit or signed 3-digit number must be specified. Mandatory.
• col_until – A 4-digit or signed 3-digit number must be specified. Mandatory.

Valid values are specified and described in Table 226.

Notes: Line and column positions can also be specified using Relative Values (for example, the column at which the WHEN string was found plus an offset value). For more information, see General Information.

The number of columns in the COL range cannot exceed 100 because the maximum length of the variable value (after resolving %% operators, if any) is 100 bytes.

PROCESS

Type of processing to apply to the extracted value before setting the variable. Optional. Built-in processes all begin with the letter B. The following built-in processes are available:

• BBINC – Extracts the binary character equivalent and converts it to EBCDIC.
• BBIND – Extracts the binary double-word equivalent and converts it to EBCDIC.
• BBINF – Extracts the binary fullword equivalent and converts it to EBCDIC.
• BBINH – Extracts the binary halfword equivalent and converts it to EBCDIC.
• BFLTB – Removes all blanks (including blanks in the middle of the string).
• BFNUM – Converts formatted numbers to standard mathematical format.
• BFNUME – Converts European numbers to standard mathematical format.
• BPADZ – Replaces leading blanks with zeros.
• BTLOWER – Converts characters to lowercase.
• BTRIMB – Removes leading and trailing blanks.
• BTRIML – Removes leading blanks.
• BTRIMR – Removes trailing blanks.
• BTUPPER – Converts characters to uppercase.
• BUNPK – Converts packed format numbers to standard mathematical format.
• BUNPKn – Converts packed format numbers to standard mathematical format, including n decimal places.
• BUPROC – Calls a user defined process.
• BWn – Extracts the nth word from a string.
• BXuvwxyz – Filters specified characters (uvwxyz) from the data.
• BZONED – Converts zoned decimal numbers to standard decimal character format.
• BCPROCn – Performs a series of processes.

For more information about most of these processes, see DO EXTRACT Processes.

User-defined processes must begin with the letter U. User Exit CTBX010 can be modified to call user-defined processes. For information about User Exit CTBX010, see the IOA.SAMPEXIT library.

For information about compiling and linking member CTBX010, see the INCONTROL for z/OS Installation Guide.

TYP

Type of extraction to perform when setting the variable. Optional. Valid values are:

• '  ' (Blank) – The value extracted from the data source is stored in varname (overriding the previous value of varname).
• SU – The value extracted from the data source is added to the previous value of varname (for the current rule invocation) and the sum is stored in varname.
• AV – The average of the value extracted from the data source and previous values of varname (from the current rule invocation) is calculated and stored in varname.