RMS Attribute Summary

+ (plus sign)

- (hyphen)

$ (dollar sign)

* (asterisk)

/ (slash)

() (parentheses)

' (apostrophe)

; (semicolon)

b/ (blank)

, (comma)

| (concatenation symbol)

" (double quotation marks)

< (less than sign)

> (greater than sign)

= (equal sign)

. (period)

Length:

1 to 255 characters

Example:

ACCEPT = A OR B OR C

Function:

Is optional, and enables you to assign a list or range of acceptable values to a RECTYPE or MAPVALUE field in a file.

The syntax is

ACCEPT = {list|range}

where:

list

Is a string of acceptable values:

value1 OR value2 OR value3...

For example, ACCEPT=RED OR WHITE OR BLUE. You can also use a blank as an item separator. If the list of acceptable values runs longer than one line, continue it on the next line. The list is terminated by a comma (,).

range

Gives the range of acceptable values:

value1 TO value2

For example:

ACCEPT = 150 TO 1000

Length:

1 to 8 characters.

Function:

Describes the type and length of a field as it actually exists in a file. The source of this information is an existing description of the file. The following chart shows the data format types that the server reads:

Type

Meaning

An

Alphanumeric character string (A-Z, 0-9, and other ASCII display characters), where n = 1-4,095.

D8

8-byte double-precision floating-point numbers.

F4

4-byte single-precision floating-point numbers.

Pn

Packed decimal internal format. The length is the number of bytes, each of which contains two digits, except for the last byte which contains a digit and the sign (+ or -). P6 means 11 digits plus a sign, packed 2 digits to the byte, for a total of 6 bytes of storage, where n = 1-8.

In

Binary integers:

If an integer field contains an assumed decimal point (meaning it is a scaled integer), the field is represented as Im.n, where m is the total number of storage bytes, and n is the number of decimal places for the scaling. For example, I4.1 means a 4-byte number with one decimal place.

If I1 (unsigned) is used with negative data values, incorrect values will display. It is important to know if the data will contain negative values and indicate that it is signed by using a scale factor, even if it is simply I1.0 (to indicate single byte signed, no scaling). This rule for signed and unsigned is only unique to ACTUAL I1 and does not apply to I2, I4 or I8 sizes

USAGE on a scaled integer may be P, D or I, but should be minimally configured as a utypem+2.n (for example, I12.2) to account for not having overflows on negative values. However, a USAGE of I is limited to an m value of 11. It should also be noted that JDBC JLINK access to a Master File using scaled integers must use USAGEs of P or D for scaling because scaled I is not supported in the JDBC specification.

Octaword Integer data type (USAGE=I16) is not supported.

Zn

Zoned decimal format (numeric string) where n is the number of digits (1 to 31), each of which takes one byte of storage. The last byte contains a digit and the sign.

There are several standards for zoned data. For Read purposes, only right overpunched standards are supported and can be determined on Read since they are unique.

The specific format to use when writing data must be known for read/write purposes. The default is ASCII right overpunch. To change the default, you must edit the EDACONF [.BIN]EDAENV.COM file and add the following logical:

DEFINE /NOLOG IBI_ZONED_OUT_TYPE {1|2}

where:

1

Is the ASCII right overpunched standard (default).

2

Is the EBCDIC right overpunched standard.

Zoned right separate numeric or zoned left overpunched numeric formats are not supported.

DATE

Unless your file was created by a program, all of the characters will be in ASCII format type A (alphanumeric).

The server permits the following conversions from ACTUAL format to USAGE (display) format:

USAGE

ACTUAL

I

I

P

P

P,D,I,F

Z

D

D

F

F

P

I8

YYMD

DATE

H

Date-Time stamp data that uses formatting options to display raw data or formatted time data, date data, or date-time data. See the Describing Data With WebFOCUS Language manual for a full list of options. By default, the values used in this feature are the FOCUS internal time keeping system, but the setting:

SET VMSTIMESTAMP = VMS

Lets actual data based on the OpenVMS Native 64-bit DEC Date specification be read and handled seamlessly.

Note: Releases prior to 7.7.07 required declaration of DEC Date as A8, and the use of the HINPUT()/CVTSTIMES() functions, which was less than seamless. It is recommended that any such metadata be converted to use H dates and this setting.

Alias:

SYNONYM

Length:

1 to 12 characters

Permitted Values:

All characters and digits.

Example:

ALIAS=CTY

Function:

Is an alternate name to identify a data field. Since references to data fields are based on the names, aliases, or shortest unique truncation, it is useful to make the ALIAS a short abbreviation representative of the data. Short, simple names are best, with no embedded blank spaces or special characters. For example, PART CODE or PART-CODE should be PARTCODE or PART_CODE, or PC.

Names must begin with a letter, but can contain numbers. Do not use names that might conflict with report column names (C1, C2, ...), row names (R1, R2, ...) or HOLD file aliases (E01, E02, ...). Also, avoid reserved keywords such as BY or ACROSS.

ALIAS has specialized functions when used with KEY definitions, RECTYPE and MAPFIELD, as discussed at the beginning of this manual.

Example:

DEFINE PROFIT/D8 = RETAIL_COST - DEALER_COST;$

Function:

Is optional, and enables you to store definitions for temporary fields in your Master File for reporting purposes.

The syntax is

DEFINE name[/format] = expression;$

where:

name

Is a 1 to 48 character field name for the defined field.

format

Is the optional display format for the defined field, separated from name by a slash (/). The display format for the field follows the rules for USAGE formats described under field attributes. The default value is D12.2.

expression

Can be either a mathematical or logical statement, made up of constants, database fields, and temporary defined fields.

The expression must end with a semicolon (;) followed by a dollar sign ($). A DEFINE is placed at the end of the segment it is associated with.

A defined field stored in a Master File can refer only to fields in its same segment. To create a defined field that refers to fields in other segments, create a temporary field using the DEFINE command prior to your report request.

Length:

1 to 44 characters

Permitted Values:

All characters and digits.

Example:

DESCRIPTION=STANDARD COST CATEGORY,$

Function:

Is optional, and is used only for documenting the meaning of a field in the Master File. It is ignored during processing. Since a Master File is a comma-delimited file that the server can read directly, it is possible to prepare reports in various formats whose subjects are the names and attributes of the data fields.

If the DESCRIPTION contains a comma (,), the entire text must be enclosed in single quotation marks ('). For example:

DESCRIPTION='TOTAL COST, NOT NORMALIZED',$

Another way to add comments to a Master File is to place them after the dollar sign ($).

Descriptions of DEFINE fields in the Master File are placed on separate lines.

For example:

DEFINE ITEMS_SOLD/D8 = INVENTORY - ORDERED
;DESC=DAMAGED ITEMS NOT INCLUDED,$

Note: When used on a DEFINE expression, the dollar sign ($) does not immediately follow the semicolon (;).

The semicolon (;) after a DEFINE must display on the same line as the attribute, which follows the DEFINE.

Alias:

FIELD

Length:

1 to 64 characters

Permitted Values:

All characters and digits.

Example:

FIELD=INVENTORY

Function:

Identifies the data items in a file. Names must be unique within a file.

The full field name is used as the default title for the data printed on reports. Hence, names representative of the data should be selected.

Names must begin with a letter, though they may contain numbers. Avoid names that might conflict with report column names (C1, C2, ...), row names (R1, R2, ...) or HOLD file aliases (E01, E02, ...). Also avoid reserved keywords such as PRINT, BY, ACROSS, and so on.

FIELDNAME has specialized functions when used with RECTYPE and MAPVALUE, as discussed at the beginning of this manual.

Alias:

FILE

Length:

1 to 8 characters

Permitted Values:

All characters and digits, but no embedded blanks.

Example:

FILENAME=EQUIP

Function:

Is optional, and is used for documentation purposes. It should correspond to the external file name of the Master File.

Alias:

KEY

Length:

1 to 66 characters

Permitted Values:

All characters and digits, but no embedded blanks.

Example:

GROUP=PUBKEY

Function:

Is used to describe the primary key in a keyed file or a field that is composed of subfields. The USAGE format and ACTUAL format of the GROUP is calculated using the USAGE and ACTUAL formats of the FIELDS that comprise the GROUP.

Names must begin with a letter, though they may contain numbers. Avoid using names that might conflict with report column names (C1, C2, ...), row names (R1, R2, ...), or HOLD file aliases (E01, E02, ...).

Alias:

PARENT

Length:

1 to 8 characters

Permitted Values:

All characters and digits, but no embedded blanks.

Example:

PARENT=CARSEG

Function:

Is the name of the segment that is the parent or "owner" of the current segment. In the Master File, the information describing the parent must precede any reference to it as a parent.

The first, or "root" segment, in a file cannot have a parent by definition, but the name "SYSTEM" may be used, or the attribute left blank. Every other segment must have a parent named. If no parent is named, the immediately preceding segment will be used by default.

Alias:

SEGMENT

Length:

1 to 8 characters

Permitted Values:

All characters and digits, but no embedded blanks.

Example:

SEGNAME=MODSEG

Function:

Identifies a collection of data fields. Segments which have a relationship to each other must have unique names within a given file description.

Alias:

FILESUFFIX

Length:

1 to 8 characters

Permitted Values:

RMS

Example:

SUFFIX=RMS

Function:

In order to identify the type of file the description applies to, the SUFFIX is given one of the following values:

Value

Meaning

RMS

A keyed RMS file, which uses a Master File DATASET= attribute and an Access File RMSFILE= attribute or a FILEDEF to locate and access data using the RMS System and its Indexes.

ISAM

An alternate suffix value for a keyed RMS file. ISAM is supported as an alternate to the RMS keyword for backward compatibility to FOCUS 6.x applications that used ISAM as its keyword.

Length:

1 to 64 characters.

Permitted Values:

All characters and values.

Example:

TITLE='Products'

Function:

Is optional, and enables you to supply an alternate column title to replace the field name that is normally used.

The syntax is

TITLE='text'

where:

text

Must be enclosed within single quotation marks (') and can contain 1 to 64 characters.

TITLE

cannot span more than one line in the Master File. If necessary, move the entire attribute to a line by itself. To display the TITLE on more than one line in the report, use commas to divide the text. To include blanks at the end of a column title, simply type them in and enter a slash (/) in the final blank position.

TITLE attributes do not apply when direct operations (PCT., AVE., ...) are used on the field. To rename such columns, use the AS phrase.

Changes:

You can override both field names and TITLE attributes with AS phrases in your request. You can issue a SET TITLE command to change the default titles to either the field names or titles supplied in the Master File. You can change the TITLE attribute in the Master File.

Note: Client tools using the API do not have access to the TITLE attribute. The TITLE attribute is available only with WebFOCUS.

Length:

1 to 8 characters

Function:

Defines the report display format of the data field. This attribute defines the data field type, length, and any edit options that are to be applied when the field values are printed. Special date formats, which are actually an extended series of edit options, can also be used.

The syntax is

USAGE=usage

where:

usage

Consists of three parts: tllleeeee

t = field type

lll = field display length

eeeee = edit options

A

1-4,095

Alphanumeric text

D

1-19

Decimal, double-precision numbers

F

1-9

Decimal, single-precision numbers

I

1-11

Integer values (no decimal places)

P

1-17

Packed decimal numbers

YYMD

10

Displayed as YYMD

H

Date-Time stamp data that uses formatting options to display raw data or formatted time data, date data or date-time data. See the Describing Data With WebFOCUS Language manual for a full list of options

%

Percent sign

Percent sign Displays a percent sign along with numeric data. Does not calculate the percent.

B

Bracket negative

Encloses negative numbers in parentheses.

c

Comma suppress

Suppresses the display of commas. Used with numeric format options M and N (floating and non-floating dollar sign) and data format D (floating-point double-precision).

C

Comma edit

Inserts a comma after every third significant digit, or a period instead of a comma if continental decimal notation is in use.

DMY

Day-Month-Year

Displays alphanumeric or integer data as a date in the form day/month/year.

E

Scientific notation

Scientific notation Displays only significant digits.

L

Leading zeroes

Adds leading zeroes.

M

Floating $ (for US code page)

Places a floating dollar sign $ to the left of the highest significant digit.

Note: The currency symbol displayed depends on the code page used.

MDY

Month-Day-Year

Displays alphanumeric or integer data as a date in the form month/day/year.

N

Fixed $(for US code page)

Places a dollar sign $ to the left of the field. The symbol displays only on the first detail line of each page.

Note: The currency symbol displayed depends on the code page used.

R

Credit (CR) negative

Places CR after negative numbers.

S

Zero suppress

Zero suppress If the data value is zero, prints a blank in its place.