An identification such as a data element name

A clear data element definition

One or more representation terms

Optional enumerated values Code (metadata)

An identification label or name (‘term’)

A business definition

Optional enumerated values Code (metadata)

Only alphabetic (A-Z), numeric (0-9), and special characters (e.g., hyphen, colon, underscore) which are appropriate to the language being used are allowed in a name. No blanks are permitted.

The first character of the data name must be alphabetic (A-Z).

Data names may not start with verbs

The maximum length of a name (including special characters) is 30 characters.

Each name must be unique

Each name must be clear and accurate to reflect a condensed version of the data description.

Abbreviate only when it is necessary to reduce a name to 30 characters or less.

Effective with this transmittal, names in COBOL applications will not contain abbreviations for words of four characters or less.

Each name must contain a class word. A class word specifies the nature of the data and must be the right-most word in the name (e.g., TAXPAYER-BIRTH-DATE). The EDSG (Enterprise Data Standards and Guidelines) provides a list of Standard class words. Other class words must be submitted to the Data Engineering (DE) for approval when the data cannot be identified by examples from EDSG

Write a sentence or a paragraph containing a full but concise description of the entity (user, system, run, module, report, form, file, record, group, data element, schema, subschema, area, set) explaining what it is. This description should be retained as a part of the data dictionary entry.

A close relationship must exist between a data name and its description; one should reflect the other. A general or broad description requires a general name.

Do not use the source or destination of the entity. Avoid: This entry comes from previous Run to next Run (for instance from Run 123 to Run 456.

Do not specify the processing done on the entity, Avoid: This amount is the result of price times quantity.

Attach system/function names or form numbers to data items only when the description limits its use to a particular function. For example: EXAMINATION-CASE-START-DATE and COLLECTION-CASE-START-DATE could be uses with system names attached because their descriptions would be basically different.

Eliminate those words in the description which are not essential to the meaning. Note that these words are deleted only for the purpose of deriving a name; the full description remains intact in the data dictionary entry.

Unnecessary words usually include articles, conjunctions, prepositions, and some modifiers. However, in some cases these types of words may be necessary to the meaning.

Arrange the remaining words by placing the class word as the last word on the right of the name, and reorganizing the other words into a meaningful order. Some change in the form of a word may be necessary; that is a verb may be changed to a noun or adjective (for example: collect to collection or collected)

In some instance, a good description (as suggested above) will not result in an adequate name. If, after reworking the description, the resultant name is still unacceptable, then persons involved in name development must use their knowledge of the subject data in selecting key words for the name.

Always use common IRS acronyms (required acronyms) for groups words in the name (e.g., IMF for Individual Master File, DLN for Document Locator Number). A list of these acronyms is included as IT PAL Standard Abbreviations and Acronyms List. (Note: Those items which are marked by two pound signs (##) are required

Separate the remaining words and required acronyms with the appropriate special character.

Count the remaining alphanumeric characters and special characters. Substitute accepted acronyms or abbreviations found on IT PAL Abbreviations and Acronyms until the name has 30 or fewer characters (including approved special characters).

When only the singular form of a word is givens as the abbreviation’s meaning, the plural of the word may be assumed acceptable and vice versa, if that form will make the name more meaningful. Similarly, tenses different from those listed in the meaning may be assumed acceptable without an addition to the approved abbreviation list. For example:

The list of standard abbreviations and acronyms are maintained in IT PAL Standard Abbreviations and Acronyms List

Category:Norman

Subcategory:Software - Development

Initiating Service:XML Data Element

RFC Type: XML Data Element

Assignment Group: DATA ENGINEERING UNSTRUCTURED DATA PRACTICE SERVICES

Reason for Change: Business Requirement

Affected Service: XML Library – IRS COMMON

Save created Change Request

Requested Service: Enterprise Services *IT Engineering Customer Support or Solutions Engineering *IT Engineering XML ChangeManagement

Requested Service Sub-category: Solutions Engineering Data Engineering

All Projects: XML Component Change Template XMLCR_ProjectName_mmddyyyy.xlsx Template for XML component /element creation or changes.

All Projects: XML Message Structure change TemplateXMLCR_Message_ProjectName_SeqNum_mmddyyyy.xlsx Template for XML message schema creation or update existing message.

MeF & IRIS: XML RLO Change or Updated TemplateTYyyyy XML RLO form FormNumber as of mmddyyyy.xlsx For new RLO creation or update existing.