Naming Standards

Naming (Database Entities)

This section contains the naming standards for the following database-related entities and how to implement them on IDD:

ADS Applications, dialogs, and maps

Areas

C/A Data Dictionary reports

Element Help Modules

Elements

Help Modules

Logical records (LRF)

Path status (LRF)

Queue area ID's

Schemas

Schema records

Scratch area ID's

Sets

Storage ID's

Subschemas

Tables

Tasks

User ID's

View ID's

Work and map records

Implementation

All entities on IDD may only be added by using the ADS task ADDIDD. Thus, when changing a name of an entity, the following procedure should be used.

Log onto IDMS30
Run ADS UNMA1000
Choose the ADD option
Enter the new name using the naming standards
Enter description
Enter comments - include the old name of the item changed
Add the entity
Exit the program
Enter IDD
Display the old (module, record, etc. )
Delete the 'DISPLAY' line
Change ADD to MOD
Change the name from OLD to NEW
Delete the 'USER IS. ..', 'REGISTERED...', that is all between DESCRIPTION' and 'USED BY'
Modify code for any changes
Hit ENTER (the code is now renamed)
Delete the old item from IDD

Remember to change all dialogs and batch programs which may use the item's new name as at the time of migration the old name is no longer on production. A recent problem occurred (8/87) when a lower level dialog's work record was changed to meet the new naming standards, but the higher level dialogs which passed values down were not changed. The problem was compounded by the fact that a cross reference of the old name with the new did not exist and it took quite a bit of time and effort correcting the error.

By documenting the old name in the comments section of the new name, there is an audit trail which otherwise may be lost. As problems have occurred due to a lack of audit trail, this procedure is to be implemented as a standard.

ADS Applications, Dialogs, and Maps

All these entities must be of the format 'PPPXNNNS' where 'X' specifies the entity type, 'PPP' is the three character system identifier (see System Names), 'NNN' is a sequential number, and 'S' is a 0 (zero). The entity types are

D Dialog

M Map

A ADS Applications.

Areas

IDMS area names are assigned by the DBA. Names will be 16 characters or less and end with the qualifier 'AREA'.

C/A Data Dictionary Reports

C/A reports for the Data Dictionary have names 'DREPORT NNN' where 'NNN' is a number less than 100. Modification of these reports should be named 'DREPORT DNNN', where 'D' is a digit greater than 1. Reports of general interest developed in IS should have 099 < 200.

Element Help Modules

The format for map element help modules is 'PPPHENNN' where ' PPP' is the system identifier, and 'NNN' is a unique number within the system.

Elements

The naming standards for elements can be found in the manual IDMS Data Handbook. The rules and standards specified there must be followed for all elements, element synonyms, and record elements. If you have any questions or need help with elements, talk to the data analyst.

Help Modules

The format for map help modules is 'PPPHNNNN' where 'PPP' is the system identifier, and 'NNNN' is the same as the map's number.

Logical Records (LRF)

Logical records are defined and named by the DBA. Their names may not exceed 16 alphanumeric characters in length.

Path Status (LRF)

Path status names are assigned by the DBA. Names have no more than 32 characters.

Queue Area ID's

Queue identifiers have the format 'PPPQNNNN-*' where 'PPP' is the three character system identifier (see System Names), and 'NNNN' is a sequential number. '*' represents a qualifier. The queue identifier can be up to 16 characters in length.

Schemas

Schemas are assigned by the DBA. Names have a maximum of 8 characters. any purchased package with university-related data must be modified so that its data will be in the university production schema. All schema version numbers must be 1.

     Test schema:          UNMSCHMA Version 1
     Production schema:    UNMSCHMA Version 1

Schema Records

Schema record names are determined by the Project Leader, the DBA, and the DA. Record names have a maximum of 8 characters.If a new system (developed in IS or by a vendor) is using a name which is already assigned to another schema record, that new system will have to change its record name.

Scratch Area ID's

Identifiers for scratch areas may not exceed 8 characters. They should reflect the dialog or program name by which they were created. They should use the same system identifier and three digit number, and have a one-character suffix.

Sets

Set names are assigned by the DBA and have no more than 16 characters.

Storage Area ID's

Storage ID's are 4 characters in length. They should have the format 'PPPA' where 'PPP' is the three character system specifier and 'A' is an alphanumeric character.

Subschemas

Subschema names have the format 'PPPZNNNS' where 'PPP' is the three character system identifier (see System Names), 'NNN' is a sequential number (same as used in dialog or program), and 'S' is 0-9 or A-Z for multiple subschemas used by the same program.