Plan/Include Naming Conventions
Use
the following structure for physical file names
plan usage_entity name_hierarchy name/attributes area name/attribute name
where:
- plan usage
- Is a prefix that identifies the specific usage (purpose) of
the Plan. Valid values are:
- entity name
- Describes the coverage of entire Plans. The following valid
values specify the two main categories:
- address
- party (the person
or client)
- hierarchy name, area name, attribute name
- Shows either the include structure description (for example,
MAIN or GLO), or the parts of the entity (for example, NAME, TITLE,
or ID). Each is represented by a separate include. The includes
are stored as a hierarchy, as shown in the following example.
There
may be other prefixes for match and merge Plans and for state flags.
There may be separate Plans for the rest of the entities.
Example
The
following is an example of a hierarchy for party, without the Plan
usage prefix.
_party_MAIN. Only inputs, outputs, and
value initialization.
- party_GLO.
Only includes structure.
- party_PRO.
Structural profiling of data, for example, ABCDX profiling (optional).
- party_CLN
- party_CT.
Detection of client type (person versus company).
- party_PUR. Preparation
of dec_xxx and initialization of pur_xxx values
for all subsequent includes.
- party_GNDR. Cleansing
of gender values.
- party_TITLE.
Cleansing of academic or social titles.
- party_NAME.
Cleansing of names.
- party_DATE.
Cleansing of date or date time values.
- party_ID.
Cleansing of personal IDs (for example, NHS or NIN).
- party_PAPERS. Cleansing
of papers (for example, ID or passport).
- party_OTHER.
Cleansing of other attributes (optional).
- party_AUX.
Value preparation for match and merge.
- party_M&M.
Match and merge (optional).
- party_STA.
Optional Plan for statistic counts.
The address
Plan hierarchy is based on the same principles:
_address_MAIN
- address_GLO.
Only includes structure.
- address_PRO.
Structural profiling of data, for example, ABCDX profiling (optional).
- address_CLN
- address_PUR.
Preparation of dec_xxx and initialization
of pur_xxx values for all subsequent includes.
- address_ADR.
Cleansing and validation of addresses.
- address_AUX.
Value preparation for match and merge.
- address_EXT.
Optional Plan for exporting data before match and merge.
- address_M&M.
Match and merge process (rarely used for addresses).
- address_STA.
Optional Plan for statistic counts.
The structure
varies according to project specifics. Structures are not mandatory,
but they are recommended as a best practice.
The MAIN Plan
name starts with an underscore (_), which moves this file to first
place in the file hierarchy and provides you with better orientation
in the folder.