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 2 removed 2 lines
!!!NAMING STANDARDS AND CONVENTIONS
At line 7 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 12 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 14 changed 3 lines
!!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.
!!Function Names
At line 18 changed one line
In the professional interface the first character indicates the type of function and what it is used for.
1. First character indicates the type of function
* "C" - Copy screen e.g. [CBCG]
* "D" - Date (Calendar) controlled screen eg [DAAL]
* "E" - Embedded screen e.g. [EALR]
* "F" - Find screen e.g. [FIND_MGREAS]
* "I" - Interactive screen e.g. [IEAS]
* "L" - Load program e.g. [LMTD]
* "M" - Dialog screen e.g. [MAAL]
* "P" - PA screen e.g. [PEAS]
* "R" - Report program (does not normally update data) e.g. [RDEN]
* "U" - Update program (usually produces a report as well) e.g. [UPCALC]
* "V" - View only screen e.g. [VEEP]
* "X" - Extract program e.g. [XMFN]
2. Second letter indicates the module that this function belongs to (.e.g M = Ad[m|]inistration P = [P|]ayroll etc.)\\
3. 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 20 removed 24 lines
%%information There are some exceptions to the rules when there are one off items but the majority conform to this standard.%%
Screens
||Character||Type of Function
|C|Copy screen e.g. [CBCG]
|D|Date (Calendar) controlled screen eg [DAAL]
|E|Embedded screen e.g. [EALR]
|F|Find screen e.g. [FIND_MGREAS]
|I|Interactive screen e.g. [IEAS]
|M|Dialog screen e.g. [MMRE]
|P|PA screen e.g. [PEAS]
|V|View only screen e.g. [VEEP]
Reports
||Character||Type of Function
|L|Load program e.g. [LMTD]
|R|Report program (does not normally update data) e.g. [RDEN]
|U|Update program (usually produces a report as well) e.g. [UPCALC]
|X|Extract program e.g. [XMFN]
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)
At line 46 changed 16 lines
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.
1. First character (W) indicates the function is a Self Service function. \\
2. 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
3. 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 65 removed 2 lines
!!Product Modules
Each technical product module (SS aside) has a 2 character code and a single character mode which are shown in the chart below. Both of these are used in different aspects within the system.
At line 68 removed one line
%%information The technical product modules may vary from license product modules (or business groupings) as they are different views of the world.%%
At line 70 removed 17 lines
||Product Module||2 Char Code||1 Char Code
|System Configuration| AM| M
|Attendance Control| AT| A
|Benefits Administration| BE| B
|Common Definitions| CM| D
|Training and Development (TD) |CP| C
|Conversion| CV| V
|Forecasting and Costing| FC| F
|Human Resources| HR| E
|Labor Relations| LR| L
|Payroll| PR| P
|Recruitment| RE| R
|Pension System |RX| X
|Salary Administration| SA| S
|Safety and Health| SH| H
|Time Scheduling| TS| T
General Utilities UT U
At line 88 changed 2 lines
!!Business Roles
In the Self Service environment functionality is naturally grouped by Business Roles and each of these business roles is assigned a single character code which is used in function names to easily recognize which role the function belongs to.
[{If var='loginstatus' contains 'authenticated'
At line 91 removed 23 lines
In the chart below we show each single character followed by what they mean as well as IF they have physical Business Role in the roles table and whether that role gets automatically or manually assigned to users.
Automatically assigned roles should NOT be physically granted to users as the system will grant them to them IF they qualify.
||Character||For||Business Role||Assigned How
|A|HR Administrator|[WWW_HRADMIN]|Manually
|C|Candidates|[WWW_CANDIDATE]|Manually – 1 user only
|E|Employees|[WWW_EMPLOYEE]|Manually
|G|General Use| N/A |
|M|Managers|[WWW_MANAGER]|Manually
|P|Publicly Available|[WWW_PUBLIC]|Manually – 1 user only
|R|Recruiters|[WWW_RECRUITER]|Automatically
|S|Schedulers|[WWW_SCHEDULER]|Automatically
|V|Approvers|N/A|
!!Oracle Reports versus Windward
For Oracle Reports the standard report file name was composed of the 2 character product code, an underscore, the function name and then “.rdf”.
For Windward the template file name no longer contains the product code. Thus the structure is simple function name and then “.rtf”.
For example: AT_RAAC.rdf (in Oracle) and RAAC.rtf (in Windward)
At line 115 changed 2 lines
![Notes|Edit:Internal.NAMING+CONVENTION]
[{InsertPage page='Internal.NAMING+CONVENTION' default='Click to create a new notes page'}]
![Discussion|Edit:Internal.NAMING+CONVENTION]
[{InsertPage page='Internal.NAMING+CONVENTION' default='Click to create a new discussion page'}]
}]
This page (revision-21) was last changed on 26-Nov-2021 10:22 by rmorrellTop