Standard Master File Attributes for a Millennium Data Source

In this section:

For each Master File, the server must access the appropriate Millennium database ID (DBID). There are two methods for assigning the DBID to a Master File (see Specifying the Millennium DBID and TRANID). Depending on your assignment method and on your Millennium lead transaction ID, you may need an Access File in addition to the Master File:

When you issue a report request, the server processes the request with the following steps:

  1. It locates the Master File specified by the request.
  2. It examines the SUFFIX attribute in the Master File. Each Master File that describes a Millennium database must include the attribute SUFFIX=CPMILL for Millennium Release 3. When the server detects this SUFFIX, it passes control to the adapter.
  3. It examines the Master File member name. If an Access File PDS has been allocated, and if it has a member with the same name as the Master File, the adapter locates that Access File.

    The adapter uses the information contained in both the Master File and the Access File (if there is one) to generate the Millennium calls required by the report request. It passes these calls to Millennium.

  4. The adapter retrieves the data generated by the Millennium DBMS and returns control to the server. For some requests, the server may perform additional processing on the returned data.

Top of page

x
Master Files

The following partial Master File illustrates how to describe a Millennium file. The numbers to the left refer to the explanatory notes that follow the sample:

1. FILENAME=ACCTMAST, SUFFIX=CPMILL [,$] 
2. SEGNAME=ROOT,SEGTYPE=S0,$ 
3. FIELDNAME=DELETE_FLAG    ,ALIAS=     ,USAGE=A1  ,ACTUAL=A1  ,$ 
4. GROUP=CONTRL_KEY         ,ALIAS=KEY  ,USAGE=A23 ,ACTUAL=A23 ,$
       FIELDNAME=CORP       ,ALIAS=     ,USAGE=A3  ,ACTUAL=A3  ,$
       FIELDNAME=ACCOUNT    ,ALIAS=     ,USAGE=A10 ,ACTUAL=A10 ,$
       FIELDNAME=COST_CENTR ,ALIAS=     ,USAGE=A10 ,ACTUAL=A10 ,$

Note:

  1. Each Master File begins with a file declaration that names the file and describes the type of data source-a Millennium file in this case. The file declaration has two attributes, FILENAME and SUFFIX.

    The FILENAME can be any one- to eight-character name that complies with server naming conventions. For documentation purposes, you can give it the same name as the Master File member name.

    SUFFIX=CPMILL indicates that Millennium Release 3 is required for data retrieval.

  2. Each type of Millennium record described in a Master File requires a segment declaration consisting of at least two attributes, SEGNAME and SEGTYPE. The SEGNAME value is ROOT, and the SEGTYPE value is S0 (S zero).
  3. To describe a Millennium field in the Master File, you must include a FIELD record (or, for a key field, a GROUP record) that specifies the attributes FIELDNAME, ALIAS, USAGE, and ACTUAL:
    • The FIELDNAME value is the server name for the field. Since field names appear as default column titles on reports, select names that are representative of the data. You can specify field names, aliases, or a unique truncation of either in requests.
    • The ALIAS value in the Master File is an optional alternate name for the field, except if the field is a key field.
    • The USAGE format describes how the server will display the value in reports.
    • The ACTUAL format describes how the data field exists in storage. It must conform to the COBOL FD statement for the field. See ACTUAL Format Conversion Chart for how to determine ACTUAL formats.
  4. You must describe the primary key field with the GROUP attribute instead of the FIELDNAME attribute, and you must assign its alias as ALIAS=KEY.

    If the key field is composed of multiple elementary fields, describe the elementary fields directly below the GROUP record. The USAGE format of the GROUP must be alphanumeric. Its length is the sum of the server internal storage lengths for the individual fields. The ACTUAL format of the GROUP must also be alphanumeric. Its length is the sum of the subordinate field lengths.


Top of page

x
ACTUAL Format Conversion Chart

The ACTUAL attribute indicates the server representation of Millennium field formats. Use the following chart as a guide for describing ACTUAL field formats:

COBOL FORMAT

COBOL PICTURE

FOCUS INTERNAL STORAGE

ACTUAL FORMAT

USAGE FORMAT

DISPLAY
DISPLAY
DISPLAY
DISPLAY

X(4)
S99
9(5)V9
99

4
2
6
2

A4
Z2
Z6.1
A2

A4
P3
P8.1
A2

COMP
COMP
COMP
COMP
COMP-1

S9
S9(4)
S9(5
)S9(9
)-

4
4
4
4
4

I2
I2
I4
I4
F4

I2
I4
I5
I9
F6

COMP-2

-

8

D8

D15

COMP-3
COMP-3
COMP-3

9
S9V99
9(4)V9(3)

8
8
8

P1
P2
P4

P1
P5.2
P8.3

Note: The USAGE lengths shown are minimum values. You can make them larger and add edit options. You must allow space for all possible digits, a minus sign for negative numbers, and a decimal point in numbers with decimal digits.



x
Specifying the Millennium DBID and TRANID

How to:

You must assign a Millennium database ID (DBID) to each Master File. You can use either of the following techniques to assign the DBID:

Create an Access File if:

The Master File member name must either include the appropriate DBID assignment, or it must identify an Access File, or both.



x
Syntax: How to Specify the Master File Member Name
{xxxxxdbd|anyname}

where:

xxxxx

Is a name, which can be up to five characters long, that conforms to file-naming conventions.

dbd

Is a 3-character DBID. The adapter accesses this DBID unless an Access File member named xxxxxdbd exists and assigns a different DBID. When both the Master File member name and the Access File assign the DBID, the DBID from the Access File takes precedence.

anyname

Is the name of a member in the Access File data set that contains the DBID and/or lead transaction ID to use.

As an example, consider the Master File in Master Files. It is member ACCTMAST in the Master File PDS, indicating that member ACCTMAST in the Access File data set contains the required DBID and/or TRANID.


Top of page

x
Access Files

If an Access File is required, the server JCL must allocate the PDS containing Access File members to DDNAME FOCPRV.

[DBID=dbd], [TRANID={tran|M3LL}]  ,$

where:

dbd

Is the three-character Millennium DBID associated with this file. You can omit this parameter if you included the appropriate DBID as the last 3 characters of the Master File member name.

tran

Is the optional Multi:Mill lead transaction ID. M3LL is the default lead transaction ID for Millennium Release 3 unless your site chooses a different default value during installation. For more information, check with your systems support staff.

Note: Every Master File named in a single request (such as a join of two databases) must use the same TRANID.

The following is a sample Access File:

DBID=GLM,$

This Access File points to:


iWay Software