Professional Documents
Culture Documents
Implementation of Oracle
Time and Labor (OTL).
An internal HP guide to Configuration and Extending
OTL for Non-Recurring Elements (e.g. Overtime claims).
Natha Modhawadia
It can be used as reference for Oracle HCM/OTL Technical and Functional Consultants for
implementation as well as Support Analyst for support purposes.
This document is not intended for Training, usage or a guide to Work Instructions.
Foreword
It is recommended the steps followed in the document should be the same as development steps.
Please refer to Oracle’s release document for the full implementation guide.
References –
http://www.otlspecialists.com/
http://www.oracle.anilpassi.com/
1.0 OTL Overview
Oracle Time and Labor (OTL) is a module that can meet your business requirements for non-
recurring Time entry (for example Overtime hours, other compensation payments etc).
This document will discuss the concept of implementing non-recurring payments such as Overtime
through OTL’s web – based and Professional Forms entry. The examples used within document are
successful implementations of OTL.
Any OTL implementation will encompass business requirements for capturing time, validation and
approval.
Time Entry
Employees have the ability to enter time through a web – based self service page in different
formats known as a Timecard. Timecards can be customised so that the employee can see all the
fields relevant to them. Instructions and messages can be used to aid the employee in entering their
timecards quickly and effectively.
Timecards can also be entered on behalf of the employee (if the employee doesn’t have Self Service
access) through Timekeeper. Timekeeper is a standard OTL responsibility that can containthe same
fields, messages, functionality and Time Entry Rules as the Self Service based solution.
Element level validation can also be included so that claims, adhere to rules define in the element
Input Value definitions.
Approval
Once the timecard is entered and submitted for approval, Oracle Workflow throughseeded workflow
will applybusiness rules to process the OTL Timecards. These can be monitored through Workflow
Administrator (New) for support, traceability and audit.
Approval styles can be created and the pre-defined rules include; OTL Auto Approve and Approve on
Submit can be defined.
HR Supervisor rules can be administered so that only Line Managers are able to approve claims along
with standard delegation and vacation rules. Furthermore, additional approval can ensure other
employees in the same organisation can approve depending on the type of Claim against specific
Roles and Positions.
Standard Timeouts and Deferred workflow background processes can be created to extend business
processes.
2.0 Start up Checklist
This topic will list the basic steps for the implementation of OTL into a development environment.
Please ensure that the latest version of Oracle HCM and OTL Release 11i with the latest patchset is
installed.
All configuration and business requirements should be documented in the Application and Security
BR100 and followed in the same order as this document.
Any extensions for Time Entry rules, Fast Formulas and Custom Timecard should be documented in
MD050’s/MD070’s and TE020’s.
Oracle Applications 11i +, which you use to set up functions, menus, responsibilities,users,
Flexfields, time periods, element sets, web page instructions, and all the rulesfor time
management, entry and approval.
PL/SQL development tool to develop custom code for validation, packages and
Text Editor to be used to edit loader files to configure timecard layouts (filed in Unix).
4.0 System Administration Pre-req
4.1 Create Responsibilities
(If more than one business group, create separate responsibilities and attach the profiles as defined
below for each business specific group).
1) Using the Menu Global OTL Application Developer, create Responsibility XX Global OTL
Application Developer.
2) Customise the Self Service Time and Expenses (using the Time and Expense Self Service
menu) as XX Self Service Time and Expenses
If iExpenses is not required, then the following Menu exclusions need to be created when
defining the responsibility as these are only required if also including iExpenses:
4) Ensure the Workflow Administrator Web (New) exists for support of Timecards.
HR: Security Profile and HR: Business Group profile option for every new responsibility.
HR: User Type profile should be set to HR with Payroll User
OTL: Allow Change Group Timekeeper profile set to Yes
OTL: Defer approval process on timecard submission Set to No
Custom Information Messages can be added to Self Service and Timekeeper entry/Review pages –
Please refer to the section Customisation of Self Service Timecards.
Custom Error Messages related to Time Entry rules and Fast Formulas can be added and referenced
within code and passed into to Self Service and Timekeeper entry screens.
5.0 Payroll and Element Configuration
5.1 Set up Elements for Time Entry
Navigation: XX HR Configuration Manager> UK HRMS Super User Manager > Total Compensation
> Basic > Element Description
As per business requirements, create all elements that are to be used to for Time Entry.
Element Definition
Must be Non-Recurring
Must have Allow Multiple Entries flagged to Yes
Input Values
Have one Input Value Called Hours in Format Hours in Decimal format (2 places)
o Flagged as Required
o Flagged as User Enterable
o Flagged as Database Item
Have a second Input Value called Date Claimed in Format Date
Note – It is imperative that the input values are as per the above or else Time Entry will fail with
errors.
5.2 Set up Element Links
Navigation: XX HR Configuration Manager> UK HRMS Super User Manager > Total Compensation
> Basic > Link
As per business requirements, create links that will be used for Time Entry.
Note – OTL Eligibility can be defined as an alternative or used in conjunction with Element Links and
is discussed in section Define Preferences (Rules/Eligibility Criteria) of this document.
5.3 Define Element Sets
Navigation: XX HR Configuration Manager> UK HRMS Super User Manager > Payroll > Element
Sets
Once the business requirements have identified the basic set of employee rules of what employees
can claim for and see, we can begin to build up the OTL element sets. This is the final grouping of
employee rules.
For example below we have the example where the Element Set includes only Employees whose
Contract terms are ‘The Deal’ (on their People group Flexfield) and their Grade Link Type (alsoon the
People Group Flexfield) are on ‘Non – Spinal’.
Building up the matrix of these various combinations is the first task to building up the OTL solution.
Enter the Name of the Element Set and include (or Exclude – Post Go live) those elements you want
as part of the set. The Element Sets specified here is then propagated and fed into OTL.
6.0 OTL Configuration
6.1 Generate Flexfield andMapping InformationProcess
Navigation: XX OTL Application Developer >Process and Reports>Submit Requests>Single
Request>Generate Flexfield and Mapping Information
The Generate Flexfield and Mapping Information process creates context and segmentsin the OTL
Information Types Flexfield to hold the element and Key Flexfield.
It creates a context for each element and Flexfield, andsegment for each element input value and
Flexfield segment.
** You must run this process on initial set up for Each Element Set Created in the previous section,
and run this process later if you change theHR key Flexfields set of elements for which youare
holding information in the time store, or the input values of these elements.
This concurrent process will create Alternate Names sets within OTL which will include the Alternate
Names for the elements created in the element sets in the previous set up.
Parameters:
Delete Definition – Set to No on initial run to create the Alternate Name Mappings.
Set to Yes if you want to delete the Alternate Name Definition and
re-create it again with a new set of elements taken from Element
Sets
Set to Yes if you want to delete this Alternate Name Mappings.
If you set to Yes, you will still have to manually delete the
set from Alternate Names form in OTL.
Element Set – Enter the Element Sets created in the previous section.
Effective Date – Enter Effective Date (usually a date in the past).
Xx Flexfield – Default to Yes for all
6.2 Define Alternate Names
Navigation: XX OTL Application Developer > Alternate Names>Alternate Names Definition
Alternate Names are used to configure LOV’s on a Timecard Layout. You can make the Elements
have a meaningful name as well as restrict values to the user through this functionality.
The Alternate Names are created once the Generate Flexfield and Mapping Process is run. You can
then go into the form and update the name according to what you want the end-user to see.
This is useful as Alternate Names will allow users to see element names that they understand and
see only those elements they are allowed to.
Note, that two definitions will be created; an Enabled and Disabled. They can both be referenced
within Preferences.
If you want to restrict an element so it is not displayed, uncheck the Enabled flag.
By default, when the Alternate Name definitions are created, it will have a start date of 01-JAN-
0001. If you want to end date the Element, enter ToDate.
Note, that two definitions will be created; an Enabled and Disabled. They can both be referenced
within Preferences as Alternate Name preference giving increased flexibility.
6.3 Define Recurring Time Periods
Navigation: XX OTL Application Developer >Recurring Periods
Enter the day with which your timecard will start from. – Ensure this is the Day that is the first day of
when the timecard should also commence from i.e. as below 29-MAR-2010 is a Monday so all
Timecards for would start from a Monday. Whereas, 06-NOV-2005 is a Sunday and all Timecards for
XXXX should start from a Sunday.
The OTL Timecard will result in starting from that Calendar day.
6.4 Define Approval Periods
Navigation: Approval > Define Approval Periods
Approval Periods for each application used must be set up. In the example below we are running
Human Resources application to eventually feed elements into HCM so an Approval Period needs to
be set up against the Recurring Period created before. The default preference for this set up is
Weekly Period--Starts Sunday.
Approval Styles define the Approval methods used by the OTL Application. Different Approval styles
can be created for different employees through Preferences. By Default, OTL auto approves all
timecards. If you want the application to approve some timecards in a different way, then you can
use the Approval Rules in the Approval Style Components Region.
To meet business requirements to meet custom timecard validation rules, Time Entry Rules can be
created using formulas. (For examples, only specific elements can be claimed on the weekend).
1. Create an OTL Formula flexfield context. This is an optional step and is only necessary in cases
where you wish to configure variable inputs i.e.- you wish to create a series of validation rules that
can be configured using different input parameter values.
2. HRMS Manager > Create an OTL Time Entry Rule Formula that returns a value for success or error.
The fast formula needs to return either "S" meaning the time entry was successful or an "E" meaning
the timecard entries failed the validation. In the case of "E" an error message should be referenced
via the Application Messages table with the message value being returned to the users self service
timecard. The error condition can be configured as a warning message(which allows time entry to
continue) or an error message(that stops the time entry process until the condition is resolved).
In addition the application message may also use the token "&TER" which then returns the time
entry rule name in the self service timecard as the actual timecard warning/error message. This
produces the most flexibility as the formula can be re-used with many different input parameters
and display a different message based on the condition triggered. The only limitation here is that a
time entry rule name can be no longer than 80 characters in length.
It is also worth noting that OTL formulas can be created for any or all of the modules that you are
integrating with i.e.- fast formulas in this context are not limited to just the Oracle Payroll module.
3. OTL Application Developer > Create your Time Entry Rule or Rules. If you have created a flexfield
with variable inputs you may create mutliple rules for a single formula subject to variable inputs. As
outlined in step 2 the time entry rule name specified here can also double as the acutal error
message to be displayed on the timecard to the end user.
4. OTL Application Developer > Create your Time Entry Rule Group and add the necessary time entry
rules created at step 3 for the group of workers you are planning the validation to apply to.
5. OTL Application Developer > OTL Preference Settings > Add the Time Entry Rule Group created at
step 4 to the Time Store Time Entry Rules Preference in an appropriate folder.
6. OTL Application Developer > Assign the OTL Preference Eligibility Criteria i.e.- specify the worker
or workers who will be subject to the timecard validations you have created.
Once the Time Entry Rules have been created as per the previous section these rules can be grouped
together and assigned to a group or employee via preferences. The rules created can then be visible
through either the Self Service Timecards or through Timekeeper.
One of the structures used to define working patterns is through the Holiday Calendar. This needs to
be defined to determine Paid and Unpaid holidays.
N.B Where Earning Type is the Payroll element related for Bank Holidays.
Initial set up requires you to attach the New Alternate Name definition for employees through
Preferences so that an employee can view that list of elements defined in the Alternate Name set.
For specific Preferences for OTL Self Service Timecards, the following Preferences are advisable:
Self Service Timecard Status that Allows User Edits
Time Store Time Entry Rules
Self Service Ability to Enter Negative Hours
Self Service Timecard Period for Worker
Please see the OTL user guide for a full list and the description of these.
OTL Eligibility rules can use Employee Assignment criteria enabling eligibility. For example only
certain Grades, Position, Organisation can view a specific alternate name which will decide what
employees can see.
This is a view only tab and no changes can be made at this level. If you wish to make changes to an
individual's preferences, you must use the Eligibility Criteria tab.
7.0 Create Dummy Employee
In order to build the rules in section 6.14 Define Preferences (Rules/Eligibility Criteria), a Dummy
Employee has to be created. It is recommended this employee also be used during Testing Phases
and prior to Go-Live is deleted from the system.
It is possible to configure the OTL Timecard User Interface so that labels, messages, errors, buttons
and fields can be displayed to tailor the business needs.
This section is a brief summary of the Oracle Application Framework (OAF) and what can be
configured and how. However, please refer to the following document either on-line or Metalink for
detailed information.
It is possible to configure the following Layout Types (the self service screens displayed to the user).
Other layout types exist, but this document will only highlight the above.
8.2 What can be configured
The below is an example of the areas of the Timecard that can be customised.
PINK = Standard AOL Messages that can be modified via AOL message form
GREEN = AK prompts that can be modified in the AK region item or attribute forms
RED = Attribute components in the timecard layout that can be modified via the configuration LDTs
BLACK = Information on the timecard layout that can be controlled via preferences
All Layout Types (text edited Loader Data Files - LDT files) can be found under:
$APPL_TOP/hxc/11.5/patch/115/import/US/
The configured LDT files are based on seeded LDT files/filenames above. During and after
configuring the custom version, the LDT files will be uploaded with different names (xx_
hxczzhxclayt0030.ldt). This is to ensure that the original seeded LDT files remain unaffected by the
custom configuration.
8.4 Examples of Custom Layout Type
Below are examples of customisations and how to update the Layout type for each one.
The following code has to be commented out of file xx_hxczzhxclayt0026.ldt to remove Hours
Entered
# BEGIN HXC_LAYOUT_COMP_QUALIFIERS
# "Exception Confirmation Layout - Timecard Header"
# OWNER = "ORACLE"
# QUALIFIER_ATTRIBUTE_CATEGORY = "DISPLAY_HEADER"
# QUALIFIER_ATTRIBUTE20 = "Y"
# QUALIFIER_ATTRIBUTE30 = "Y"
# LAST_UPDATE_DATE = "2004/05/23"
# END HXC_LAYOUT_COMP_QUALIFIERS
# END HXC_LAYOUT_COMPONENTS
# BEGIN HXC_LAYOUT_COMPONENTS
# "Exception Confirmation Layout - Hours Type Table"
# OWNER = "ORACLE"
# SEQUENCE = "60"
# COMPONENT_DEFINITION = "HOURSTYPE_TABLE"
# RENDER_TYPE = "WEB"
# PARENT_COMPONENT =
# "Exception Confirmation Layout - Top Level Building Block"
# COMPONENT_ALIAS = "HOURS_ENTERED"
# PARENT_BEAN = "HOURS_ENTERED_HEADER"
# LAST_UPDATE_DATE = "2004/05/23"
# BEGIN HXC_LAYOUT_COMP_QUALIFIERS
# "Exception Confirmation Layout - Hours Type Table"
# OWNER = "ORACLE"
# QUALIFIER_ATTRIBUTE_CATEGORY = "HOURSTYPE_TABLE"
# QUALIFIER_ATTRIBUTE20 = "Y"
# QUALIFIER_ATTRIBUTE30 = "Y"
# LAST_UPDATE_DATE = "2004/05/23"
# END HXC_LAYOUT_COMP_QUALIFIERS
# END HXC_LAYOUT_COMPONENTS
END HXC_LAYOUT_COMPONENTS
BEGIN HXC_LAYOUT_COMP_QUALIFIERS
"Exception Confirmation Layout - Cost Center"
OWNER = "ORACLE"
QUALIFIER_ATTRIBUTE_CATEGORY = "CHOICE_LIST"
QUALIFIER_ATTRIBUTE1 = "Custom9VO"
QUALIFIER_ATTRIBUTE8 = "DisplayValue"
QUALIFIER_ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER_ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom9VO"
QUALIFIER_ATTRIBUTE11 =
"TIMECARD_BIND_END_DATE|TIMECARD_BIND_END_DATE"
QUALIFIER_ATTRIBUTE17 = "OraTableCellText"
QUALIFIER_ATTRIBUTE20 = "N"
QUALIFIER_ATTRIBUTE21 = "Y"
QUALIFIER_ATTRIBUTE22 = "L"
QUALIFIER_ATTRIBUTE25 = "FLEX"
QUALIFIER_ATTRIBUTE26 = "Dummy Cost Context"
QUALIFIER_ATTRIBUTE27 = "Attribute1"
QUALIFIER_ATTRIBUTE30 = "Y"
LAST_UPDATE_DATE = "2004/05/23"
END HXC_LAYOUT_COMP_QUALIFIERS
END HXC_LAYOUT_COMPONENTS
Add Cost Centre Entry information to XX Notification Page
END HXC_LAYOUT_COMPONENTS
Add information text to XX Timecard Entry PageThe following has been replaced in the
file xx_otl_hxczzhxclayt0030.ldt (highlighted section)
BEGIN HXC_LAYOUT_COMPONENTS
"Exception Layout - Timecard Entry Page"
OWNER = "ORACLE"
SEQUENCE = "10"
COMPONENT_DEFINITION = "DISPLAY_TEXT"
RENDER_TYPE = "WEB"
LAST_UPDATE_DATE = "2006/05/11"
BEGIN HXC_LAYOUT_COMP_QUALIFIERS
"Exception Layout - Timecard Entry Page"
OWNER = "ORACLE"
QUALIFIER_ATTRIBUTE_CATEGORY = "DISPLAY_TEXT"
QUALIFIER_ATTRIBUTE1 = "ENTRY_MESSAGE"
QUALIFIER_ATTRIBUTE3 = "Y"
QUALIFIER_ATTRIBUTE20 = "Y"
QUALIFIER_ATTRIBUTE30 = "Y"
LAST_UPDATE_DATE = "2006/05/11"
END HXC_LAYOUT_COMP_QUALIFIERS
END HXC_LAYOUT_COMPONENTS
Add information text to XX Timecard Review PageThe following has been replaced in the file
xx_hxczzhxclayt0029.ldt (highlighted section)
BEGIN HXC_LAYOUT_COMPONENTS
"Exception Review Layout - Review Message Text"
OWNER = "ORACLE"
SEQUENCE = "10"
COMPONENT_DEFINITION = "MESSAGE_BOX"
RENDER_TYPE = "WEB"
LAST_UPDATE_DATE = "2006/05/11"
BEGIN HXC_LAYOUT_COMP_QUALIFIERS
"Exception Review Layout - Review Message Text"
OWNER = "ORACLE"
QUALIFIER_ATTRIBUTE_CATEGORY = "MESSAGE_BOX"
QUALIFIER_ATTRIBUTE1 = "INFO"
QUALIFIER_ATTRIBUTE2 = "REVIEW_MESSAGE"
QUALIFIER_ATTRIBUTE20 = "Y"
QUALIFIER_ATTRIBUTE30 = "Y"
LAST_UPDATE_DATE = "2006/05/11"
END HXC_LAYOUT_COMP_QUALIFIERS
END HXC_LAYOUT_COMPONENTS
8.5 Uploading Files
These files are FNDLOAD files. Once the changes have been made the files need to be copied over to
the Application server to be uploaded for the changes to take effect. The following command line
must be used when uploading each new file:FNDLOAD apps/<password> O
YUPLOADhxclaytlayoutsld.lctxx_hxczzhxclayt<file number>.ldt
When any customizations have been performed on the timecard the Apache/Jserv process may
need to be ’bounced’ before the changes take effect due to caching of data.
In general the following changes will not need the middle tier to be restarted:
• Changes to the timecard layout
• Changes to prompts or messages used on the layout
Also note that any changes to OTL preferences data whilst a user is logged in and impacted by those
preferences will only be effective once the user has logged out and signed in again.
9.0 Workflow
The following concurrent request needs to set up at intervals to take submitted timecards into the
approval process.
Select the item type OTL Workflows for Employees, leave the threshold parameters
blank, and select Yes in the Process Deferred, Process Timeout, and Process Stuck fields.
Once the timecard associated with the employee has been identified select the Activity History tab.
It is then possible to indentify exactly where the timecard is and if any issues exist (no Supervisor,
Not yet approved etc).
The timecards can be re-submitted here on behalf of the employee or their line manager.
This concurrent program can be found under the Menu Mass Information eXchange: MIX.
11.0 Timekeeper Process
11.1 Overview
OTL Timekeeper Responsibilities exist within OTL to carry out tasks through professional forms.
The features allow a user to enter and maintain multiple timecards in a one session.
A person with OTL Timekeeper responsibilities can enter time for other employees (those that don’t
have OTL Self Service access for examples) as well as make changes to Timecards
The set up required for this feature are as follows though the Timekeeper Group Menu path:
1) The first set up required is to create a Timekeeper. This is a named employee who will own
the group.
2) Create Timecard Group
3) Add Employees to the group created
The following System Profiles values need to be set prior to the use of the Timekeeper
Responsibilities:
Profile Value