Fdocuments - in - Oracle Otl Timecard Layout Customication
Fdocuments - in - Oracle Otl Timecard Layout Customication
Oracle Applications
Oracle Time and Labor
Configuring The Oracle Time and Labor Timecard User Interface
White Paper∗
Author(s): Oracle Time and Labor Development
Generation Date: June 7, 2012
Abstract
This document details the configuration options a timecard layout designer has when constructing a custom layout. OTL
currently allows customization of timecard layouts via modification of AOL loader files which are then loaded into the database.
∗
The document source is at: /hrdev/hxc/11.5/doc/whitepapers/hxcconfiguiwp.tex
1
Contributors
Name Position
Mark Stewart Applications Developer
Andrew Rundell Development Manager
Joel Dupont Applications Developer
John Finnegan Principle Functional Analyst
Kris Van Der Pleog Functional Analyst
Anima Prasad Group Manager
Balakrishna Bayragi Senior Applications Engineer
Amarnath Krishnamoorthy Senior Applications Engineer
Change Record
Date Author Version Change Reference
February 1st, 2005 Andrew Rundell 115.0 Converted to PDF, WIKI, LaTeX
August 6th, 2007 Amritha Nuthi 115.1 Modified to indicate correct functionality for
package choice list
March 25th, 2008 Amritha Nuthi 115.2 Modified to show only the delivered seeded layouts and
to complete the missing lines in some examples
February 09th, 2010 Amarnath Krishnamoorthy 115.3 Reviewed the document and added few examples which describe
how to create custom choice list, LOV, prompts and text field
June 07th , 2012 Balakrishna Bayragi 115.4 Added section 3.18
Reference Documents
Name Description
Release 11i Documentation Oracle Applications Documentation - information on FNDLOAD
and Flexfields
ADF Applications Development Framework - information on java ob-
jects, such as View Objects, Application Modules etc.
2
Contents
1 Introduction 8
1.1 Executive Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2 Structure of a Timecard Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2.1 Time Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2.2 User Interface Component Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3 Layout Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4 Delivered Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.4.1 Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4.2 Pro jects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4.3 Pro jects and Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.4.4 Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4.5 Enterprise Asset Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4.6 Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4.7 Pro jects-Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.4.8 Payroll Layout delivered in Release 12.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.4.9 Project Layouts delivered in Release 12.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.4.10 Project and Payroll Layouts delivered in Release 12.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.5 Using the OAF Personalization Functionality With Timecard Configuration . . . . . . . . . . . . . . . . . . . . . . . . 19
3
3.4.5 Run the migration script to copy the LOV definition from AK to the MDS repository . . . . . . . . . . . . . . 42
3.4.6 Modify a layout to include the LOV component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.4.7 Include the new LOV View Object into your Apache/Jserv environment . . . . . . . . . . . . . . . . . . . . . . 43
3.5 Changing the title of the timecard page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.6 Changing the label for a column in the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.7 Adding a Component to the Timecard Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.7.1 Create AK data for the component prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.7.2 Create wrapper PL/SQL function to call the payroll code function and return it in the format needed for the
package choice list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.7.3 Create the component to show the label for our custom field and add it to the layout . . . . . . . . . . . . . . 52
3.7.4 Create the component to show the read-only function result and add it to the layout . . . . . . . . . . . . . . . 52
3.8 Adding a Component to the Timecard Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.9 Adding an OTL Information Type to the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.10 Adding additional element input values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
3.11 Configuring the Cost Center component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.12 Adding OTLR Detail to the Review and Confirmation Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.12.1 Creating the Detail Time Building Blocks in the Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.13 Adding the Details Page DFF Segments to the Timecard matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.13.1 Setting the Attribute Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.13.2 Aliasing A Segment Value To Set The Attribute Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.13.3 The Simple Approach: An Always-execute choice list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.13.4 Other Segment Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
3.14 Configure Expenditure Type As Choice List Using Alternate Names in Projects Payroll Layout . . . . . . . . . . . . . 74
3.14.1 Define a New OTL Alternate Names Type Descriptive Flexfield Context / Segment: . . . . . . . . . . . . . . . 74
3.14.2 Mapping the Segments/Attributes to respective components: . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
3.14.3 Creating Alternate Name for the Alternate Name Type ET EXPENDITURE TYPES: . . . . . . . . . . . . . . 75
3.14.4 Create A Custom View and Define Layouts: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.15 Configuring Cost Center as a LOV in Payroll Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.15.1 Create AK attributes used for the LOV screen : . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
3.15.2 Create an AK region for rendering the LOV screen: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
3.15.3 Create AK region items inside the AK region for the LOV page: . . . . . . . . . . . . . . . . . . . . . . . . . . 79
3.15.4 Migration of Ak Region to MDS Repository,Creation of Custom View and Define Layouts: . . . . . . . . . . . 80
3.16 Adding Custom LOVs, Custom Choice List and Text Field to a Payroll Layout . . . . . . . . . . . . . . . . . . . . . . 83
3.16.1 Create AK attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
3.16.2 Add Attributes to AK Region: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.16.3 Create database views: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.16.4 Create AK regions for rendering the LOVs: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
3.16.5 Create AK region items inside the AK region for the LOV page: . . . . . . . . . . . . . . . . . . . . . . . . . . 90
3.16.6 Setting up the Custom LOV xml and java files: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
3.16.7 Migration of Ak Region to MDS Repository: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
3.16.8 LDT file customization to change prompt from Hours Type to Job Type: . . . . . . . . . . . . . . . . . . . . . 95
3.16.9 LDT file customization to include choice list: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
3.16.10 LDT file customization to include source and destination LOVs: . . . . . . . . . . . . . . . . . . . . . . . . . . 97
3.16.11LDT file customization to include text field: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
3.17 Configure an Entry Level Processing Timecard Layout to capture Project, Task and Expenditure Type Information in
Cost Allocation Key Flexfield segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
3.17.1 Create AK attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3.17.2 Add Attributes to AK Region: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
3.17.3 Create database views: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
3.17.4 Add Project Id, Task Id and Expenditure Type segments to Cost Allocation KFF: . . . . . . . . . . . . . . . . 104
3.17.5 LDT file hxczzhxclayt0025.ldt customization to include JOB and LOCATION choice lists: . . . . . . . . . . . . 105
4
3.17.6 LDT file hxczzhxclayt0025.ldt customization to add Cost Center field: . . . . . . . . . . . . . . . . . . . . . . . 106
3.17.7 LDT file hxczzhxclayt0025.ldt customization to map Project Information to Cost Allocation KFF: . . . . . . . 107
3.17.8 Attributes data stored in database: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
3.17.9 Batch Element Entry form showing the additional segments in Cost Allocation KFF: . . . . . . . . . . . . . . . 113
3.18 Confirmation Check box on Timecard review page for Time Accuracy . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5
List of Tables
1 Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2 Pro jects Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3 Pro jects and Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4 Exception Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5 Enterprise Asset Management Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6 Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
7 Pro jects-Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
8 R12.1 Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
9 Projects Layouts - With Project & Task details concatenated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
10 Projects and Payroll Layouts - With Project & Task details concatenated . . . . . . . . . . . . . . . . . . . . . . . . . 18
11 Delivered Custom Choice List View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
12 Component Tables Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
13 Global Attributes, applicable to every component. Required attribute(s) in bold. . . . . . . . . . . . . . . . . . . . . . 117
14 Choice List Components. Required Attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
15 Descriptive flexfield component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 120
16 Display text component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 121
17 Inter Period Navigational Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . 121
18 Key notation component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 122
19 List of Values component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 124
20 Message Box component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 125
21 Package Choice List component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 126
22 Page Status component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 126
23 Spacer component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . 126
24 Submit Button component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . 127
25 Submit Icon component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 127
26 Summary Table component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . 127
27 Table Layout component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 128
28 Template Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . 128
29 Text Field component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . 129
30 Time Building Block component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 130
31 Currently recognized tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
32 Timecard region seeded prompts (Part 1.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
33 Timecard region seeded prompts (Part 2.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
34 Timecard Review region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
35 Timecard Confirmation region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
36 Seeded Timecard Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
37 Configurable User Interface Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
38 Configurable User Interface Error Codes (Part 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
6
17
Table 10: Projects and Payroll Layouts - With Project & Task details concatenated
18
19
business group id
business group name
Specifically:
39
Leave all other fields blank or to their default value. Save the record.
3.4.4 Create AK region items inside the AK region for the LOV page
Next you need to create region items for each of the things you want to show on the LOV. Using the AK Regions window, query the
region that you created in the previous step, and with that row selected, click on the Region Items button. Complete the following
fields: Attribute Type, Application, Attribute Name, Sequence, Node Display, Queryable, View Usage Name, View Attribute Name.
In addition, make a note of the value for Item Name - this will be auto-generated from the attribute code and you do not need to
change it, but you need to know it for when you create the LOV component definition.
So for our example, you would create the following region items inside the LOV region.
40
41
3.4.5 Run the migration script to copy the LOV definition from AK to the MDS repository
3.4.6 Modify a layout to include the LOV component
For our example, the component definition is:-
########################################################################
# My Custom Person LOV #
#######################################################################
BEGIN HXC LAYOUT COMPONENTS "My Custom Layout - Custom Person LOV"
OWNER = "CUSTOM"
COMPONENT VALUE = "CUSTOMPERSON"
SEQUENCE = "140"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"My Custom Layout - Day Scope Building blocks for worker timecard matrix"
REGION CODE = "MY CUSTOM AK PROMPT REGION"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "MY CUSTOM PERSON PROMPT"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
BEGIN HXC LAYOUT COMP QUALIFIERS "My Custom Layout - Custom Person LOV"
OWNER = "CUSTOM"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "CustomPersonVO"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "MY CUSTOM LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "12" # display width
QUALIFIER ATTRIBUTE6 = "CustomFullName|CUSTOMPERSON-DISPLAY|CRITERIA|N|CustomPersonId|CUSTOMPERSON|
RESULT|N|CustomFullName|CUSTOMPERSON-DISPLAY|RESULT|N|CustomBusinessGroupId|BUSINESSGROUP|RESULT|N"
QUALIFIER ATTRIBUTE7 = "BUSINESSGROUP|CustomBusinessGroupId"
QUALIFIER ATTRIBUTE8 = "CustomFullName"
QUALIFIER ATTRIBUTE9 = "CustomPersonId"
QUALIFIER ATTRIBUTE10 = "my.custom.server.CustomPersonVO"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "MYFLEX"
QUALIFIER ATTRIBUTE27 = "Attribute1"
QUALIFIER ATTRIBUTE28 = "CUSTOMPERSON"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
Note: If you wish to also show the new LOV field on the review and confirmation layouts you will need to modify them to
include the component as well. The easiest way to accomplish this is to copy the component definition over from the timecard layout,
changing the component name, parent component name and qualifier name. Then you just need to modify the copied definition to
make it render as a read only text field–this is done by adding a value of ’Y’ for qualifier attribute30:
QUALIFIER ATTRIBUTE30 = ’Y’
42
3.4.7 Include the new LOV View Object into your Apache/Jserv environment
First of all you need to compile any Java code that was generated when you created your View Objects. Typically you will have a
VOImpl.java file, but there are others you can choose to create when you generate your VO. Once you have the class files you will
need to get these and the xml file to your apache/JServ environment. The easiest way to do this is to create a directory and then
prefix this to your JServ classpath. Note: In the directory you will need to maintain the full structure of the package you used to
create your VO. For our example, the files are in the package ’my.custom.server’. So in the directory you add to your classpath you
should have the following structure/files (assuming ’custom’ is the name of your directory):
custom/my <directory>
custom/my/custom/ <directory>
custom/my/custom/server/ <directory>
custom/my/custom/server/CustomPersonVO.xml
custom/my/custom/server/CustomPersonVOImpl.class
After altering the JServ classpath to include your directory you should bounce Apache/JServ for the changes to take effect. The
final task needed to implement your new LOV is to compile your modified layout against the database, and if necessary assign it to
the relevant users via the preference screen.
Where RI NAME is the token for the name of the employee entering time and RA NUMBER is their employee number.
To change the title modify the text associated with prompt HXC TIMECARD HEADER TITLE , within the AK HXC CUI TIMECARD
region. Alternatively, you can create a new prompt and then alter the layout definition to use that prompt instead of the delivered
one.
So, for example, lets change the title to say Timecard for Employee , where Employee is the name of the employee.
Go to Application Developer Common Modules ¿ AK regions form, query for HXC CUI TIMECARD , highlight the correct row (if
you have more than one result from doing a partial match), and then press the ’Region Items’ button at the bottom of the form. In
the region items form, query on the Attribute ’Timecard Header Title’ (you can look up the attribute names based on the attribute
code by searching in the ’Seeded Prompts’ section. Refer Table 31: Timecard region seeded prompts) and then change the ’Attribute
Long Label’ text for the item to:
Timecard for @RI NAME
43