Professional Documents
Culture Documents
OTL Layout Configuring-OTL PDF
OTL Layout Configuring-OTL PDF
OTL Layout Configuring-OTL PDF
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.
2004
c Oracle Corporation. All rights reserved.
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 Senior Development Manager
Balakrishna Bayragi Applications Developer
Amarnath Krishnamoorthy Senior Applications Developer
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 describes
how to create custom choice list, LOV, prompts and text field
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 Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4.3 Projects and Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.4.4 Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4.5 Enterprise Asset Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4.6 Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4.7 Projects-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.11 LDT 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
5
List of Tables
1 Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2 Projects Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3 Projects and Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4 Exception Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5 Enterprise Asset Management Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6 Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
7 Projects-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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
13 Global Attributes, applicable to every component. Required attribute(s) in bold. . . . . . . . . . . . . . . . . . . . . . 115
14 Choice List Components. Required Attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
15 Descriptive flexfield component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 118
16 Display text component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 119
17 Inter Period Navigational Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . 119
18 Key notation component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 120
19 List of Values component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 122
20 Message Box component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 123
21 Package Choice List component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 124
22 Page Status component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 124
23 Spacer component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . 124
24 Submit Button component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . 125
25 Submit Icon component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 125
26 Summary Table component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . 125
27 Table Layout component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 126
28 Template Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . 126
29 Text Field component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . 127
30 Time Building Block component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 128
31 Currently recognized tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
32 Timecard region seeded prompts (Part 1.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
33 Timecard region seeded prompts (Part 2.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
34 Timecard Review region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
35 Timecard Confirmation region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
36 Seeded Timecard Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
37 Configurable User Interface Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
38 Configurable User Interface Error Codes (Part 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
6
List of Figures
1 Time Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2 What can be Configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3 Timecard Matrix Line Comment Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4 Alternate Name Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
5 Custom LOV Showing Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6 Custom LOV Showing Locations after personalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
7 Defining New OTL Alternate Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
8 Mapping Segements/Attributes to respective components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
9 Preference Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
10 Time Entry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
11 AK Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
12 AK Region items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
13 Preference page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
14 Time Entry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
15 Configured Airlines Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
16 Additional Element Input Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
17 AK Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
18 Add Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
19 LOV AK Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
20 LOV AK Region items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
21 Flight Source and Destination LOVs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
22 Configured ELP Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
23 Additional Element Input Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
24 AK Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
25 Add Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
26 Cost Allocation KFF Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
27 HXC TIME ATTRIBUTES table data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
28 Cost Allocation KFF Segments in BEE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7
Preface
Audience
This document describes the Oracle Time and Labor configurable timecard interface. It is a How-To guide as well as technical
reference document. In order to configure an Oracle Time and Labor timecard user interface working knowledge of the Oracle
Applications generic loader, FNDLOAD, plus its associated pre-requisite knowledge, as well as a basic understanding of a web page
and Oracle Flexfields is required. For more complex configurations, such as custom list of values, some familiarity with the Oracle
Applications Development Framework (ADF) is required. For example, additional list of values may require new ADF components
such as View Objects. Consult the appropriate reference documents for more detailed information on these Oracle Application specific
features.
Document Structure
There are five sections to this document:
• Section 1 provides introductory material, including and executive overview, which is appropriate background reading for people
wishing to understand, but not implement a configurable user interface.
• Section 2 describes the basics of timecard configuration, and at high level discusses the various objects and techniques employed
when modifying the interface.
• Section 3 builds on the previous section to provide explicit examples of typical configurations, e.g. changing the window title,
adding a choice list and a list of values.
• Section 4 supplies a full technical reference guide for all configurable components and objects associated with the configurable
user interface.
• Finally, section 5 describes what to do in the case of an unexplained configuration error, and contains a list of frequently asked
questions.
For very simple timecard configurations, e.g. just changing a prompt or moving a field from one place to another, only the first
three sections are required reading. For more complex configurations, e.g. adding a dependent list of values, the technical reference
section is invaluable.
This version of the document applies to HXT.H onwards, Oracle Applications Release 11i.10, Release 12.0 and
Release 12.1
1 Introduction
1.1 Executive Overview
Oracle Time & Labor (OTL) permits configuration of the timecard interface. Inclusion or exclusion of UI features, e.g. labels and
buttons, as well as choosing the fields shown on the timecard lie within the configuration module. These fields can be the delivered
set, or custom fields, tailored to a particular business.
The timecard interface is a hierachical structure of user interface components, a full set of which describes the interface, and is
known as a layout. Currently, a layout describes the user interface for one page, and thus there are OTL layouts for the timecard
entry, review, confirmation, notification, approval, audit and details pages, as well as a layout that describes what information is
available for offline time entry — the export layout. This enables the maximum level of configuration. Layouts are held in normal text
files; these are loaded into the database using the standard applications loader utility (FNDLOAD), and configuration file supplied
by OTL. There are many delivered layouts that provide a timecard user interface configured for various applications, or combinations
of applications and these are pre-loaded for immediate use.
The appearence of the user interface components contained in a layout are controlled via varying sets of information, such as
height, color, size, direction, data source and so on. This extra information is held in a standard Oracle Applications Flexfield,
called Self Service Configurable UI Flexfield. Each of the user interface components has a context within this flexfield, the segments
8
of which are known as component qualifiers, or just qualifiers. The column names in the OTL database for these qualifiers are
QUALIFIER ATTRIBUTE1 through QUALIFIER ATTIRBUTE30. Use of a flexfield to store this extra information ensures a
consistent approach to user interface components within the configurable user interface module, and makes it easier to add support
for additional components in the future.
In conjuction with the standard Oracle Applications Development Framework (ADF) personalization feature, the OTL timecard
configurable user interface module permits every aspect of the timecard page to be changed, within the normal limits of HTML.
When configuring a timecard page, it is important to understand how the user interface components relate to the data generated
in the OTL time store. In this way, the most appropriate configuration is efficiently and accurately created. This document uses
many OTL concepts to streamline the configuration for the application, and thus the relationship between the data and the user
interface components on the page is now described.
• A range time building block is an entry of time that exists for a given range of time, for instance, today from 9:00 AM until
5:00 PM, or from August 20th to August 26th.
• A measure time building block is an entry of time that is a specific amount of time. For this type of time building block there
is no information within the block itself about when this time occurred.
The OTL timecard data-structure is a hierarchical collection of time building blocks. The top time building block (the one without
a parent) is the TIMECARD time building block, and represents the range of time for which this timecard exists, such as a week or
a month.
Time building blocks have one or more child blocks and one parent block. You can attach blocks to other blocks, and build the
complete timecard for a period of time. Each day associated with this timecard is a child time building block of that TIMECARD
time building block. Day building blocks are range building blocks, and represent the amount of time within that day (they start at
midnight on that particular day, and end at one second before midnight on the same day). Each day may have one or more time
building blocks associated with it, and these are the time entries associated with the timecard.
The data model reflects the user interface of the timecard page. Consider a square split in half. This square represents the screen,
and in one half, we render the attributes associated with the TIMECARD time building block, such as the comment text field, in the
other half, we render all the child building blocks of this block, the days and entries. Next, the process occurs for these child blocks,
namely a square split in half, in one half we render the attributes the other we render the child building blocks of this block, and so
on. This is shown in Figure 1 below:
In this way, we can easily represent the hierarchical structure of the set of blocks that make up the timecard on the screen. However,
simply doing that can lead to a confusing and repetitive user interface. To avoid this, the user interface component qualifiers are
used to ensure that the timecard user interface makes sense. However, in principle, it is clear that there is a correspondance between
the hierarchical nature of the user interface components, and the hierarchical nature of the time store building block data structure.
9
• top level building block
– header table layout
∗ header field table layout
· inter-period navigation control label
· inter-period navigation control component
· override approver label
· override approver component
· template control label
· template control component
∗ comments component
– timecard matrix building block
∗ measure field
∗ project LOV
∗ task LOV
∗ expenditure type LOV
∗ delete control
∗ details control
– template save table layout
∗ save template name field
∗ save template submit control
You will note the use of tables within this hierarchy - this is the primary way of formatting or aligning fields in HTML. So for
example, in the header table the outer table definition allows us to show the navigation/override/template fields on one side of the
page and the comments field on the other side. The nested table allows us to make sure that the field labels and components are
aligned with each other to improve the visual appearance of the page. Note: For readers experienced with the ADF, it is clear that
each of these OTL configurable user interface components maps to a OAF web bean, and that the hierarchy described here is added
in its entirity to the web bean hierarchy used by OAF to render self service pages.
10
1.4 Delivered Layouts
In order to facilitate rapid implementation, a number of common timecard layout sets are delivered with OTL. These meet many
requirements for capturing time, or can be used as the basis for customization.
Find these layout files in $APPL TOP/hxc/11.5/patch/115/import/US/, where $APPL TOP is the mount and directory where
Oracle Applications is installed. These layout sets are named after the application-specific data entry fields defined within them,
e.g. the Projects layout set contains components for a Project entry field, a Task entry field, an expenditure type field and so on.
There are four application-specific layout sets delivered with the OTL product: Payroll, Projects, Projects and Payroll — these are
layouts with both the projects application and payroll application fields defined, and an Exception-based time reporting layout.
11
Figure 1: Time Building Blocks
12
1.4.1 Payroll
The payroll layouts delivered with the product are listed in table 1.
1.4.2 Projects
The projects layouts delivered with the product are listed in table 2.
13
1.4.3 Projects and Payroll
The projects-payroll layouts delivered with the product are listed in table 3.
14
1.4.4 Exception
The exception layouts delivered with the product are listed in table 4.
1.4.6 Purchasing
The purchasing layouts delivered with the product are listed in table 6.
15
1.4.7 Projects-Purchasing
The projects-purchasing layouts delivered with the product are listed in table 7. Each of the layout names is prefaced with Projects-
Purchasing.
16
1.4.9 Project Layouts delivered in Release 12.1
The projects layouts delivered for ORACLE E-BUSINESS SUITE 12.1 with the product are listed in table 9.
17
Layout Name Layout Code Layout Type Filename
Projects and Payroll Timecard Layout - With PROJECTS-DET-ALT-TIMECARD TIMECARD hxczzhxclayt0093.ldt
Project & Task details concatenated
Projects and Payroll Review Layout - With PROJECTS-DET-ALT-REVIEW REVIEW hxczzhxclayt0094.ldt
Project & Task details concatenated
Projects and Payroll Confirmation Layout - With PROJECTS-DET-AL-CONF CONFIRMATION hxczzhxclayt0100.ldt
Project & Task details concatenated
Projects and Payroll Details Layout - With PROJECTS-DET-ALT-DETAIL DETAIL hxczzhxclayt0098.ldt
Project & Task details concatenated
Projects and Payroll Export Layout - With PROJPAY-DETAIL-EXPORT EXPORT hxczzhxclayt0099.ldt
Project & Task details concatenated
Projects and Payroll Notification Layout - With PROJECTS-DET-ALT-NOTIF NOTIFICATION hxczzhxclayt0095.ldt
Project & Task details concatenated
Projects and Payroll Fragmented Timecard View PROJECTS-DET-ALT-FRAG FRAGMENT hxczzhxclayt0096.ldt
- With Project & Task details concatenated
Projects and Payroll Change and Late Audit PROJECTS-DET-ALT-AUD-LAYOUT AUDIT hxczzhxclayt0104.ldt
Entry Layout - With Project & Task details
concatenated
Projects and Payroll Change and Late Re- PROJECTS-DET-ALT-CLA-REVIEW REVIEW hxczzhxclayt0101.ldt
view Layout - With Project & Task details
concatenated
Projects and Payroll Change and Late Con- PROJECTS-DET-ALT-CLA-CONF CONFIRMATION hxczzhxclayt0103.ldt
firmation Layout - With Project & Task de-
tails concatenated
Projects and Payroll Change and Late Notifi- PROJECTS-DET-ALT-CLA-NOTIF NOTIFICATION hxczzhxclayt0102.ldt
cation Layout - With Project & Task details
concatenated
Entry Level Processing Projects - Payroll ELP-PROJ-DET-PAY-TIMECARD TIMECARD hxczzhxclayt0105.ldt
Timecard Layout - With Project & Task de-
tails concatenated
Entry Level Processing Projects - Payroll Re- ELP-PROJ-DET-PAY-REVIEW REVIEW hxczzhxclayt0106.ldt
view Layout - With Project & Task details
concatenated
Entry Level Processing Projects - Payroll ELP-PROJ-DET-PAY-CONF CONFIRMATION hxczzhxclayt0110.ldt
Confirmation Layout - With Project & Task
details concatenated
Entry Level Processing Projects - Payroll De- ELP-PROJ-DET-PAY-DETAIL DETAIL hxczzhxclayt0109.ldt
tails Layout - With Project & Task details
concatenated
Entry Level Processing Projects - Payroll Ex- ELP-PROJ-DET-PAY-EXP-LAYOUT EXPORT hxczzhxclayt0108.ldt
port Layout - With Project & Task details
concatenated
Entry Level Processing Projects - Payroll No- ELP-PROJ-DET-PAY-NOTIF NOTIFICATION hxczzhxclayt0107.ldt
tification Layout - With Project & Task de-
tails concatenated
Table 10: Projects and Payroll Layouts - With Project & Task details concatenated
18
1.5 Using the OAF Personalization Functionality With Timecard Configuration
In short, for any page rendered with the Oracle Time and Labor (OTL) timecard configuration utility, no UI components can be
Personalized using the standard Oracle Applications Framework (OAF) functionality. All changes to the page must be made via the
Oracle Time and Labor page layout definition.
The one exception to this rule are the pages rendered in the LOV pop-up windows. While the LOVs themselves are controlled by the
OTL timecard configuration utility, the pages rendered in the pop-up list of values windows are not. Thus, the OAF Personalization
functionality can be used to personalize those windows. For example, if the project id column in the Projects LOV pop-up should be
hidden, a customer should create a personalization at the desired level and hide that column. If the columns should be renamed or
reordered, again, this should be done via the personalization framework delivered with the OAF.
19
2 Timecard Configuration Basics
The fastest mechanism of configuring a time card is to modify the existing set of layouts that are closest to the required functionality.
This white paper describes this process in detail, and illustrates with examples of common modifications. The document covers
the majority of customizations, which are to the timecard header — the comments field, period list control and template control
widgets — and timecard matrix — the time attributes and time entry fields. In summary, the minimal number of steps to configure
a timecard layout are:
1. Use one of the seeded timecard layouts as a basis, or create a new timecard layout.
2. You must rename the timecard layout.
3. You configure the components of the timecard.
4. Upload the timecard layout to the database using FNDLOAD (see section 2.4).
NOTE: Do not use Web Application Dictionary or the OA Configuration Framework to configure the layouts.
However, there are items on the OTL timecard pages such as the product branding and buttons which are outside the scope of the
configurable user interface. Thus use the personalization framework to modify to those user interface components, e.g. to change the
branding, or the labels on the buttons.
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
20
2.2 The Layout File
As previously mentioned, the timecard layout containing a set of user interface component, and associated qualifer descriptions, is
held in a simple text file. Use FNDLOAD, the generic AOL loader utility, to upload the file data into the OTL Configurable
User Interface database tables. Read the AOL documentation, within the Oracle Applications release 11i documentation, for more
information on FNDLOAD. In common with all FNDLOAD compatible files, OTL delivers a configuration file, which defines the
structure of the layout files. This configuration file defines the entities, and entity attributes that are present within the file, which
are in the form of name value pairs unless part of the developer key for the attribute. For example, the HXC LAYOUT entity has
two keys, the layout name, and the application short name that owns the layout (at the moment this is only OTL) and then a
number of attributes, such as the display layout name and the layout type. In OTL, each of the entities definied in the configuration
file maps to an OTL table, e.g. the HXC LAYOUTS entity maps to the HXC LAYOUTS table. Each of the entity keys, or entity
attributes in the loader file maps directly or via a key to columns in those entities. E.g. DISPLAY LAYOUT NAME maps to the
database column, DISPLAY LAYOUT NAME, while PARENT COMPONENT maps to the column PARENT COMPONENT ID,
as the parent component specifies a key attribute of an entity. The configuration file is:
$APPL TOP/hxc/11.5/patch/115/import/hxclaytlayoutsld.lct
and must be used in conjunction with FNDLOAD when uploading the layout.
These changes must be made for any layout you are modifying, and it is also a good idea to change the filename of the loader file
to avoid confusion with the OTL delivered files.
21
2.5 Labels and Messages
There are two concepts used to store any text that is displayed on an OTL timecard screen - prompts and messages. In general, for
small amounts of text, use a prompt, otherwise use a message, which can be considerably more descriptive. For example, the tip at
the top of the timecard page is a message, while the Project label in the timecard matrix is a prompt. All component prompts and
other items such as titles, button labels, etc. are defined as prompts.
2.5.1 Labels
All labels in the OTL configurable UI are translatable and customizable via the AK Developer responsibility in Oracle Applications.
New labels can also be created in AK and used within the configurable UI for customized timecards. AK data for our purpose, is
defined as a region containing one or more region items. For OTL, the region is just a ’container’ for all of the prompts - to see an
example of this you can review the region ’HXC CUI TIMECARD’ which contains most of the prompts for the timecard entry page
— see section 4. Each region item is based on an attribute, which are reusable, but for the purposes of OTL you will usually have
a one-to-one mapping between region items and attributes. When creating region items there are many possible settings, but OTL
will only use a subset of these fields when querying labels - the ones used, and that should be set (other than mandatory fields such
as attribute name, application, length and sequence) are:
When creating your own custom prompts you should take note of the attribute code (for the attribute referenced by your region
item), along with the region code and application you have created the region items under - this information will be needed to utilize
these labels within your configured timecard layout.
2.5.2 Messages
Messages in OTL use the standard Applications Object Library message functionality to provide a translatable and customizable
solution for longer sections of text. When creating messages you should note the message name you have specified, along with the
application name you have used.
22
2.6.2 Application Modules
An Application Module is a BC4J object which can be considered a ’container’ for View Objects. Note: If you create your own
custom View Objects then you should also create an Application Module to contain them. In order for the timecard page to function
properly with custom view objects, the OTL configurable user interface code must instantiate the custom containing application
module before the custom view object from which to retrieve the appropriate business data. Thus, the configurable user interface
must know the name of the custom application module. So when referencing a view object as part of the qualifiers for a user interface
component, a custom application module name can be supplied using the following syntax:
So for example, if you create a custom view object called ’MyViewObject’, and then created an application Module called ’MyAM’
with the full class (including package) of ’my.custom.code.MyAM’, then the qualifier would look as follows:
NOTE: All BC4J and Java references are case-sensitive, so it is important to ensure the reference in the layout
matches that of your code.
Any changes to OTL preference 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.
23
View Object Name View Object Class Configurable View Name
Custom1VO oracle.apps.hxc.selfservice.timecard.server.Custom1VO HXC CUI CUSTOM1 V
Custom2VO oracle.apps.hxc.selfservice.timecard.server.Custom2VO HXC CUI CUSTOM2 V
Custom3VO oracle.apps.hxc.selfservice.timecard.server.Custom3VO HXC CUI CUSTOM3 V
Custom4VO oracle.apps.hxc.selfservice.timecard.server.Custom4VO HXC CUI CUSTOM4 V
Custom5VO oracle.apps.hxc.selfservice.timecard.server.Custom5VO HXC CUI CUSTOM5 V
Custom6VO oracle.apps.hxc.selfservice.timecard.server.Custom6VO HXC CUI CUSTOM6 V
Custom7VO oracle.apps.hxc.selfservice.timecard.server.Custom7VO HXC CUI CUSTOM7 V
Custom8VO oracle.apps.hxc.selfservice.timecard.server.Custom8VO HXC CUI CUSTOM8 V
Custom9VO oracle.apps.hxc.selfservice.timecard.server.Custom9VO HXC CUI CUSTOM9 V
Custom10VO oracle.apps.hxc.selfservice.timecard.server.Custom10VO HXC CUI CUSTOM10 V
using the timecard it should obviously make some sense!). Note: For flexibility both columns are delivered as type VARCHAR2, so
if you have a non-varchar2 column you will need to convert it in your view statement.
For a quick example let’s make a custom view object that does a query against PER PEOPLE F and retrieves the persons full name
into DisplayValue and the period ID into Value. The SQL to perform this query would be:
So lets create a view based on this query - since the results are unsorted, lets also add an ORDER BY clause to the SQL statement
so it is easier to find names in the list.
We have used TO CHAR on the person id column to convert it to a VARCHAR2 and we have also specified the aliases for the
columns so they match the expected names within the View Object. Note: Given the nature of HTML all possible selections for a
choice list (both displayed text and the selection value) are part of the generated page. It is strongly advised that Choice Lists only
be used when the result set shown is not excessive, otherwise the size of the page can be large, which may slow down rendering e.g.
if the user is using a dial-up connection.
Information: There is an Applications Object Library profile which controls the maximum number of rows fetched for a View
Object. This profile is called ’FND: View Object Max Fetch Size’ and is set to a default of 200. Without changing this profile option,
this is the maximum number of choices that will available in a choice list component.
Information: OTL delivers a SQL script to create template views for all of the custom view objects - this is not run in a patch, but
can be run manually to create template views for testing, or alternatively you can copy and modify the script to contain your custom
view objects which can then be created by running the script. This script can be found under $HXC TOP/patch/115/sql/hxccuivw.sql.
24
qualifer flexfield. Attributes associated with this context, define the behaviour of this component, and tell the configurable user
interface code how to call the package. In QUALIFIER ATTRIBUTE1 the package and function name to be called are specified, and
QUALIFIER ATTRIBUTE2 contains the parameter list for the function. Parameters for the function call are bound by position, so
it is important to make sure the order they specified in the layout matches that of the function. Literal values may also be passed in
the parameter list - this could be used, for example, if you wanted to use the same function for a multiple components on the page
but be able to identify each of the components and have the code behave slightly differently for each. As an example, lets create a
function called ’test’ in the package ’my custom code’ that takes 3 parameters - the person id of the user, the timecard start date
and a third literal value of ’TEST’:
FUNCTION test
(p resource id in varchar2
,p timecard start date in varchar2
,p mode flag in varchar2
)
RETURN varchar2
The values for QUALIFIER ATTRIBUTE1 and QUALIFIER ATTRIBUTE2 for the component would be:
And this is some basic function code which will convert the bind parameters into different types and return some test values to
be shown in the choice list. This is the function supporting the choice list, and so this is just an example, obviously a configured
function could perform any operation, as long as the return parameter meets the specification defined above.
FUNCTION test
(p resource id in varchar2
,p timecard start date in varchar2
,p mode flag in varchar2
)
RETURN varchar2
IS
--
l resource id NUMBER;
l start date DATE;
l return value VARCHAR2(200);
--
BEGIN
--
-- convert parameters
--
l resource id := TO NUMBER(p resource id);
l start date := fnd date.canonical to date(p timecard start date);
--
-- switch base on the mode flag and set return value based on it
--
IF (p mode flag = ’TEST’) THEN
l return value := ’1|Test1|2|Test2|3|Test3’;
ELSE
l return value := ’10|Display1|20|Display2|30|Display3’;
END IF;
--
-- return values
25
--
RETURN l return value;
--
END test;
Note: Given the nature of HTML all possible selections for a choice list (both displayed text and the selection value) are part of
the generated page. It is strongly advised that Choice Lists only be used when the result set shown is not excessive.
Info: There is an Applications Object Library profile which controls the maximum number of rows fetched for a View Object.
This profile is called ’FND: View Object Max Fetch Size’ and is set to a default of 200.
• PAYROLL ELEMENTS
• EXPENDITURE TYPE
• SYSTEM LINKAGE FUNCTION
• IDENTIFIER
IDENTIFIER is common to all alternate name definitions. This segment is used when you wish to define more than one alternate
name with the same set of values, but with different names. In order to uniquely identify them the identifier segment should be used.
For this example, when the ELEMENTS EXPENDITURE SLF alternate name type is submit, the values that are deposited are a
payroll element, expenditure type and the system linkage function.
The steps for creating a custom alternate name component are
• Create context with the required segments in the OTL Alternate Names FlexField
• Create mappings for the alternate name definition. This is done using the alternate name mapping professional form. Perform
a query based on the ’OTL Alternate Name DFF Context’ and your context as the type and then enter the mappings you
require. For each segment of your context, you should link the correct mapping component that will be used when depositing
the information into OTL.
• Once the alternate name context and mappings are complete it can be utilized by attaching the ’Self-Service timecard alternate
name set defined for a user’ preference as needed.
• Next, your timecard layouts should be modified to include the custom alternate name component. These components are
delivered as VO definitions that are plugged into an LOV or choicelist component with some specific qualifiers set.
Lets use an example to illustrate how an alternate name could be added onto a timecard layout with an LOV component.
BEGIN HXC LAYOUT COMPONENTS
" My Timecard Layout - ExpType PriceType"
OWNER = "ORACLE"
26
COMPONENT VALUE = "PA EXPTYPE PRICETYPE"
REGION CODE = "PA CUI ALTERNATE NAME"
REGION CODE APP SHORT NAME = "PA"
ATTRIBUTE CODE = "PA EXPTYPE PRICE TYPE ALIAS"
ATTRIBUTE CODE APP SHORT NAME = "PA"
NAME VALUE STRING = "PA EXPTYPE PRICE TYPE ALIAS"
SEQUENCE = "240"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"My Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/04"
27
QUALIFIER ATTRIBUTE3: For each of the custom alternate name view objects there is an LOV region delivered which references
them - these regions are named:
HXC CUI ALIAS ITEM1 LOV (for use with AlternateNameItem1VO)
HXC CUI ALIAS ITEM2 LOV (for use with AlternateNameItem2VO)
HXC CUI ALIAS ITEM3 LOV (for use with AlternateNameItem3VO)
HXC CUI ALIAS ITEM4 LOV (for use with AlternateNameItem4VO)
HXC CUI ALIAS ITEM5 LOV (for use with AlternateNameItem5VO)
QUALIFIER ATTRIBUTE11: This qualifier contains the bind variables used for the alternate name definition - the first parameter
should always be the type of alternate name, with the second being the timecard bind end date and the last the timecard bind start
date.
QUALIFIER ATTRIBUTE26, 27 and 28: These qualifiers contain values that tell the OTL deposit process how to handle these
alternate name objects. In qualifier attribute26 the OTL ALIAS ITEM1 context is specified which is used to identify the alternate
name in the attribute structure - the actual context does not exist.
As you can see, this procedure takes 3 optional parameters. If no parameters are specified then the procedure will attempt to
migrate any LOV definitions created under application code 809 (HXC) that have no previously been migrated (there is also a script
available to perform this initial migration that is run during an upgrade - this can be found at:
$APPL TOP/hxc/11.5/patch/115/sql/hxclovmig.sql).
If you are changing the definition of an LOV and need to migrate it again then you need to call the procedure with the force
parameter set to ’Y’ so that the previous definition will be overwritten. For example, to migrate the LOV with the region code
MY CUSTOM LOV which was created under the Oracle Time and Labor application (HXC/809), and overwriting any definition that was
previously migrated you would issue the follow call to the procedure.
28
3 Examples of Common Customizations
3.1 Adding a Comment Field to the Timecard Line
The delivered timecard layouts include a details page that has a comment text area field in which the users can enter up to 2000
characters, or 240 characters if using Project Accounting as a recipient application, for commentary on the time entry.
Often people don’t want to take the functional performance hit of navigating off to the detail page, waiting for the page to render,
click the Apply button on that subsequent page, and then waiting for the timecard page to render again. If the users don’t need to
enter Project Accounting additional information, or if those Project Accounting additional information segments have been moved
to the timecard matrix: see 3.13, then it can be very useful to move the comment text field onto the timecard matrix.
With release 11i HXT.J Cumulative Backports 1 (4634379) or later, this is now very easy, and simply a matter of adding a
TimecardLineComment attribute to the layout, for example, the following component definition in the layout will add a comment
text area on the right hand side of the timecard matrix - i.e. after the Day columns:
############################################################################
# Comment Field
############################################################################
BEGIN HXC LAYOUT COMPONENTS "ELP ChoiceListDff Proj-Pay Timecard Layout - Comment Text Field"
OWNER = "ORACLE"
SEQUENCE = "250"
COMPONENT DEFINITION = "TEXT FIELD"
RENDER TYPE = "WEB"
PARENT COMPONENT = "ELP ChoiceListDff Proj-Pay Timecard Layout - Day Scope Building blocks for worker
timecard matrix"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI TIMECARD COMMENTS"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
BEGIN HXC LAYOUT COMP QUALIFIERS "ELP ChoiceListDff Proj-Pay Timecard Layout - Comment Text Field"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TEXT FIELD"
QUALIFIER ATTRIBUTE1 = "N"
QUALIFIER ATTRIBUTE2 = "Y"
QUALIFIER ATTRIBUTE3 = "50"
QUALIFIER ATTRIBUTE4 = "3"
QUALIFIER ATTRIBUTE5 = "4500"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "R"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "TimecardLineComments"
QUALIFIER ATTRIBUTE27 = "Attribute1"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
Clearly this is a standard text field attribute, with width 50 characters and height 3 lines. Thus, the users can clearly see 150
characters in the text area when the timecard page is rendered, and can enter up to 4500 characters. This is because while this is
only one component the product distributes a TimecardLineComments attribute across all 30 segments of the timecard attribute row.
Thus, rather than having just the 150 characters available in attribute1 there are 30 times 150 characters available. This also implies
that only one TimecardLineComments component per timecard matrix should be configured, as the code will overwrite any values
29
entered into a separate TimecardLineComments component which is associated e.g. with Attribute2 of this timecard attribute. With
this component in place, the timecard matrix lines appear, as per figure 3.
Note: None of the recipient application retrieval processes are configured to receive this data, i.e. comments entered into this
field are only associated with the timecard, and while stored in the time store, they are not sent to Project Accounting, Payroll,
Purchasing, Enterprise Assest Management or Human Resources.
############################################################################
# Machine Name choice list on the timecard matrix
############################################################################
30
BEGIN HXC LAYOUT COMPONENTS "Exception Timecard Layout - Machine Name"
OWNER = "CUSTOM"
COMPONENT VALUE = "MACHINENAME"
SEQUENCE = "110"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Exception Timecard Layout - Day Scope Building blocks for worker timecard matrix"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD MACHINE NAME"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
BEGIN HXC LAYOUT COMP QUALIFIERS "Exception Timecard Layout - Machine Name"
OWNER = "CUSTOM"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom6VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE10 = "oracle.apps.hxc.selfservice.timecard.server.Custom6VO"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Machine Name Info Type"
QUALIFIER ATTRIBUTE27 = "Attribute1"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
For a prompt to show alongside (or above) the choice list, you would need to customize the AK definition for the timecard page
to add an AK region item called HXC TIMECARD MACHINE NAME, and then the long label would be used as the prompt for
the choice list. You can add AK region items using the AK Professional Forms. Once these two steps are done, the choice list will
appear on the timecard. However, you must also create the corresponding OTL Information Types and Mapping components, and
add those mapping components to your deposit process so that the information entered by the user is successfully saved to the time
store. Details on creating mapping components, and adding mapping components to deposit processes can be found in the guide
Implementing Oracle Time and Labor.
3.3 Adding a Custom LOV to the Timecard using the Custom LOV Objects
While it is possible to add a custom LOV to the timecard without using shipped configurable BC4J objects - see section 3.4 - this
results in required customization to delivered code objects, specifically LovAM.xml and TimecardAM.xml. That method of adding a
custom LOV to the timecard is desirable if you already have custom BC4J objects that you want to reuse with the timecard - for
example, perhaps there is an informational LOV that the business has included with the Purchasing product, and you wish to have
that same LOV on the timecard. However, if this is a relatively simple LOV, or you are just replacing the seeded LOVs with an LOV
containing additional columns, then using the configurable LOV and not customizing the application module definitions, *AM.xml, is
the prefered strategy.
There are several steps involved:
31
Comparing these steps to the ones in section 3.4 it is clear it is much easier to use the configurable objects to add an LOV onto
the timecard.
To illustrate the process, we consider a specific example of adding a location field, where the location is determine from the US
Payroll city and state tables, as a list of values to the timecard. Now, suppose this is a Project accounting and Payroll timecard, with
a specific element called: Field Work, which if chosen the user should pick a location within their home state, but if it is anything
else, then no location should be selectable (even if the user opens the LOV).
Clearly from the above example, we must have access to the users alternate name definitions - in this case we want to restrict
the list based on a specific hours type. In fact we have received many enhancement requests to provide an object that exposes the
alternate name definition to the middle tier such that alias bind values can passed to supporting queries. This is enabled for the BC4J
objects supporting this LOV, which means the alias definition id is exposed to the middle tier by the BC4J object. So, when writing
the database view, and setting the bind variables in the timecard layout defintion, care must be taken to bind the right alternate
name definition in the layout - remember you can specify up to 10 alternate names - and retrieve the right alternate definition in
the view. In our example, consider a user with the alternate name preferences as specified in figure 4. In this case the user has two
alternate names specified, one for the expenditure type list and one for the payroll element (Hours Type) list. From this set up, it is
clear this is an Entry Level Processing, ELP, user. In our case we want to change the list based on the hours type chosen, which means
we must be careful to expose the second of the two alternate names in the view, and pass the second alternate name as the bind
variable. So in the view we reference ’TC W TCRD ALIASES|2|’ to return the second alternate name set as defined in the preferences,
and we bind the variable "TIMECARD ALIAS 2" in the qualifier definition. This ensures we are properly specifying the alternate name
(alias definition) in both places.
32
select lov1column1,
lov1column2,
lov1column3,
lov1column4,
lov1column5,
lov1column6,
lov1column7,
lov1column8,
lov1column9,
lov1column10
from hxc cui custom lov1 v
where aliasdefinitionid = :1
With the SQL statement forming the configurable part of the view. In our example case, the SQL statement has form:
select distinct
cy.city name||’, ’||st.state abbrev "lov1column1",
st.state name "lov1column2",
cy.city name "lov1column3",
st.state code||’-000-’||cy.city code "lov1column4",
null "lov1column5",
null "lov1column6",
null "lov1column7",
null "lov1column8",
’PAEXPITDFF - ST’ "lov1column9",
hav.alias value id "lov1column10",
to number(hxc preference evaluation.resource preferences(fnd global.employee id,’TC W TCRD ALIASES|2|’))
"aliasdefinitionid"
from pay us states st,
pay us city names cy,
33
per assignments asg,
hr locations loc,
hxc alias values hav
where st.state code <= 51
and st.state code = cy.state code
and asg.person id = fnd global.employee id
and asg.location id = loc.location id
and loc.region 2 = st.state abbrev
and hav.alias definition id =
to number(hxc preference evaluation.resource preferences(fnd global.employee id,’TC W TCRD ALIASES|2|’))
and hav.alias value name = ’Field Work’
While it is somewhat out of the scope of this section to discuss the SQL statement, it does highlight some typical configuration
options. The use of FND GLOBAL functions to return person context into the view is key, as there is no mechanism within the custom
LOV BC4J objects to pass the person id as context. There are several functions available on the FND GLOBAL package, and all can be
used to provide context to server-side SQL statements.
In the fourth column of the custom LOV, lov1column4 we have created our own key for this field - in this case a jurisdiction
code, which is artificial here because it excludes the county component, but for demonstration purposes will suffice. This is the value
that will actually be stored in the time store, and available to recipient applications.
Also note, the resource preference call, which is used to determine the alias definition id used within the LOV. Only two parameters
are passed, the first the person id is self explanatory, but the second, the string: TC W TCRD ALIASES|2| requires some explanation.
In this case we are asking for the alias definition id of the second alternate name associated with the person as of SYSDATE - this is
important because in our example case the layout used has two alternate name sets, one for expenditure type and one for hours type
- and recall it is the hours type value that we want passed into the LOV to limit the users’ choices.
The location field in this case forms part of the Project Accounting descriptive flexfield structure, and as such we need not only
to set the value of the location the user picks, but also the attribute category for that descriptive flexfield structure. In this case, it
doesn’t matter what value of location is chosen by the user, they are all associated with the ’ST’ attribute category, i.e. since this is
first deposited in the OTL Time Store, we use the special prefix PAEXPITDFF - to identify this attribute as such. The fixed value
in lov1column9 is used as a return item from the LOV - see next section - to populate this attribute category properly. For more
details on this style of configuration see section 3.13.
Lastly, we supply the alias value id in lov1column10 such that we can provide the alias value id chosen by the user in the hours
type choice list as a criterion for this LOV, i.e. if the user does not choose the alias value Field Work, then no choices will be available,
which was our functional requirement.
BEGIN HXC LAYOUT COMPONENTS "ELP ChoiceListDff Proj-Pay Timecard Layout - Location"
OWNER = "ORACLE"
COMPONENT VALUE = "LOCATION"
SEQUENCE = "260"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT = "ELP ChoiceListDff Proj-Pay Timecard Layout - Day Scope Building blocks for worker
timecard matrix"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD LOCATION"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
34
BEGIN HXC LAYOUT COMP QUALIFIERS "ELP ChoiceListDff Proj-Pay Timecard Layout - Location"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "CustomLov1VO"
QUALIFIER ATTRIBUTE2 = "Y"
QUALIFIER ATTRIBUTE3 = "/oracle/apps/hxc/selfservice/configui/webui/CuiCustomLov1RN"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "12"
QUALIFIER ATTRIBUTE6 = "Lov1column1|LOC-DISPLAY|CRITERIA|N|Lov1column10|HOURSTYPE|PASSIVE CRITERIA|Y|
Lov1column4|LOC|RESULT|N|Lov1column1|LOC-DISPLAY|RESULT|N|Lov1column9|PADFFAC|RESULT|N"
QUALIFIER ATTRIBUTE7 = "PADFFAC|Lov1column9"
QUALIFIER ATTRIBUTE8 = "Lov1column1"
QUALIFIER ATTRIBUTE9 = "Lov1column4"
QUALIFIER ATTRIBUTE10 = "oracle.apps.hxc.selfservice.timecard.server.CustomLov1VO"
QUALIFIER ATTRIBUTE11 = "TIMECARD ALIAS 2"
QUALIFIER ATTRIBUTE14 = "Lov1column9|HOURSTYPE|Y#Lov1column1|LOC-DISPLAY|Y"
QUALIFIER ATTRIBUTE15 = "Lov1column9 = ::Lov1column9#
upper(Lov1column1) like upper(’%’||::Lov1column1||’%’)"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "R"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Paexpitdff Context"
QUALIFIER ATTRIBUTE27 = "Attribute1"
QUALIFIER ATTRIBUTE28 = "LOC"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
• The text ELP ChoiceListDff Proj-Pay Timecard Layout - Location corresponds to the component name.
• The component in this case is owned by ORACLE which identifies it as a seeded component. In a configuration file, this can be
anything, but something other than Oracle should be used for custom layouts.
• In this case, the component value, of LOCATION isn’t used in the code anywhere, but represents a good label.
• The sequence corresponds to a unique number within the layout definition and tells the configurable UI code where to situate
the field with respect to the other fields defined in the layout.
• The component definition, LOV, is self-explanatory - this is a list of values style field.
• In this case render type means that we should show this component when the user accesses the timecard via a web browser.
• The parent component is the reference back to the timecard day matrix - i.e. this field is a child of the main table entry table
and thus should be shown inside that table.
• The next four data entries tell the code where to locate the label for the field, in this case it is the AK attribute called
HXC TIMECARD LOCATION within the HXC CUI TIMECARD region - and we should add this AK attribute via the AK forms to
ensure the label is shown on the timecard page.
• The next section of the component definition correspond to the component qualifiers - this is data which modifies the default
component behavior, and is necessary for a List of Values component. The items in bold above must be set this way when
using the configurable LOV objects. They define the BC4J object, and the corresponding MDS region definition to use with
the list of values.
35
• QUALIFIER ATTRIBUTE2 is used to turn middle tier caching on an off for the SQL statement associated with the list of values.
When testing it is a very good idea to set this to N such that you do not need to bounce the apache server repeatedly while
testing your configuration. Once the configuration is fixed, and as long as for the same set of bind variables the same results
will be shown, as is the case here, then the cache should be enabled for performance purposes. If this were a dynamic list, with
lots of changes occurring, then the cache should remain disabled.
• QUALIFIER ATTRIBUTE5 specifies the display size of the field, in this case, 12 characters. The locations in the examples are
somewhat larger than this, but to save horizontal scrolling on the time entry page we reduce this value to a minimum.
• QUALIFIER ATTRIBUTE6 is discussed in much greater detail in later sections of this document, essentially this data controls the
criteria and results for the list of values. The value shown above indicates that the hours type value is a required criterion and
that any data in the location field itself should also be used to filter the results. It also indicates that the location field and
location display field should be given the values from lov1column4 (our key value which will be stored) and lov1column1 (our
display value), respectively. It also indicates that the fixed text in lov1column9 should be placed into the PADFFAC labeled field
- which in this case is a hidden field storing the attribute category.
• QUALIFIER ATTRIBUTE7 indicates any additional result columns. This is used in conjunction with qualifier attribute6, and is
used if the user simply types in a value to the location display value and hits Continue or Save without recourse to the LOV.
It ensures that when the update code executes it understands that the value for the attribute category field must be populated
from the query corresponding to this component.
• QUALIFIER ATTRIBUTE8 and QUALIFIER ATTRIBUTE9 indicate the id (key) and display attributes, and these are set to the
appropriate columns, as previously discussed.
• QUALIFIER ATTRIBUTE11 holds the bind values to pass to the query on execution - these are bind parameters to the query in
addition to the LOV criteria. When using the configurable LOV objects qualifier attribute11 must correspond to the bind
variable for the alternate name definition retrieved in the underlying view - i.e. in this case alternate name definition 2 (any
number between 1 and 10) can be used.
• QUALIFIER ATTRIBUTE14 and QUALIFIER ATTRIBUTE15 indicate the where clause that should be used when the user enters
values and then clicks on the LOV flashlight icon. In this case, the alias value id from the hours type field must equal the
value in lov1column9, and the value entered as search reduction criteria should be like the value in the display column - thus
as configured this is a case insensitive criteria which will match any partial value in the display column. I.e. if the user enters
’GTON sq’, i.e. will match a value ’Washington Square’ in the list of values.
The rest of the qualifier attributes are the usual set for all layout components indicating where the field should appear, inside or
outside the days in the matrix, to the left or right of that matrix, and where the value should be stored - in this case attribute1 of
the Project Accounting additional descriptive flexfield. Once that layout is uploaded, and the right hours type value is chosen in the
hours type list - if the user opens the location LOV the LOV appears as per figure 5.
Obviously while it is good that the LOV works, the generic column names and system data which appears is confusing for the
user.
36
Figure 5: Custom LOV Showing Locations
3.4 Adding a Custom LOV to the Timecard without using the Custom LOV Objects
Creating a list of values (LOV) involves the following steps:
To further illustrate this process we will use a specific example and show the steps required to implement this example in a
timecard layout. Scenario: Include a LOV on the timecard that allows the user to select from a list of people visible from their
security profile. The user should be able to search on criteria such as full name, last name, date of birth, employee number, and the
business group of the person. Additionally, the Business Group ID of the person must be returned to a hidden field already defined
on the screen with the alias of BUSINESSGROUP.
37
Figure 6: Custom LOV Showing Locations after personalization
select pers.person id
,pers.full name
,pers.last name
,pers.date of birth
,pers.employee number
,bg.business group id
,bg.name business group name
from per people f pers
,per business groups bg
where pers.business group id = bg.business group id
Next, you need to decide the class and view usage name for your VO. In this example:
Class Name: my.custom.server.CustomPersonVO View Usage Name: CustomPersonVO
38
business group id
business group name
Specifically:
39
Attribute ID: CUSTOM BUSINESS GROUP NAME
Attribute Name: My Custom LOV - Business Group Name
Application: Oracle Time and Labor
Data type: Varchar2
Value Length: 60
Style: Text
Label: Business Group Name
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
Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Last Name
Sequence: 30
Node Display: Checked
Queryable: Checked
Item Name: CustomLastName
View Usage Name: CustomPersonVO
View Attribute Name: LastName
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.
43
SEQUENCE = "100"
COMPONENT DEFINITION = "INTER PERIOD NAV CONTROL"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/24"
44
to find the reference to the label (so we do not need to hardcode a message name), and also allows prompts to be reused on the layout
so they do not have to be queried multiple times. Once you have located the label using either of these methods, you can simply edit
the text via the AK professional forms to the text you would like.
45
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "N"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - Inter Period Nav Control Label"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PERIOD LABEL"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "90"
COMPONENT DEFINITION = "DISPLAY LABEL"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/24"
46
ATTRIBUTE CODE = "HXC TIMECARD PERIOD GO LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
47
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI TIMECARD APPR OVERRIDE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "120"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/24"
48
LAST UPDATE DATE = "2004/05/24"
49
"Projects Timecard Layout - Template Control"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD TEMPLATE LABEL"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "150"
COMPONENT DEFINITION = "TEMPLATE CONTROL"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMP PROMPTS "TEMPLATE SUBMIT BUTTON" "AK PROMPT"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD TEMPLATE SUBMIT"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
BEGIN HXC LAYOUT COMP PROMPTS "TEMPLATE OVERWRITE LABEL" "AK PROMPT"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD TEMPLATE OW LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
50
MY CUSTOM PACKAGE and has the following specification:
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
Since the interface required for the package choice list is slightly different to the one we need to use, and also to allow for additional
coding if needed, lets create a wrapper function which will call it and return the code in the correct format. Lets assume we create
this function in the package MY CUSTOM CODE
FUNCTION get display payroll code
(p resource id IN VARCHAR2
)
RETURN VARCHAR2
IS
--
l payroll code varchar2(60);
--
BEGIN
--
-- call the payroll code function, making sure to convert the
-- resource id to a number as needed by that interface.
--
l payroll code :=
my custom package.get payroll code
(to number(p resource id));
51
--
-- now return the result in the correct format just using a dummy
-- id
--
RETURN ’1’ || l payroll code;
END get display payroll code;
3.7.3 Create the component to show the label for our custom field and add it to the layout
So first of all, lets consider what sequence we will need to use for our component. Since we want to place it between the inter-period
navigation control and the template control we can see the sequence of those two components is 100 and 110 respectively. To add
our new component will need two new items added inbetween these numbers, so lets set our new label component to 104 and the
field to 105.
Using one of the existing labels in the timecard header as a basis, we make the following changes:
BEGIN HXC LAYOUT COMPONENTS "Custom Field - Payroll code label"
REGION CODE = "MY CUSTOM TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "CUSTOM TIMECARD PROMPT"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "104"
COMPONENT DEFINITION = "DISPLAY LABEL"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
3.7.4 Create the component to show the read-only function result and add it to the layout
BEGIN HXC LAYOUT COMPONENTS "Custom Field - Payroll Code"
OWNER = "ORACLE"
SEQUENCE = "105"
COMPONENT DEFINITION = "PACKAGE CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/23"
52
QUALIFIER ATTRIBUTE CATEGORY = "PACKAGE CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "MY CUSTOM CODE.get display payroll code"
QUALIFIER ATTRIBUTE2 = "@RESOURCE IDENTIFIER ID"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE30 = "Y"
LAST UPDATE DATE = "2004/05/23"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
BEGIN HXC LAYOUT COMP PROMPTS "ADD ANOTHER ROW LABEL" "AK PROMPT"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI ADD ANOTHER ROW"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
53
BEGIN HXC LAYOUT COMP PROMPTS "VERTICAL TOTAL LABEL" "AK PROMPT"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI VERTICAL TOTAL LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
BEGIN HXC LAYOUT COMP PROMPTS "HORIZONTAL TOTAL LABEL" "AK PROMPT"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI HORIZONTAL TOTAL LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
54
LAST UPDATE DATE = "2004/05/24"
55
OWNER = "ORACLE"
COMPONENT VALUE = "PROJECT"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PROJECT"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "210"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
56
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
57
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "230"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
58
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMP QUALIFIERS "Projects Timecard Layout - Delete button"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "SUBMIT ICON"
QUALIFIER ATTRIBUTE1 = "delete"
QUALIFIER ATTRIBUTE2 = "deleteicon enabled.gif"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE5 = "DISABLED"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "R"
QUALIFIER ATTRIBUTE28 = "Delete"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
59
END HXC LAYOUT COMPONENTS
In order to add a component to the timecard matrix we first need to create the component. For this example, let’s use the
component from the Alternate Name component section of the document.
BEGIN HXC LAYOUT COMPONENTS
" My Timecard Layout - ExpType PriceType"
OWNER = "ORACLE"
COMPONENT VALUE = "PA EXPTYPE PRICETYPE"
REGION CODE = "PA CUI ALTERNATE NAME"
REGION CODE APP SHORT NAME = "PA"
ATTRIBUTE CODE = "PA EXPTYPE PRICE TYPE ALIAS"
ATTRIBUTE CODE APP SHORT NAME = "PA"
NAME VALUE STRING = "PA EXPTYPE PRICE TYPE ALIAS"
SEQUENCE = "240"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"My Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/04"
60
we need to change in order to add it to our layout:
BEGIN HXC LAYOUT COMPONENTS
" My Timecard Layout - ExpType PriceType"
We should ensure the component name is unique and it is also a good idea to make it ’fit’ with the other items in the layout. In
this case, it is unique, but to easier identify the field let’s change the name:
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - Custom Field - ExpType PriceType"
Next line we need to change is the sequence:
SEQUENCE = "240"
In order to place this field to the right of the expenditure type field we decided on a sequence of 235, so lets change it:
SEQUENCE = "235"
Next, we need to ensure it is referring to the timecard matrix as the parent component so it will be rendered in the correct place:
PARENT COMPONENT =
"My Timecard Layout - Day Scope Building blocks for worker timecard matrix"
Looking at the current layout the correct parent component for the matrix on our layout is:
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
Although not strictly needed, we should update the qualifier name so it is the same as the component name.
BEGIN HXC LAYOUT COMP QUALIFIERS
"Projects Timecard Layout - Custom Field - ExpType PriceType"
And that’s it! So our new component definition that we merge into our layout in the right spot is:
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - Custom Field - ExpType PriceType"
OWNER = "ORACLE"
COMPONENT VALUE = "PA EXPTYPE PRICETYPE"
REGION CODE = "PA CUI ALTERNATE NAME"
REGION CODE APP SHORT NAME = "PA"
ATTRIBUTE CODE = "PA EXPTYPE PRICE TYPE ALIAS"
ATTRIBUTE CODE APP SHORT NAME = "PA"
NAME VALUE STRING = "PA EXPTYPE PRICE TYPE ALIAS"
SEQUENCE = "235"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/04"
61
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "HXC CUI ALIAS ITEM1 LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "5"
QUALIFIER ATTRIBUTE6 =
"HxcCuiDisplayValue|ALIAS ITEM 1-DISPLAY|CRITERIA|N|HxcCuiValue|DUMMY|PASSIVE CRITERIA|
N|HxcCuiValue|ALIAS ITEM 1|RESULT|N|HxcCuiDisplayValue|ALIAS ITEM 1-DISPLAY|RESULT|N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.AlternateNameItem1VO"
QUALIFIER ATTRIBUTE11 =
?XPENDITURE TYPE PRICE TYPE|TIMECARD BIND END DATE|TIMECARD BIND START DATE"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE24 = "EXPENDITURE TYPE PRICE TYPE"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "OTL ALIAS ITEM 1"
QUALIFIER ATTRIBUTE27 = "Attribute1"
QUALIFIER ATTRIBUTE28 = "ALIAS ITEM 1"
LAST UPDATE DATE = "2004/05/04"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
62
The new OTL Information Type is now available to be deposited with the self-service timecard.
The new input field may allow for ’Free Text’, or a user defined Choice List or List of Values (LOV) entries. Defining user defined
Choice Lists or LOV’s was previously described in sections 2.7 and 2.8.
The timecard attribute then has the new component added to the layout as other components, specifically identifying the new
information type on QUALIFIER ATTRIBUTE26 and QUALIFIER ATTRIBUTE27.
For Example: A new OTL Information Type called ”Machine Information” was created, with Attribute 5 called ”Machine Type”.
A user defined choice list of ”Press, Lathe, Drill, etc.” was created using the view HXC CUI CUSTOM9 V. The view is referenced
in the layout file as Custom9VO.
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom9VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value"
QUALIFIER ATTRIBUTE10 = "oracle.apps.hxc.selfservice.timecard.server.Custom9VO"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Machine Information"
QUALIFIER ATTRIBUTE27 = "Attribute5"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
63
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Element Context"
QUALIFIER ATTRIBUTE27 = "Attribute12"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
For Example: For all Hours Types available to a user, there is an input value ’Day’s Temperature Range’ that a user enters on the
timecard. The Element Input Value was added as Sequence Value 12, which became Segment 12 when the Generate Flex Mapping
Process was executed. A user defined choice list of -50F to -40F, -39F to -30F, through to +101F to +120F, was created using the
view HXC CUI CUSTOM9 V. The view is referenced in the layout file as Custom9VO.
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom9VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom9VO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Element Context"
QUALIFIER ATTRIBUTE27 = "Attribute12"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
64
BEGIN HXC LAYOUT COMP QUALIFIERS "Exception Timecard Layout - Cost Center"
OWNER = "CUSTOM"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "CostCenterVO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE10 = "oracle.apps.hxc.selfservice.timecard.server.CostCenterVO"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Cost Context"
QUALIFIER ATTRIBUTE27 = "Attribute1"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
Example: Suppose you want to reference a different independent value set for the Cost Center component and save to Segment 4
of the Cost Allocation Key. Perform these steps:
• Create the Independent Value Set, such as OTL ACCOUNT.
• Set up values for OTL ACCOUNT.
• Create a View referencing the Independent Value set, and using an OTL Custom Component. (In this example Custom
Component 9.)
(Change the flex value set name (OTL ACCOUNT) to the name of the Independent Value Set you are using.). If you would like
to display the Cost Segment value and the Description, use the following sql to create the view (changing the Independent Value set
name and View number from 1-10)
CREATE OR REPLACE FORCE VIEW HXC CUI CUSTOM9 V
( display value
,value
)
AS
select fv.flex value||’-’||fv.DESCRIPTION display value, to char(flex value id) value
from fnd flex values vl fv, fnd flex value sets fvs
where fv.flex value set id = fvs.flex value set id
and fvs.flex value set name = ’OTL ACCOUNT’
Modify the Cost Center section of the Layout, Review and Confirmation Pages with the following example component.
############################################################################
# Cost center choice list on the timecard matrix
############################################################################
BEGIN HXC LAYOUT COMPONENTS "Exception Timecard Layout - Cost Center"
OWNER = "CUSTOM"
COMPONENT VALUE = "COSTCENTER"
65
SEQUENCE = "120"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Exception Timecard Layout - Day Scope Building blocks for worker timecard matrix"
BEGIN HXC LAYOUT COMP QUALIFIERS "Exception Timecard Layout - Cost Center"
OWNER = "CUSTOM"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom9VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom9VO"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Cost Context"
QUALIFIER ATTRIBUTE27 = "Attribute4"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
Note:
• The Cost Segment Values will be deposited in Segment 4 (QUALIFIER ATTRIBUTE27 = ”Attribute4” )
• The Value Set will be using the JAVA component Custom9VO, which calls the view created in step 3 (HXC CUI CUSTOM9 V).
• The view returns the independent value set.
If you need to place additional Cost Center Segments on the Self Service Layout, you must make the following additional changes
to the .LDT:
1. Show the Cost Center Choice List on Timecard matrix X times in the ldt file (where X is the number of times a cost allocation
key flex segment should be shown)
2. Change the entry for SEQUENCE = ’120’ (above) to a value higher than 120, to show after the 1st Cost Center segment
3. Use a unique name for the new cost center segments (i.e replace ”Exception Timecard Layout - Cost Center” with a unique
name).
4. Ensure the BEGIN HXC LAYOUT COMPONENTS has a unique name for each Cost Allocation Key Flex Segment and matches
the BEGIN HXC LAYOUT COMP QUALIFIERS
5. Ensure the View and VO numbers select the correct Value Set items
6. Ensure QUALIFIER ATTRIBUTE27 reflects the correct Cost Allocation Key FlexField
7. Define AK Attributes and Regions Items for the new segments, to display a Label other than Cost Center-see AK Items for the
Labels on the Timecard, below.
66
8. Associate the new AK Regions and Attributes to the following lines in the Cost Center section of the LDT file:
The text in bold here must use the new AK Region and Attributes for the Cost Allocation Key Flex Labels. AK Items for the
Labels on the Timecard:
• Define Attributes
• Define Region
• After you have defined the Region, select ¡Region Items¿ button to add the attributes to the Region.
67
3.12.1 Creating the Detail Time Building Blocks in the Layout
Within the layout definition file, duplicate the usual TIME BUILDING BLOCK component that corresponds to the day matrix in
the review and confirmation layout, changing the component names, component qualifiers and sequences. Add the words Hours
Explosion (exactly like that - upper case for the first letter of each word, lower case for all other letters, and a space between the
words) to the component name of all of the detail time components. The configurable UI will then recognize these components as
requiring detail time information only, and will associate the detail time blocks and attributes with these components. Two examples
are shipped with the product: Exception OTLR Details Review Layout and Payroll OTLR Details Review Layout. The filenames are
hxczzhxclayt0028.ldt and hxczzhxclayt0004.ldt and can be found in the $Appl TOP/hxc/11.5/import/US directory.
3.13 Adding the Details Page DFF Segments to the Timecard matrix
If an implementation only has one PA DFF context, e.g. ’Global Data Elements’ or even just one specified context such as ’ST’, then
they can include the segments associated with this flexfield context directly on the OTL timecard matrix and thus avoid the need for
users to drill down to the details page to enter this information.
Typically a user must click on the details page link in order to set the context as it driven from data on the main timecard
matrix, e.g. the system linkage function or the expenditure type. It is only once that value is known and has been posted to the
application server that the system can render the appropriate DFF fields for the user. Clearly, if there is only one context this is
unnecessary as there is only once choice for the context, and therefore the DFF segments are well specified without any choice of
timecard attribution.
Before attempting this implementation, note:
• The user will not be able to specify different values for different days, as they can on the details page, unless they use different
timecard matrix lines that may require duplication of other timecard attribution (the same project, task, expenditure type).
• If existing timecards are opened within the new layout and different days have different DFF data, these entries will now be
split onto multiple timecard lines. This may be confusing for users at first.
68
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - DFF Attribute Category"
OWNER = "ORACLE"
COMPONENT VALUE = "DFFATTRIBUTECATEGORY"
SEQUENCE = "250"
COMPONENT DEFINITION = "HIDDEN FIELD"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
Note: this will include the hidden field in the HTML form, but will not show the value to the user.
If the timecard layout has a custom LOV included in the layout, it is possible to set the attribute category from the custom LOV,
which is likely preferable to the method described below, but the choice list approach is likely more common. It is preferable, because
the additional set up for the alias definition is not required.
A Navigate to Application Developer Responsibility - DFF segments form - Query for ’Expenditure Items’ DFF under Projects
Application, and create e.g. ’PA DFF ALTERNATE NAME’ context. This context will be used to generate the values in the
alternate name definition form. Create at least two segments, with names, e.g.:
(a) DFF Segment Value (this will hold the actual value the user would have entered on the details page)
(b) DFF Attribute Category (this will be the ’GLOBAL’ for example)
You can include an identifier segment if any of the alias values are duplicates. Make sure the DFF Segment Value segment has
the same value set as the corresponding segment in the PA Expenditure Items Flexfield definition. This will ensure that you
create only value alias values.
69
For the DFF Attribute Category segment, open the segment definition form and enter the default type of ’Constant’ and the
default value of ’GLOBAL’ (or whatever you want the attribute category to be) - this avoids the need to type in the values in
the alias definition page. Note: the alternate name translation engine adds the ’PAEXPITDFF - ’ prefix, so you should not
include this in the segment or alternate value definitions.
Make sure both segments are required. Freeze the flexfield definition and save your work.
B Navigate to the Alternate Name Mapping form under an OTL Application Developer responsibility. Enter ’OTL Alternate Name
DFF Context’ against value set/context, and then the context you created in step A, e.g. PA DFF ALTERNATE NAME’.
Click in the lower block (under Attribute/Column Name) and the segments you created as part of this context will be auto
populated.
Against the DFF segment value column choose the dummy paexpitdff mapping component corresponding to the segment for
this segment, e.g. if you’re storing the segment value in attribute 5 in the PA DFF definition, pick mapping component:
’PADFFAttribute5’. **NOTE** this is not necessarily the same as the segment you chose in step A to support this value in
the alternate name attribute. Typically you’d pick attribute1 for the segment value in the OTL Alternate Name attribute -
this mapping component tells the OTL Alternate Name translation engine where to put the value in the real (PAEXPITDFF)
attribute.
Against the DFF attribute category segment choose the mapping component: ’Dummy Paexpitdff Context’
Save your work.
C Next navigate to the Alternate Name Definition form, under the same responsibility. Provide some name for your alias definition,
and then pick the context name you created in step A against the ’Type Name’ field. The ’Prompt’ field isn’t used on the self
service timecard, but it is a good idea to fill this in anyway for reuse with timekeeper, provide some prompt, typically the same
as the segment prompt in the PA definition, e.g. ’Activity’. Save your work.
Now, for each value you want the users to be able to pick for this segment value, create an alternate name entry against this
alternate name definition, e.g. Alternate Name: ’Bicycling’ Date From: ’01-JAN-2000’ Date To: ¡null¿ Values (flex window
opens) Segment Value: ’Bicycling’ Segment Context ’GLOBAL’. Make sure the alternate name definitions are enabled. Again,
recall that the alternate name translation engine adds the required ’PAEXPITDFF - ’ prefix automatically on deposit, so this
should not be included in the alternate name value definition.
Save your work.
D Now in the layout definition create the segment entry as the aliased value, e.g. as:
70
QUALIFIER ATTRIBUTE17 = "NONE"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE24 = "PA DFF ALTERNATE NAME"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "OTL ALIAS 1"
QUALIFIER ATTRIBUTE27 = "Attribute1"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
Note: It is very important to use Attribute1 and OTL ALIAS 1 in qualifier attribute 27 and 26, respectively. Also, you must
specify the OTL Alternate Name context you created in Step A in qualifier attribute 24, or the alternate name translation
engine can not work correctly.
E Add the supporting view. The choice list must fetch the alias values into the middle tier somehow, and it does this via the
Custom1VO specified above. The supporting view definition would appear:
Where Alternate Name Definition is replaced with the quoted name provided for the alternate name definition in step C above.
This view ensures the right values are shown in the choice list.
F Next create a preference node and resource rule, attaching the alternate name definition to the ’Timecard Alternate Names’
preference. If using more than one alternate name, ensure that the number of the ’OTL ALIAS n’ context specified in the layout
definition, matches the Timecard Alternate Name number in the preference. I.e. if in the layout you specified ’OTL ALIAS 3’
because 1 and 2 were used in the layout already, ensure this preference has the right values for alternate name 1 and 2, and the
new PA DFF Alternate name is associated with the Timecard Alternate Name 3 segment. Also, create a preference node under
the same parent node, and attach the layout definition containing the PA DFF components in the main timecard matrix - then
associate the parent node containing both preferences to the user population via the appropriate preference resource rule.
Once these six steps are complete, and the layout is uploaded the PA DFF segments will appear in the timecard matrix and
will be populated correctly in the database.
71
3.13.3 The Simple Approach: An Always-execute choice list
If the alias value set up is considered too implementation intensive, or if the DFF definition only contains free text field inputs, it
is always possible to expose the attribute category value to the user, although not have them have to enter a value. This can be
done with an always-execute choice list component. So, instead of the component definition for attribute category above, we instead
specify a choice list, as:
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - DFF Attribute Category"
OWNER = "ORACLE"
COMPONENT VALUE = "DFFATTRIBUTECATEGORY"
SEQUENCE = "250"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
with the supporting view definition, HXC CUI CUSTOM1 V defined as:
create or replace force view HXC CUI CUSTOM1 V
(display value,
value)
as
(select ’Global Extra Info’,
’PAEXPITDFF - GLOBAL’
from dual)
/
With this definition in place, the term ’Global Extra Info’ will appear to the users, but it will be auto-selected, and will be the
only value selectable, thus ensuring the value is properly recorded in the database without user intervention. This component can
safely be excluded from all other layouts - i.e. it is only required on the timecard layout.
72
3.13.4 Other Segment Values
Once the attribute category segment of the PA DFF attribute is properly set, you can simply add any other segment components to
the layout definition as normal. Remember to ensure that qualifier attribute 26 is set to ’Dummy Paexpitdff Context’ and not the
’PAEXPITDFF’ prefix.
Note: if you have used a segment to alias the attribute category, as in the example above or below, do not include that same
segment again in the layout definition.
73
3.14 Configure Expenditure Type As Choice List Using Alternate Names in Projects Payroll
Layout
Requirement:
Configure the Expenditure Type LOV as a Choice List component can be achieved by making use of custom VO facility delivered by
OTL and using Alternate Names. In a Projects and Payroll Layout, expenditure type is a combination of expenditure type, payroll
element and system linkage function. In order to render the combination of these values in a choice list we have to make use of
Alternate Names.
This requirement of adding a choice list to the timecard matrix involves the following steps:
3.14.1 Define a New OTL Alternate Names Type Descriptive Flexfield Context / Segment:
Navigate to System Administration - Application - Flexfield - Descriptive - Segments
74
3.14.2 Mapping the Segments/Attributes to respective components:
Navigate to OTL Application Developer (responsibility used to administer OTL that includes the Alternate Names
sub-menu - Alternate Names - Alternate Name Mapping)
3.14.3 Creating Alternate Name for the Alternate Name Type ET EXPENDITURE TYPES:
Navigate to OTL Application Developer (responsibility used to administer OTL that includes the Alternate Names
sub-menu - Alternate Names - Alternate Name Definition)
Create an Alternate Name Definition for the Alternate Names and give description for Alternate Name Definition.
Alternate Name Definition ET EXPENDITURE TYPE
Description - Expenditure Type for ET Time keepers
Save the Definition.
Select the Alternate Name Type for which Alternate Names are Creating.
75
Add Alternate Names:
Attach the Alternate Name Definition created to the preference node Self Service Timecard Alternate Name Set Defined for a User
76
Define Layouts:
The layout example section listed below were added to a copy of the delivered Projects Layouts layout set. The sample code
has specific entries highlighted to emphasize the specific lines / entry.
Examples of New Defined layout sections New Name section and Alternate Name sections Custom Views used in sample layouts.
NOTE - The following sections displayed are only a part of the entire layout (ldt) files, and display the Alternate Name component.
BEGIN HXC LAYOUT COMPONENTS "B1 Projects Timecard Layout - Expenditure Type"
OWNER = "ORACLE"
COMPONENT VALUE = "DFFALTNAMEACTIVITY"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD EXPTYPE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "235"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2007/07/02"
77
The output log has to be checked to ensure that there were no errors loading the layout.
Attach the custom layouts to the Self Service Timecard,Review and Confirmation Layout Page preference.
Assuming this is the case adding a List of Values to the timecard matrix involves the following steps:
=> Modify the delivered custom VO view to perform the required action.
=> Create AK data for the prompt.
=> Define AK Attributes which are to be displayed in the LOV.
=> Define AK Region for the LOV and map the attributes define to Region as Region Items.
=> Run the migration script to copy the LOV definition from AK to MDS repository
=> Bounce apache after the migration is done.
=> Modify the timecard layout ldt files to include the custom LOV.
=> Load the ldt files using FNDLOAD command.
=> Attach the layouts to the preference.
The following example will demonstrate how to add a new LOV component to the timecard matrix.
78
3.15.1 Create AK attributes used for the LOV screen :
Use the Define Attributes window, which is available from the professional forms AK Developer responsibility.
Define attributes for each of the items that you need to show on the LOV page.
Attribute ID, Attribute Name, Application,Data Type, Value Length, Style and Label and leave the other
fields blank or at their default value.
So in our example, you would need to create attributes for the fields: display value and value
3.15.3 Create AK region items inside the AK region for the LOV page:
Here 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.
Attribute Type, Application, Attribute Name, Sequence, Node Display, Queryable, View Usage Name, View Attribute Name.
So for our example, you would create the following region items inside the LOV region.
79
Attribute Type: Attribute
Application: Time and Labor Engine
Attribute Name: B1 Custom LOV - Costcenter Value
Sequence: 10
Node Display: Checked
Queryable: Checked
Item Name: CustomCostcenterValue
View Usage Name: Custom1VO
View Attribute Name: DisplayValue
3.15.4 Migration of Ak Region to MDS Repository,Creation of Custom View and Define Layouts:
Run the migration script to copy the LOV definition from AK to the MDS repository
exec hxc lov migration.migrate lov region
(p region code => ’B1 CUSTOM LOV’
,p region app short name => ’HXC’
,p force => ’Y’
);
commit;
80
Bounce Apache to reflect the changes made in the AK Region on selfservice page.
BEGIN HXC LAYOUT COMPONENTS "B1 Payroll Timecard Layout - Cost Center"
OWNER = "ORACLE"
COMPONENT VALUE = "COSTCENTER"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD COST CENTER"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "190"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Payroll Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2007/07/12"
BEGIN HXC LAYOUT COMP QUALIFIERS "B1 Payroll Timecard Layout - Cost Center"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "Custom1VO"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "B1 CUSTOM LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "12"
QUALIFIER ATTRIBUTE6 = "CustomCostcenterValue|COSTCENTER-DISPLAY|CRITERIA|N| CustomCostcenterValueId|COSTCENTE
|COSTCENTER-DISPLAY|RESULT|N"
QUALIFIER ATTRIBUTE7 = "COSTCENTER|CustomCostcenterValueId"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom1VO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Cost Context"
QUALIFIER ATTRIBUTE27 = "Attribute1"
81
QUALIFIER ATTRIBUTE28 = "COSTCENTER"
LAST UPDATE DATE = "2007/07/12"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
Attach the custom Timecard Layout to the preference node to reflect the changes.
82
3.16 Adding Custom LOVs, Custom Choice List and Text Field to a Payroll Layout
Requirement:
Configure a timecard by adding 2 LOVs(seeded LOV and custom LOV) along with choice list and Text field that can capture attribute
information for an Airlines Company.
Note: This is an example to explain the Timecard configuration steps only.
=> Define AK Attributes which are to be displayed in the LOVs, Choice List and text field.
=> Add the AK Attribute codes to the AK region.
=> Define AK Region for the LOV and map the attributes defined to the Region as Region Items.
=> Modify the delivered seeded custom VO view and create a new custom LOV VO view to perform the required
action.
=> Create AK data for the prompts.
=> Execute the LOV migration script to copy the LOV definition from AK to MDS repository
=> Bounce apache.
=> Modify the timecard layout ldt files to include the custom LOVs, choice list and text field.
=> Load the ldt files using FNDLOAD command.
=> Attach the layouts to the Timecard Layout preference.
After all the configuration is done, the final timecard should look like this.
83
The above timecard layout has been configured to capture Additional Element Input values that can be validated, deposited in
time store and retrieved to BEE. Refer to section 3.10 for more details on usage on Adding additional element input values
The Elememt Input Values are captured on the configured layout via an Timecard attribute. These input values must exist for
all elements displayed to the user AND must be deposited to the same OTL Information Type Segment for all elements.
84
3.16.1 Create AK attributes:
Navigate to AK Dev Responsibility - Define Attributes form and create the following Attributes
85
Data Type: Varchar2
Label: Flight Destination
86
3.16.2 Add Attributes to AK Region:
Navigate to AK Responsibility - Define Regions form and query for REGION ID = HXC CUI TIMECARD, Click on Region Items
button and add the attributes as shown in the following figure. The remaning attributes that were created in the previous step would
be added to the LOV region at a later stage.
87
create table hxc city names (
city name VARCHAR2(30),
city id NUMBER,
country name VARCHAR2(30)
);
88
Application Name: Time and Labor Engine
Object Name: ICX PROMPTS
Region Style: List of Values
Application Module Definition Name: oracle.apps.hxc.selfservice.configui.server.LovAM
Display Rows: 10 (or however many rows you want displayed in the LOV)
Controller Object Type: oracle.apps.hxc.selfservice.configui.webui.LovCO
Add Indexed Children: (checked)
Leave all other fields blank or to their default value.
Save the record.
89
3.16.5 Create AK region items inside the AK region for the LOV page:
Here you need to create region items for each of the column 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.
So in our example, you would create the following region items inside the HXC ART SOURCE LOV region.
For the Source LOV, we make use of the seeded CustomLov1VO.xml that is delivered in the seeded product.
For the Destination LOV, we make use of a new VO called XXDestLovVO that is not delivered in the seeded
product.
90
Figure 20: LOV AK Region items
91
3.16.6 Setting up the Custom LOV xml and java files:
For the Source City Name LOV, we reuse the delivered VO in $HXC TOP/java/selfservice/timecard/server/CustomLov1VO.xml but
with a customization.
We have to modify the query in the CustomLov1VO.xml file as given below because we do not require the aliasdefintionid column
in this example.
select lov1column1,
lov1column2,
lov1column3,
lov1column4,
lov1column5,
lov1column6,
lov1column7,
lov1column8,
lov1column9,
lov1column10
from hxc cui custom lov1 v
where aliasdefinitionid = :1
Step 1 :
Create a new custom VO $HXC TOP/java/selfservice/timecard/server/XXDestLovVO.xml
92
lov2column8,
lov2column9,
lov2column10
from XX cui custom lov2 v
Step 2 :
Add this newly created XXDestLovVO.xml to the Application Module $HXC TOP/java/selfservice/configui/server/LovAM.xml
After adding this to the AM, the file would have details about this new custom VO which was just created.
</ViewUsage>
<ViewUsage
Name="XXDestLovVO"
ViewObjectName="oracle.apps.hxc.selfservice.timecard.server.XXDestLovVO" >
</ViewUsage>
Place these modified and compiled .xml and .class files in the correct locations.
commit;
93
Figure 21: Flight Source and Destination LOVs
94
Bounce Apache to reflect the changes made in the AK Region on selfservice page.
3.16.8 LDT file customization to change prompt from Hours Type to Job Type:
BEGIN HXC LAYOUT COMPONENTS "Airlines Payroll Timecard Layout - Job Type"
OWNER = "ORACLE"
COMPONENT VALUE = "JOBTYPE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC ART JOB TYPE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "180"
COMPONENT DEFINITION = "PACKAGE CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Payroll Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMP QUALIFIERS "Airlines Payroll Timecard Layout - Job Type"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "PACKAGE CHOICE LIST"
QUALIFIER ATTRIBUTE1 =
"HXC DEPOSIT WRAPPER UTILITIES.timecard hours type list"
QUALIFIER ATTRIBUTE2 =
"@RESOURCE IDENTIFIER ID|@TIMECARD BIND START DATE|@TIMECARD BIND END DATE|
ALIAS|@PAYROLL ELEMENTS|@PUBLIC TEMPLATE"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE24 = "PAYROLL ELEMENTS"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "OTL ALIAS 1"
QUALIFIER ATTRIBUTE27 = "Attribute1"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
BEGIN HXC LAYOUT COMPONENTS "Airways Payroll Timecard Layout - Aircraft Model"
OWNER = "ORACLE"
COMPONENT VALUE = "AIRCRAFT MODEL"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC ART AIRCRAFT"
95
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "190"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Payroll Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMP QUALIFIERS "Airways Payroll Timecard Layout - Aircraft Model"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom1VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom1VO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Element Context"
QUALIFIER ATTRIBUTE27 = "Attribute14"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
96
3.16.10 LDT file customization to include source and destination LOVs:
BEGIN HXC LAYOUT COMPONENTS "Airlines Payroll Timecard Layout - Source Terminal"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC ART SOURCE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "192"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Payroll Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMPONENTS "Airlines Payroll Timecard Layout - Destination Terminal"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC ART DESTINATION"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
97
SEQUENCE = "194"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Payroll Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
98
3.16.11 LDT file customization to include text field:
BEGIN HXC LAYOUT COMPONENTS "Airlines Payroll Timecard Layout - Total passengers"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC ART PASSENGERS"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "196"
COMPONENT DEFINITION = "TEXT FIELD"
RENDER TYPE = "WEB"
PARENT COMPONENT = "Payroll Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
Attach the custom Timecard Layout to the preference node to reflect the changes.
99
3.17 Configure an Entry Level Processing Timecard Layout to capture Project, Task and Expen-
diture Type Information in Cost Allocation Key Flexfield segments
Requirement:
Configure a timecard to capture Job and Location as timecard attributes in element input values, and additionally capture Project,
Task and Expenditure Type in Cost Allocation Key Flexfield segments so that the Projects information can be retrieved to BEE as
well.
=> Create an element with additional input values Job and Location.
=> Define Element Link, Element Set and run Generate Flexfield and Mapping process for this Element set.
=> Define Job and Location AK Attributes and map them to the AK region.
=> Add Project Id, Task Id and Expenditure Type as segments to the Cost Allocation KFF.
=> Modify the ELP timecard layout ldt files to populate Project Id, Task Id and Expenditure Type in hidden
field components which is stored in the Dummy Cost Context Attribute.
=> Modify the ELP layout ldt file to show Job and Location fields.
=> Load the ldt files using FNDLOAD command.
=> Attach the layouts to the Time card layout preference.
100
The above timecard layout has been configured to capture Additional Element Input values and also capture Project, Task and
Expenditure Type information in Cost Allocation KFF segments that can be validated, deposited in time store and retrieved to BEE.
101
3.17.1 Create AK attributes:
Navigate to AK Dev Responsibility - Define Attributes form and create the following Attributes
102
3.17.2 Add Attributes to AK Region:
Navigate to AK Responsibility - Define Regions form and query for REGION ID = HXC CUI TIMECARD, Click on Region Items
button and add the attributes as shown in the following figure.
103
3.17.3 Create database views:
Create view definition for JOB choice list.
3.17.4 Add Project Id, Task Id and Expenditure Type segments to Cost Allocation KFF:
Navigate to Key Flexfield Segments form and query for Title ”Cost Allocation Flexfield” and add the following segments to the
appropriate context.
Name : Project Id
Window Prompt : Project Id
Column : SEGMENT11
Name : Task Id
Window Prompt : Task Id
Column : SEGMENT12
Name : Expenditure Id
Window Prompt : Expenditure Id
Column : SEGMENT13
104
3.17.5 LDT file hxczzhxclayt0025.ldt customization to include JOB and LOCATION choice lists:
BEGIN HXC LAYOUT COMPONENTS "Demo ELP Proj-Pay Timecard Layout - Job"
OWNER = "ORACLE"
COMPONENT VALUE = "JOB"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD JOB"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "218"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"ELP Proj-Pay Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMP QUALIFIERS "Demo ELP Proj-Pay Timecard Layout - Job"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom1VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom1VO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Element Context"
QUALIFIER ATTRIBUTE27 = "Attribute12"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
BEGIN HXC LAYOUT COMPONENTS "Demo ELP Proj-Pay Timecard Layout - Location"
OWNER = "ORACLE"
COMPONENT VALUE = "LOCATION"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD LOCATION"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "220"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"ELP Proj-Pay Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
105
BEGIN HXC LAYOUT COMP QUALIFIERS "Demo ELP Proj-Pay Timecard Layout - Location"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom2VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom2VO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Element Context"
QUALIFIER ATTRIBUTE27 = "Attribute13"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
BEGIN HXC LAYOUT COMPONENTS "Demo ELP Proj-Pay Timecard Layout - Cost Center"
OWNER = "ORACLE"
COMPONENT VALUE = "COSTCENTER"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD COST CENTER"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "216"
COMPONENT DEFINITION = "CHOICE LIST"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"ELP Proj-Pay Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/24"
BEGIN HXC LAYOUT COMP QUALIFIERS "Demo ELP Proj-Pay Timecard Layout - Cost Center"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "CostCenter2VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.CostCenter2VO"
QUALIFIER ATTRIBUTE11 = "TIMECARD BIND END DATE|TIMECARD BIND END DATE"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
106
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Cost Context"
QUALIFIER ATTRIBUTE27 = "Attribute1"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
3.17.7 LDT file hxczzhxclayt0025.ldt customization to map Project Information to Cost Allocation KFF:
BEGIN HXC LAYOUT COMPONENTS "Demo ELP Proj-Pay Timecard Layout - Project"
OWNER = "ORACLE"
COMPONENT VALUE = "PROJECT"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PROJECT"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "202"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"ELP Proj-Pay Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/23"
BEGIN HXC LAYOUT COMP QUALIFIERS "Demo ELP Proj-Pay Timecard Layout - Project"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "ProjectLOVVO"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "HXC CUI PROJECT LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "12"
QUALIFIER ATTRIBUTE6 =
"HxcCuiProjectNumber|PROJECT-DISPLAY|CRITERIA|N|HxcCuiProjectId|PROJECT|
RESULT|N|HxcCuiProjectNumber|PROJECT-DISPLAY|RESULT|N|HxcCuiProjectId|PROJCAKF|RESULT|N"
QUALIFIER ATTRIBUTE8 = "ProjectNumber"
QUALIFIER ATTRIBUTE9 = "ProjectId#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.ProjectLOVVO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "PROJECTS"
QUALIFIER ATTRIBUTE27 = "Attribute1"
QUALIFIER ATTRIBUTE28 = "PROJECT"
LAST UPDATE DATE = "2004/05/23"
107
END HXC LAYOUT COMP QUALIFIERS
BEGIN HXC LAYOUT COMPONENTS "Demo ELP Proj-Pay Timecard Layout - Task"
OWNER = "ORACLE"
COMPONENT VALUE = "TASK"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD TASK"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "206"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"ELP Proj-Pay Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/23"
108
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PROJECT"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/23"
END HXC LAYOUT COMP PROMPTS
BEGIN HXC LAYOUT COMP QUALIFIERS "Demo ELP Proj-Pay Timecard Layout - Task"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "TaskLOVVO"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "HXC CUI TASK LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "12"
QUALIFIER ATTRIBUTE6 =
"HxcCuiTaskNumber|TASK-DISPLAY|CRITERIA|N|HxcCuiTaskProjectId|PROJECT|PASSIVE CRITERIA|Y|
HxcCuiTaskId|TASK|RESULT|N|HxcCuiTaskNumber|TASK-DISPLAY|RESULT|N|HxcCuiTaskId|TASKCAKF|RESULT|N"
QUALIFIER ATTRIBUTE8 = "TaskNumber"
QUALIFIER ATTRIBUTE9 = "TaskId#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.TaskLOVVO"
QUALIFIER ATTRIBUTE14 =
"HxcCuiTaskProjectId|PROJECT|Y#HxcCuiTaskProjectNumber|PROJECT-DISPLAY|Y"
QUALIFIER ATTRIBUTE15 =
"project id = ::HxcCuiTaskProjectId#upper(project number) = upper(::HxcCuiTaskProjectNumber)"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "PROJECTS"
QUALIFIER ATTRIBUTE27 = "Attribute2"
QUALIFIER ATTRIBUTE28 = "TASK"
LAST UPDATE DATE = "2004/05/23"
END HXC LAYOUT COMP QUALIFIERS
109
BEGIN HXC LAYOUT COMP QUALIFIERS
"Demo ELP Proj-Pay Timecard Layout - Task Hidden"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "HIDDEN FIELD"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE23 = "FORM"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Cost Context"
QUALIFIER ATTRIBUTE27 = "Attribute12"
QUALIFIER ATTRIBUTE28 = "TASKCAKF"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
BEGIN HXC LAYOUT COMPONENTS "Demo ELP Proj-Pay Timecard Layout - Expenditure Type"
OWNER = "ORACLE"
COMPONENT VALUE = "EXPENDITURETYPE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD EXPTYPE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "210"
COMPONENT DEFINITION = "LOV"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"ELP Proj-Pay Timecard Layout - Day Scope Building blocks for worker timecard matrix"
LAST UPDATE DATE = "2004/05/23"
110
QUALIFIER ATTRIBUTE11 =
"TIMECARD BIND END DATE|TIMECARD BIND END DATE|TIMECARD BIND START DATE|TIMECARD BIND END DATE|
TIMECARD BIND END DATE|TIMECARD BIND START DATE"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "PROJECTS"
QUALIFIER ATTRIBUTE27 = "Attribute3"
QUALIFIER ATTRIBUTE28 = "EXPTYPE"
LAST UPDATE DATE = "2004/05/23"
END HXC LAYOUT COMP QUALIFIERS
111
The output log should be checked to ensure that there are no errors loading the layout.
Attach the custom Timecard Layout to the preference node to reflect the changes.
The row with Attribute Category ”Dummy Cost Context” stores the Project Id, Task Id and Expenditure Type in Attribute11, At-
tribute12 and Attribute13 respectively as the Cost Allocation KFF is modified and the ldts are configured to store data in this format.
112
3.17.9 Batch Element Entry form showing the additional segments in Cost Allocation KFF:
Create a timecard with this configured layout and run Transfer Time from OTL to BEE process for the timecard to be transferred
to BEE. When the batch is queried in BEE and the Element Lines are seen, the Cost Allocation KFF segments will contain the Cost
Center information, Project, Taks and Expenditure Type Information entered in the timecard.
113
4 Technical Reference Guide
4.1 Components
Components are the visual items that build up an OTL layout file, and each component can have qualifiers which control various
aspects of how the component behaves. Along with qualifiers specific to each component, there are also a number of global qualifiers
which are settable for all components, although not necessarily used or supported - qualifiers are made to be global if they apply to
a wide range of components.
This section covers all the components that the OTL Configurable UI supports along with their qualifiers, but inclusion here
does not necessarily mean the component/qualifier is supported for use in customized layouts. The key for the tables defined below
is intended to act as a guide to the restricted components. Many of the development only qualifiers are subject to change without
notice and should not be changed.
2. The outside direction setting controls which side of the timecard matrix attributes are shown. Position is relative to the day
level fields (ie. Measure, start/stop time) and individual positioning either side will be determined by the sequence set for each
component.
114
No Purpose Description Valid Values Notes
16 Component Oracle Development Use N/A (D) (!)
Level Only
17 Style Class CSS Style class Any valid style class name (*) (C)
18 Display The display mode for this INCLUDE,EXCLUDE
Mode Flag component1
19 Display The display mode list used in TIMECARD, TEMPLATE, CSV (Export),
Mode List conjunction with qualifier 18 TIMECARD-SAVEFORLATER, TIMECARD-
SAVETEMPLATE, REVIEW, READ-ONLY,
DETAILS-REMOVE, REVIEW-REMOVE
20 Display Force the component to Y, N (D) (!)
On New be rendered in a new ta-
Line ble cell - Development
Use Only
21 Show Out- Determines whether or not a Y,N (D)
side Build- component should be shown
ing Block outside the timecard matrix
22 Outside Di- Determines which side of L,R (M)
rection the timecard matrix the at-
tribute will be shown2
23 Render * Oracle Development Use (D)
Type Only *
24 Display * Oracle Development Use (D)
Modes Only *
25 Access Determines the access FLEX, CUI, TIME BUILDING BLOCK,
Method method for the data source TIME BUILDING BLOCK ATTRIBUTE, TIME-
CARD ATTRIBUTE, STATIC
26 Context The flex context for the data A valid flex context (C)
source
27 View The flex attribute for the A valid attribute name within the flex context (C)
Object data source
Attribute
28 Component * Oracle Development Use (D)
Alias Only *
29 Component * Oracle Development Use (D)
Identifier Only *
30 Read Only Sets the read-only flag (*)
Table 13: Global Attributes, applicable to every component. Required attribute(s) in bold.
115
4.1.2 Accrual Balance Component
Context: ACCRUAL BALANCE
Description: The Accrual Balance component has been added as an extra feature to our existing timecard entry screen to facilitate
users to see the Paid Time-Off Accrual balances he is entitled to and also assists him in entering the absence hours. This component
appears only in the Timecard Entry Screen and will not be available in Review and the Confirmation screens. This is a simple display
component and all the display processing is done in the Java Component class. The Accrual Balances are shown to the user through
a show/hide hyperlink region and by default the component will be in hide state. Selecting the hyperlink will evaluate and display the
accrual balances for the user. The display of this component is optional and is controlled via the preference ’Timecard allows display
of Accrual Balances’. By default this perference is set to ’No’ and hence the component will not appear in the TimeEntry Screen.
For this component the display mode flag and the display mode list are configured to EXCLUDE and —TEMPLATE—CSV—
respectively to ensure the component appears only in the Time-Entry Screen.
116
No. Purpose Description Valid Values Notes
1 ViewObject Name This is the name of the view object Valid view ob- (C)
that is attached to the choice list1 ject name
2 Cache Enabled Enable the cache for the View Object2 Y,N (!)
3 Always Execute for Read Instructs the view object to perform the Y,N
Only query associated even if there is no ID
value stored.3
4 Show Prompt Render associated prompt along with the Y,N
component4
5 Required * Oracle Development Use Only * Y,N (D),(!)
8 Displayed Attribute This is the name of the attribute in the A valid attribute (C)
Name View Object that should be used for the name in the view
displayed value of the field object for the
component
9 ID Attribute Name This is the name of the attribute in the A valid attribute (C)
View Object that should be used for the name in the view
stored value of the field object for the
component
10 View Object Class Full class reference of the view ob- A valid view (C)
ject for the component object refer-
ence
11 Bind Variable #1 Parameter to bind to the view object5 Valid bind
parameter
structure
12 Bind Variable #2 Parameter to bind to the view object5 Valid bind
parameter
structure
13 Bind Variable #3 Parameter to bind to the view object5 Valid bind
parameter
structure
14 Bind Variable #4 Parameter to bind to the view object5 Valid bind
parameter
structure
15 Bind Variable #5 Parameter to bind to the view object5 Valid bind
parameter
structure
Table 14: Choice List Components. Required Attribute(s) are displayed in bold.
117
4.1.4 Descriptive FlexField
Context:DESCRIPTIVE FLEX
Description: This component is used to render a descriptive FlexField onto the page. At the current time its use is limited to
rendering the appropriate FlexField on the details page for each day.
Notes:* Oracle Development Use Only *
Table 15: Descriptive flexfield component qualifing attributes. Required attribute(s) are displayed in bold.
118
4.1.5 Display Header
Context:DISPLAY HEADER
Description: This component is used to display a header on the layout. The header text is retrieved from the prompt data attached
to the component.
Table 16: Display text component qualifing attributes. Required attribute(s) are displayed in bold.
Table 17: Inter Period Navigational Control component qualifing attributes. Required attribute(s) are displayed in bold.
119
4.1.11 Key Notation
Context: KEY NOTATION
Description: This component is used to control the display of some page key message such as the one for required fields.
Notes: Oracle Development Use Only
Table 18: Key notation component qualifing attributes. Required attribute(s) are displayed in bold.
1. if using a new View Object that you have defined please ensure the application module name and class are also specified so
that the object can be referenced correctly. See Application Modules for more information.
2. Enabling View Object caching should be used with caution. The cache is based on the static criteria bound to the view
object, but in many views there are dynamic criteria referenced from global variables or profiles that may mean the same bind
parameters may not result in the same set of data. In general this qualifier should always be set to ’N’.
3. The qualifiers still reference the AK region name and application ID for backwards compatibility, but the LOV region must be
migrated to the MDS repository.
4. The display width is set as the width on the HTML component produced by the configurable UI. Depending on your font
settings the number of characters that can be displayed for a given field width can vary.
5. This qualifier is used to set up the criteria used for the LOV. It is a tokenized string consisting of 4 items per criteria, each
separated by a pipe symbol ’—’.Note: when a LOV component is rendered by the configurable UI it will actually render two
components. One contains the actual ID that is submitted and saved with the timecard (this component can be referred to by
the alias given to the LOV component in the layout definition). This ID component is rendered on the page as a hidden field
and the ID value in the LOV should be returned to it.The other field that is rendered is the actual text field that can be seen on
the page. This field contains the ’display’ value for the LOV. This field has an implicit alias given to it of the base alias name
followed by ’-DISPLAY’. This alias should also be populated as a result of the LOV. Bear in mind that if you create other fields
on the screen that are dependant on the ID of a field, then you should also take into account the ’display’ value to cover the
scenario where a user is manually entering values into the LOV text fields (in this scenario the ID fields will not be populated).
6. If your LOV needs to populate additional columns from the query (eg. If one of the displayed fields has a composite primary
key and both fields need to be populated) then this qualifier can be used. This qualifier is used in conjunction with the LOV
result criteria - if the LOV is used on a page, then the additional results should be populated with that. This qualifier is used in
the cases when the LOV does not fire (and so the additional columns would not be populated usually). When the SQL query is
performed for the LOV this qualifier will be checked and additional results will be populated based on its contents. The format of
this qualifier is: ¡Component Alias¿—¡View Object Attribute¿. Where ¡Component Alias¿ is the name of the component being
used to store the value (usually a hidden field component), and ¡View Object Attribute¿ is the name of the view object attribute
that the column should be populated from. For example, the System Linkage Function is returned as a result of the Expenditure
120
Type query. Note that the in page population of result fields is handled in qualifier attribute6 as stated above - this qualifier
is used for the case when the LOV functionality is not used on the screen and a value is entered manually. In this scenario,
when the page is submitted, the query for the LOV will be executed with the manually entered value and if a unique result is
found the ’result’ columns will be populated using the attribute in the VO specified by this qualifier. To allow multiple result
columns to be specified, this qualifier is a token separated string consisting of ’ALIAS—View Object Attribute Name’ pairs.
So for example, if you have a query and wish the component aliased as ’PROJECT’ to contain the value from the ’ProjectId’
column in the VO, and the component aliased as ’PROJECTCODE’ to contain the value from the ’ProjectCode’ column in the
VO, the qualifier would be: QUALIFIER ATTRIBUTE7 = ”PROJECT—ProjectId—PROJECTCODE—ProjectCode”
7. View Object bind parameters can either be associated with the View Object one at a time (ie. In each of the bind qualifiers
1-5), or if support for more than 5 parameters is needed then the whole set can be defined in qualifier 1 using the format
’BIND1—BIND2—BIND3—etc’.
8. If your LOV is dependant on the value of another field, then qualifiers 14 and 15 can be used to restrict the choices available
in the list based on that value. These settings are also used to ensure that the correct results are returned from queries on the
field. Qualifier 14 contains the mappings between items in the LOV and aliases in the timecard for the purposes of building
the query clause at runtime. There is a third value which is used to specify if this mapping is also to be used when the LOV is
built - in most cases this will be set to Y, but may be set to N in cases where the appropriate values are being passed into the
LOV code using the criteria. The value for this qualifier is a double token separated list - for each dependent item there is a
tokenized string in the form ’Lov Item Name—Alias—Use in LOV’. If there is more than one dependent item more can be added,
separating each one with a hash ’#’ - i.e. ’Item1—ALIAS1—Y#Item2—ALIAS2—Y’ Qualifier 15 is linked to the dependent
item list qualifier outlined above. The value for this qualifier is also a token separated string and contains the fragments of SQL
to be added to the where clause if a value for the dependent item exists. There should be one entry on this list for each of the
dependent items specified in qualifier 14 - each of the entries is separated by a hash sign ’#’. In order to reference the value of
the dependent item, you can prefix the LOV item name with two colons. For example ’my column = ::Item1’. Note that for
LOVs the displayed value is implicitly added to the where clause using UPPER to make it case-insensitive.
See the LOV and JRAD/MDS and example section for additional information about LOVs.
121
No Purpose Description Valid Values Note
1 View Object name This is the name of the view object Valid view object name (C)
that is attached to the LOV1
2 Cache Enabled Cache the View Object?2 Y,N (D)(!)
3 LOV AK Region AK region that defines the LOV Valid AK LOV region
Code page3
4 LOV AK Region Ap- Application ID of the AK region Application ID for the AK
plication ID that defines the LOV page LOV region specified
5 Display Width Display width of the LOV field4 Numeric
6 LOV Criteria LOV criteria - this controls what val- Valid Criteria String5 (C)
ues the LOV is restricted by, along
with the values populated when a re-
sult is selected (5)
7 Result Column Map- Specifies additional columns to populate (C)
pings from the LOV query6
8 Displayed Attribute This is the name of the attribute in the A valid attribute name in the (C)
Name View Object that should be used for the view object for the component
displayed value of the field
9 ID Attribute Name This is the name of the attribute in the A valid attribute name in the (C)
View Object that should be used for the view object for the component
stored value of the field
10 View Object Class Full class reference of the view ob- A valid view object refer- (C)
ject for the component ence
11 Bind Variable #1 Parameter to bind to the view object7 Valid bind parameter
12 Bind Variable #2 Parameter to bind to the view object7 Valid bind parameter
13 Bind Variable #3 Parameter to bind to the view object7 Valid bind parameter
14 Dependant Item List Specifies a list of dependant fields that can (C)
be used to restrict the LOV8
15 Dependant Item Where Specifies the where clause fragment that (C)
Clause should be appended for each of the above
dependant fields
Table 19: List of Values component qualifing attributes. Required attribute(s) are displayed in bold.
122
4.1.13 Message Box
Context:MESSAGE BOX
Description:This component displays an imbedded message dialog on the timecard page. The type of dialog and FND message to
use for the text is defined in the qualifiers.
Notes:Development Use Only
Table 20: Message Box component qualifing attributes. Required attribute(s) are displayed in bold.
2. The configurable UI will not usually execute a query unless there is an ’ID’ stored for a field since. This option forces the
view object to execute even if there is no id - this should be used in conjunction with the read-only qualifier when you wish to
create a read-only field based on a SQL query. When in this mode, the first row returned will be shown in the case of multiple
matches.
123
No. Purpose Description Valid Values Notes
1 Function Call Function call for the package choice
list (in package.function format)
2 Parameter List List of parameters to be passed to the
function (passed by order)
3 Cache Enabled Enable the cache for the View Object1 (!)
4 Show Prompt Render associated prompt along with the Y,N
component
5 Required Oracle Development Use Only Y,N (D)(!)
6 Always Execute for Read Instructs the view object to perform the Y,N
Only query associated even if there is no ID
value stored.2
Table 21: Package Choice List component qualifing attributes. Required attribute(s) are displayed in bold.
Table 22: Page Status component qualifing attributes. Required attribute(s) are displayed in bold.
4.1.17 Spacer
Context:SPACER
Description:This component can be used to add extra white space between components on the page.
Notes:
Table 23: Spacer component qualifing attributes. Required attribute(s) are displayed in bold.
124
No. Purpose Description Valid Values Notes
1 Submit Action The form action parameter (used Alphanumeric (D)
to identify what submit button has string
been used)
Table 24: Submit Button component qualifing attributes. Required attribute(s) are displayed in bold.
Table 25: Submit Icon component qualifing attributes. Required attribute(s) are displayed in bold.
Table 26: Summary Table component qualifing attributes. Required attribute(s) are displayed in bold.
125
No. Purpose Description Valid Values Notes
1 Number of Columns The number of columns in the table1 Numeric
2 Cell Spacing HTML Cell spacing set on the table Numeric
3 Cell Padding HTML Cell padding set on the table Numeric
4 Cell Width HTML Cell width set on the table Numeric
5 Horizontal Alignment HTML Cell horizontal alignment set on
the table
Table 27: Table Layout component qualifing attributes. Required attribute(s) are displayed in bold.
Table 28: Template Control component qualifing attributes. Required attribute(s) are displayed in bold.
1. The display width is set as the width on the HTML component produced by the configurable UI. Depending on your font
settings the number of characters that can be displayed for a given field width can vary.
4.2 Tokens
Table 31 displays the list of currently understood tokens, e.g. for use as bind parameters etc.
126
No. Purpose Description Valid Values Notes
1 Show Label (Compo- Flag to determine whether or not Y,N
nent) the component should render its
own prompt
2 Show Label (Parent Flag to determine whether or not Y,N
Component) the parent component should render
the prompt for the component
3 Field Width Display width of the LOV field1 Numeric
4 Field Height The height/number of lines to use for the Numeric
text field
5 Maximum Length The maximum length (in characters) to Numeric
enforce for this field
6 CSS Class CSS Style class Any valid style
class name
7 Read-Only CSS Class CSS Style class to use when the field is Any valid style
rendered in read-only mode class name
Table 29: Text Field component qualifing attributes. Required attribute(s) are displayed in bold.
127
No. Purpose Description Valid Values Notes
1 Orientation Controls the orientation that the H,V (D)(!)
building block is rendered in
2 Grouping Controls the way the building blocks D,N (D)(!)
are grouped
3 Scope Scope of the building block D,T (D)(!)
4 Building Block Num- Not used (D)(!)
ber
5 Show Horizontal To- Flag to determine if the horizontal Y,N
tal total should be shown on the time-
card matrix
6 Show Vertical Total Flag to determine if the vertical to- Y,N
tal should be shown on the timecard
matrix
7 Add Row Button Flag to determine if the add row Y,N
button should be shown on the time-
card matrix
8 Recalculate Button Flag to determine if the calculate Y,N
button should be shown on the time-
card matrix
9 Delete Enabled Not used Not
used
10 Building Block Align- Controls the alignment of the table cells (D)(!)
ment generated
11 Building Block Display Not used (D)(!)
Style
Table 30: Time Building Block component qualifing attributes. Required attribute(s) are displayed in bold.
128
Name Description
TIMECARD ID The ID of the timecard level building block for the current
timecard - this ID along with the version number is used
to uniquely identify a timecard row.
TIMECARD OVN The version number of the timecard - this number along
with the ID is the key needed to uniquely identify a
timecard. The version number is incremented each time
changes are made to a timecard.
TIMECARD START DATE The formatted start date of the timecard period.
TIMECARD END DATE The formatted end date of the timecard period.
TIMECARD BIND START DATE The start date of the timecard period in canonical format
- the primary use of this format is to pass the date in a
standard character format (ie. Bind variables)
TIMECARD BIND END DATE The end date of the timecard period in canonical format
- the primary use of this format is to pass the date in a
standard character format (ie. Bind variables)
RESOURCE IDENTIFIER TYPE The type of resource the timecard is for - at the current
time this will always be ’PERSON’.
RESOURCE IDENTIFIER NAME The name of the resource for the timecard (ie. The persons
name).
RESOURCE IDENTIFIER ID The ID of the resource.
BUSINESS GROUP ID The business group ID for the resource - primarily used for
bind variables.
129
Code Name Long Label
HXC APPR FRAG HEADER TITLE Approval Fragmentation Review Approver Com-
Header ments: @RI NAME,
@RA NUMBER
HXC CUI ADD ANOTHER ROW Timecard Add Another Row Add Another Row
Label
HXC CUI ALTERNATE NAME4 Alternate Name Item 4 Label Alternate Name Item 4
HXC CUI ALTERNATE NAME ITEM1 Alternate Name Item 1 Label Alternate Name Item 1
HXC CUI ALTERNATE NAME ITEM2 Alternate Name Item 2 Label Alternate Name Item 2
HXC CUI ALTERNATE NAME ITEM3 Alternate Name Item 3 Label Alternate Name Item 3
HXC CUI ALTERNATE NAME ITEM5 Alternate Name Item 5 Label Alternate Name Item 5
HXC CUI ANNUAL ACCRUAL Annual Leave Balance Annual Leave Balance
HXC CUI APPR REJECT COMMENT Approval Rejection Com- Approver’s Comments:
ment
HXC CUI CALCULATE Timecard Calculate Label Calculate
HXC CUI COMMENTS LABEL Timecard Comments Export Comments
Label
HXC CUI HORIZONTAL TOTAL LABEL Timecard Horizontal Total Total
Prompt
HXC CUI MONTHLY ACCRUAL Monthly Leave Balance Monthly Leave Balance
HXC CUI TIMECARD APPR OVERRIDE Timecard Approver Override Overriding Approver
HXC CUI TIMECARD AUDIT REASON Reason Label Reason
HXC CUI TIMECARD COMMENTS Comments Comments
HXC CUI TIMECARD FRAG BUTTON Approver Comments Approver Comments
HXC CUI TIMECARD PERIOD Timecard Period (days) Timecard Period (days)
HXC CUI TIMECARD WEEK STARTING Week Starting Week Starting
HXC CUI TOTAL LABEL Timecard Total Label Total
HXC CUI VERTICAL TOTAL Timecard Vertical Total Total
Prompt
HXC HOURSTYPE OVERTIME LABEL Timecard Hours Type Over- Premium
time Label
HXC HOURSTYPE REGULAR LABEL Timecard Hours Type Regu- Regular
lar Label
HXC HOURSTYPE TOTALHOURS LABEL Timecard Hours Type Total Total Hours Entered
Hours Label
HXC TEMPLATE LABEL CUI Template Label Template
HXC TEMPLATE SUBMIT BUTTON CUI Template Go Button La- Go
bel
130
Code Name Long Label
HXC TIMECARD APPLY SELECTED Apply to Selected label Apply to Selected
HXC TIMECARD AUDIT DAY Audit Page Day Header Day
HXC TIMECARD AUDIT DTENTERED Audit Page Date Entered Date Entered
Header
HXC TIMECARD AUDIT HOURS Audit Page Hours Header Hours
HXC TIMECARD AUDIT REASON Audit Page Reason Reason
HXC TIMECARD COMMENT Audit Page Comment Comment
HXC TIMECARD CONTEXTLIST Timecard Context List Context List
Prompt
HXC TIMECARD COST CENTER Timecard Cost Center Cost Center
Prompt
HXC TIMECARD DELETE Delete Label Delete
HXC TIMECARD DETAILS Details Label Additional Details
HXC TIMECARD DETAIL HEADER Timecard Details Header Additional De-
tails: @RI NAME,
@RA NUMBER
HXC TIMECARD DETAIL TITLE Timecard Detail Title Detail Information: @!DE-
TAIL DAY HEADER
HXC TIMECARD DUPLICATE Duplicate Duplicate
HXC TIMECARD EXPTYPE Expenditure Type Type
HXC TIMECARD HEADER TITLE Timecard Header Title Time Entry: @RI NAME,
@RA NUMBER
HXC TIMECARD HOURS TYPE Timecard Hours Type Hours Type
Prompt
HXC TIMECARD MEASURE Measure Measure
HXC TIMECARD NEW ENTRY Audit Page New Entry New Entry
HXC TIMECARD OLD ENTRY Audit Page Old Entry Old Entry
HXC TIMECARD PERIOD GO LABEL Timecard Period Go Button
Label
HXC TIMECARD PERIOD LABEL Timecard Period Label Period
HXC TIMECARD PROJECT Project Project
HXC TIMECARD QUANTITY Quantity Hrs
HXC TIMECARD SAVE TEMPL BUTTON Timecard Save As Template Save as a Template
Submit Button
HXC TIMECARD SAVE TEMPL LABEL Timecard Save As Template Template Name
Label
HXC TIMECARD STARTTIME Start Time Start
HXC TIMECARD STOPTIME Stop Time Stop
HXC TIMECARD SYSLINKFUNC System Linkage Function System Linkage Function
HXC TIMECARD TASK Task Task
HXC TIMECARD TEMPLATE LABEL Timecard Template Label Template
HXC TIMECARD TEMPLATE OW LABEL Timecard Template Over- Overwrite Entry
write Label
HXC TIMECARD TEMPLATE SUBMIT Timecard Template Submit Apply Template
Label
HXC TIMECARD TIP TEXT Timecard Tip Text Enter your time for the two
week time card period.
HXC TIMECARD TIP TITLE Timecard Tip Title Timecard Period
Starting: @TIME-
CARD START DATE
132
Message Name Message Text
HXC SAVEFORLATER CONFIRM The timecard has been saved successfully.
HXC SAVEASTEMPLATE CONFIRM The timecard has been successfully saved as a template.
HXC SUBMIT CONFIRMATION Time entries for the given timecard period have been sub-
mitted successfully.
HXC 366216 DUP ATTR ENTRY You have entered duplicate time attributes. This is not
currently supported. Enter unique time attribution on
each row.
HXC PROJECTS DETAIL TIP TEXT
HXC TIMECARD TIP TEXT ¡b¿¡/b¿
133
Error Code Meaning
CUI COMPONENT MESSAGE NOT FOUND The message entity specified in the message alias on the
component could not be found (check it exists and that
the alias is correct).
CUI COMPONENT PROMPT NOT FOUND The prompt entity specified in the prompt alias on the
component could not be found (check it exists and that
the alias is correct).
CUI COMPONENT PROPERTY NOT FOUND The property specified for the component could not be
found - confirm you have edited the layout correctly if this
message is seen.
CUI INVALID RENDER METHOD Internal development code - an incorrect render method
for the configurable UI to use has been specified
CUI INVALID QUERY METHOD Internal development code -an incorrect query method to
find the layout id has been specified
CUI NO COMPONENTS The layout was located, but no components were found in
it - if a script has been run to delete components from ta-
bles it will usually leave the main row intact so the same
id can be reused to load the layout to avoid breaking pref-
erences. Reload the layout to resolve this error.
CUI NO LAYOUT FOUND No layout was found with the ID specified for the user -
confirm preferences are correct and that the layout has not
been deleted manually from the tables
CUI NO RESOURCE ID No ID was found for the person - confirm the user has an
employee attached
CUI NULL LAYOUT NAME Internal development code - the layout name is null.
CUI PARENT WEBBEAN NOT FOUND The parent webbean reference for the component could
not be found - check for PARENT BEAN attributes with
aliases that do not resolve to another component (they
should map to a COMPONENT ALIAS attribute on an-
other component)
CUI PREF LAYOUT ID ERR The layout ID from the user preferences was not found
CUI PREF LAYOUT ID NULL The layout ID from the user preferences is null
CUI UNKNOWN RENDER METHOD Internal development code - an incorrect render method
for the configurable UI to use has been specified
CUI UNKNOWN QUERY METHOD Internal development code -an incorrect query method to
find the layout id has been specified
134
Error Code Meaning
DFF INCOMPLETE FLEX CONTEXT Internal development code - the flex context is missing or
corrupt
DFF NULL FLEX APP SHORT NAME The FlexField application short name was not set for the
descriptive flex component
DFF NULL FLEX NAME The FlexField name was not set for the descriptive flex
component
DFF NULL FLEX REGION NAME The region name was not set for the descriptive flex com-
ponent
DFF NULL FLEX REGION APP ID The region application id was not set for the descriptive
flex component
DH NULL LABEL The label for the display header component is not set
HOURS TYPE MULTI ROWS Internal development code - the hours type query returned
multiple rows
INPD NO RESOURCE ID Internal development code -resource ID was not available
for the inter-period navigation control
LOV APP MODULE CREATE ERROR Internal development code - there was a problem creating
an application module
LOV INCOMPLETE CRITERIA The criteria specified for the LOV component are incom-
plete - check that there are 4 values for each of the criteria
LOV INCOMPLETE MAP The result map specified for the LOV is not complete -
confirm there are 3 values set for each of the maps
LOV INVALID MAPPINGS There is a mismatch between the number of dependant
item lists and dependant item where clauses (qualifiers 14
and 15 on the LOV component) - check the qualifiers to
ensure there is a dependant where clause specified for each
of the dependant items
LOV NULL REGION APP ID The application ID for the LOV region is not set
LOV NULL REGION CODE The region code for the LOV region is not set
LOV NULL COMPONENT ALIAS An alias reference in the LOV criteria could not be resolved
- check all alias references exist and are correct
LOV QUERY COLUMNS INVALID The result column mappings for the LOV are incorrect -
check the values specified
MB MESSAGE NOT FOUND The message alias referred to in the message box compo-
nent could not be resolved - check the message entity with
the alias exists
MB NULL TEXT The message attached to the message box component is
null
NULL DISPLAY LABEL The display label attached to the component is null
TBB BB NUM NOT SET Internal development code - the building block count prop-
erty count not be retrieved
TC NO RESOURCE ID Internal development code -resource ID was not available
for the template control
TF NULL NAME Internal development code - the form field name for the
text field component is null
135
5 Troubleshooting and Frequently Asked Questions
When reporting suspected bugs or issues with configuration using the OTL Configurable UI please ensure you include the following
information:
• A full java stack trace of the issue if applicable (if a generic framework error page is shown, click the link in the error message
to see the full stack trace - please include the full text when reporting errors).
• Details of your patch level - in particular the level of the Oracle Applications Framework you are running along with any related
patches you have applied.
• If the issue is with a configured timecard then please include all of the layout files, and any custom objects such as View Objects
and Application Modules
• Full and detailed steps to reproduce the error
In addition, if you are using a customized timecard then please try and reproduce the error using the delivered timecard layouts
if possible.
5.1 FAQ
136