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 added 3 lines
!!!Naming Standards and Conventions
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 51 added 3 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.
Note that technical product modules may vary from license product modules (or business groupings) as they are different views of the world.
At line 55 added 41 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
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.
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
Function Naming Convention (IMFN)
Structure
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.
At line 97 added 25 lines
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.
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)
This page (revision-21) was last changed on 26-Nov-2021 10:22 by rmorrellTop