This page (revision-21) was last changed on 26-Nov-2021 10:22 by rmorrell

This page was created on 26-Nov-2021 10:22 by Administrator

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
21 26-Nov-2021 10:22 6 KB rmorrell to previous

Page References

Incoming links Outgoing links
NAMING CONVENTION AND STANDARDS
NAMING CONVENTION AND STANDARDS

Version management

Difference between version and

At line 3 removed one line
The intention of this document is to help people understand the discipline used for coming up with function names, etc. as well as show changes or new items.
At line 8 changed 3 lines
The table name is assembled by the prefix (P2K_), the module abbreviation (CM_) and then the entity name in plural (DEPARTMENTS) thus: P2K_CM_DEPARTMENTS.
If the entity name has multiple words then these are separated by underscores (i.e. P2K_PR_PAY_LINE_DETAILS)
If the plural of the entity name is an irregular ending, then the correct pluralization applies (i.e. P2K_HR_IDENTITIES from the IDENTITY entity)
The table name is assembled by the prefix (P2K_), the module abbreviation (CM_) and then the entity name in plural (DEPARTMENTS) thus: [P2K_CM_DEPARTMENTS].
If the entity name has multiple words then these are separated by underscores (i.e. [P2K_PR_PAY_LINE_DETAILS])
If the plural of the entity name is an irregular ending, then the correct pluralization applies (i.e. [P2K_HR_IDENTITIES] from the IDENTITY entity)
At line 13 changed one line
View names are similarly constructed to table names but it is differentiated as a view by the inclusion of a letter "V" at the beginning of the third section. For example, P2K_HR_EMPLOYMENTS is a table name, P2K_HR_VEMPLOYMENTS is a view that references this table and P2K_HR_IDENTITIES together.
View names are similarly constructed to table names but it is differentiated as a view by the inclusion of a letter "V" at the beginning of the third section. For example, [P2K_HR_EMPLOYMENTS] is a table name, [P2K_HR_VEMPLOYMENTS] is a view that references this table and [P2K_HR_IDENTITIES] together.
At line 15 changed one line
!!Function Names
!!Function Names (IMFN)
The standard naming convention is for functions to start with a single character that dictates what type of function it is – see chart below.
At line 17 changed one line
The first character indicates the type of function
In the professional interface the first character indicates the type of function and what it is used for.
%%information There are some exceptions to the rules when there are one off items but the majority conform to this standard.%%
Screens
At line 24 changed 2 lines
|L|Load program e.g. [LMTD]
|M|Dialog screen e.g. [MAAL]
|M|Dialog screen e.g. [MMRE]
At line 31 added 5 lines
|V|View only screen e.g. [VEEP]
Reports
||Character||Type of Function
|L|Load program e.g. [LMTD]
At line 29 removed one line
|V|View only screen e.g. [VEEP]
At line 32 changed 2 lines
The second letter indicates the module that this function belongs to (.e.g M = Ad[m|]inistration P = [P|]ayroll etc.)\\
The rest of the letters are a useful mnemonic of what the function is intended to do. For interactive screens, it is often the [table alias|Table_Alias] of the table primarily maintained (e.g. IEID is an [I|]nteractive screen that maintains the [EID|] table, UPCALC is an [U|]pdate process for [P|]ayroll [CALC|]ulation)
The second letter indicates the module that this function belongs to (.e.g M = Ad(m)inistration P = (P)ayroll etc.)\\
At line 42 added 2 lines
The rest of the letters are a useful mnemonic of what the function is intended to do. For interactive screens, it is often the [table alias|Table_Alias] of the table primarily maintained (e.g. [IEID] is an (I)nteractive screen that maintains the (EID) table, UPCALC is an (U)pdate process for (P)ayroll (CALC)ulation)
At line 36 changed 12 lines
#First character (W) indicates the function is a Self Service function. \\
#The second letter indicates the type of Self Service role that would make use of the function.\\
#* "WA" - Administrator, and/or Web Site Administrator and/or Human Resource Administrator
#* "WC" - Candidate role
#* "WE" - Employee role
#* "WG" - General e.g [WGDPC] (View Employees By Position)
#* "WM" - Manager role
#* "WP" - Public e.g [WPRPO] (potential candidate could search for open postings through a link on a client's website)
#* "WR" - Recruiter role
#* "WS" - Scheduler role
#* "WV" - Approver role
#The third letter references the product the function is found within, for example the 'B' in WEBEN indicates WEBEN is tied to the Benefits module. The rest of the letters are a useful mnemonic of what the function is intended for, for example the 'EN' in WEBEN indicates WEBEN is for enrollments.
In Self Service, the function type character is always ‘W’ for web component.
The second character indicates the type of Self Service role that would make use of the function.\\
|WA|Administrator, and/or Web Site Administrator and/or Human Resource Administrator
|WC|Candidate role
|WE|Employee role
|WG|General e.g [WGDPC] (View Employees By Position)
|WM|Manager role
|WP| Public e.g [WPRPO] (potential candidate could search for open postings through a link on a client's website)
|WR|Recruiter role
|WS|Scheduler role
|WV|Approver role
The third letter references the product the function is found within, for example the 'B' in [WEBEN] indicates [WEBEN] is tied to the Benefits module. The rest of the letters are a useful mnemonic of what the function is intended for, for example the 'EN' in [WEBEN] indicates [WEBEN] is for enrollments.
At line 53 removed one line
Note that technical product modules may vary from license product modules (or business groupings) as they are different views of the world.
At line 68 added 2 lines
%%information The technical product modules may vary from license product modules (or business groupings) as they are different views of the world.%%
At line 80 changed 3 lines
|A|HR Administrator|WWW_HRADMIN|Manually
|C|Candidates|WWW_CANDIDATE|Manually – 1 user only
|E|Employees|WWW_EMPLOYEE|Manually
|A|HR Administrator|[WWW_HRADMIN]|Manually
|C|Candidates|[WWW_CANDIDATE]|Manually – 1 user only
|E|Employees|[WWW_EMPLOYEE]|Manually
At line 84 changed 4 lines
|M|Managers|WWW_MANAGER|Manually
|P|Publicly Available|WWW_PUBLIC|Manually – 1 user only
|R|Recruiters|WWW_RECRUITER|Automatically
|S|Schedulers|WWW_SCHEDULER|Automatically
|M|Managers|[WWW_MANAGER]|Manually
|P|Publicly Available|[WWW_PUBLIC]|Manually – 1 user only
|R|Recruiters|[WWW_RECRUITER]|Automatically
|S|Schedulers|[WWW_SCHEDULER]|Automatically
At line 90 removed 29 lines
!!Function Naming Convention (IMFN)
The standard naming convention is for functions to start with a single character that dictates what type of function it is – see chart below.
!Professional
In the professional interface the next 3 or 4 characters (sometimes more) are normally taken as an abbreviation of what the function does or from the alias of the table that drives the function.
!Self Service
In self service though the function type character is always ‘W’ for web component. The second character here comes from the section above on Business Roles to dictate where or by whom this function is used.
The remaining characters are similar in nature to that of the professional interface.
!Function Types
Supplied functions normally start with one of the characters shown in the chart below which designates what that function is used for. Note that there are some exceptions to the rules when there are one off items but the majority conform to this standard.
Type Character Meaning
Screens
* C For deep Copying records
* D Date/Calendar driven screens
I Normal Interactive screens
* M Pop up Dialog screens
* P Personnel Action (PA) based screens
V View only screens
W Self Service designated function
Reports
+ L Load Processes
R Non-Update Reports
U Update Processes
+ X Extract Processes
* - New or meaning change for ePersonality
+ - New or meaning change with Windward Reports project.
At line 128 removed 2 lines
[{If var='loginstatus' contains 'authenticated'
At line 131 changed 4 lines
![Discussion|Edit:Internal.NAMING+CONVENTION]
[{InsertPage page='Internal.NAMING+CONVENTION' default='Click to create a new discussion page'}]
}]
![Notes|Edit:Internal.NAMING+CONVENTION]
[{InsertPage page='Internal.NAMING+CONVENTION' default='Click to create a new notes page'}]
This page (revision-21) was last changed on 26-Nov-2021 10:22 by rmorrellTop