Vous êtes sur la page 1sur 75

Oracle Applications

Oracle Time and Labor


Configuring The Oracle Time and Labor Timecard User Interface
White Paper∗
Author(s): Oracle Time and Labor Development
Generation Date: March 6, 2006

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.

∗ The document source is at: /hrdev/hxc/11.5/doc/whitepapers/hxcconfiguiwp.tex

1
Contributors
Name Position
Mark Stewart Applications Developer
Andrew Rundell Development Manager
Joel Dupont Applications Developer
John Finnegan Principle Functional Analyst
Kris Van Der Pleog Functional Analyst

Change Record
Date Author Version Change Reference
Febraury 1st , 2005 Andrew Rundell 115.0 Converted to PDF, WIKI, LaTeX

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 6
1.1 Executive Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2 Structure of a Timecard Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.2.1 Time Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.2.2 User Interface Component Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.3 Layout Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4 Delivered Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4.1 Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.2 Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.3 Projects and Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.4.4 Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.4.5 Enterprise Asset Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4.6 Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4.7 Projects-Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.5 Using the OAF Personalization Functionality With Timecard Configuration . . . . . . . . . . . . . . . . . . . . . . . . 14

2 Timecard Configuration Basics 15


2.1 The Layout File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.2 Using an Existing Layout as a Basis for Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3 Uploading Timecard Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4 Labels and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4.1 Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4.2 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.5 Further Configuration Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.5.1 View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.5.2 Application Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.5.3 Apache/JServ server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.6 Delivered Configurable BC4J Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.6.1 Configurable Choice List Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.6.2 Package Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.6.3 Custom Alternate Name components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.7 LOVs and JRAD/MDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

3 Examples of Common Customizations 23


3.1 Adding a Custom Choice List to the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.2 Adding a Custom LOV to the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.2.1 Create the View Object for the LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.2.2 Create AK attributes used for the LOV screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.2.3 Create an AK region for rendering the LOV screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.2.4 Create AK region items inside the AK region for the LOV page . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.2.5 Run the migration script to copy the LOV definition from AK to the MDS repository . . . . . . . . . . . . . . 27
3.2.6 Modify a layout to include the LOV component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.2.7 Include the new LOV View Object into your Apache/Jserv environment . . . . . . . . . . . . . . . . . . . . . . 28
3.3 Changing the title of the timecard page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.4 Changing the label for a column in the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.5 Adding a Component to the Timecard Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.5.1 Create AK data for the component prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.5.2 Create wrapper PL/SQL function to call the payroll code function and return it in the format needed for the
package choice list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.5.3 Create the component to show the label for our custom field and add it to the layout . . . . . . . . . . . . . . 37
3.5.4 Create the component to show the read-only function result and add it to the layout . . . . . . . . . . . . . . . 37
3.6 Adding a Component to the Timecard Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.7 Adding an OTL Information Type to the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.8 Adding additional element input values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.9 Configuring the Cost Center component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3
3.10 Adding OTLR Detail to the Review and Confirmation Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.10.1 Creating the Detail Time Building Blocks in the Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.11 Adding the Details Page DFF Segments to the Timecard matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.11.1 Setting the Attribute Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.11.2 Aliasing A Segment Value To Set The Attribute Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.11.3 The Simple Approach: An Always-execute choice list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.11.4 Other Segment Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4 Technical Reference Guide 56


4.1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4.1.1 Global attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4.1.2 Accrual Balance Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.1.3 Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.1.4 Descriptive FlexField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
4.1.5 Display Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.6 Display Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.7 Display Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.8 Hidden Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.9 Hours Type Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.10 Inter-Period Navigation Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.11 Key Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.1.12 List Of Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
4.1.13 Message Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.1.14 Notification Day Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.1.15 Package Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.1.16 Page Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.1.17 Spacer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.1.18 Submit Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
4.1.19 Submit Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
4.1.20 Summary Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
4.1.21 Table Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
4.1.22 Template Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
4.1.23 Text Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.1.24 Timecard Fragmentation Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.1.25 Time Building Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.2 Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.3 Seeded Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.3.1 HXC CUI TIMECARD Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.3.2 HXC CUI TIMECARD REVIEW Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.3.3 HXC CUI TIMECARD CONFIRMATION Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.4 Seeded Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.5 CUI Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5 Troubleshooting and Frequently Asked Questions 75


5.1 FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

4
List of Tables
1 Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2 Projects Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3 Projects and Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4 Exception Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5 Enterprise Asset Management Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
6 Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
7 Projects-Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
8 Delivered Custom Choice List View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
9 Component Tables Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
10 Global Attributes, applicable to every component. Required attribute(s) in bold. . . . . . . . . . . . . . . . . . . . . . 57
11 Choice List Components. Required Attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
12 Descriptive flexfield component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 60
13 Display text component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 61
14 Inter Period Navigational Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . 61
15 Key notation component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 62
16 List of Values component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 63
17 Message Box component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 64
18 Package Choice List component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 65
19 Page Status component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 65
20 Spacer component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . 66
21 Submit Button component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . 66
22 Submit Icon component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 67
23 Summary Table component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . 67
24 Table Layout component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 67
25 Template Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . 67
26 Text Field component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . 68
27 Time Building Block component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 68
28 Currently recognized tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
29 Timecard region seeded prompts (Part 1.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
30 Timecard region seeded prompts (Part 2.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
31 Timecard Review region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
32 Timecard Confirmation region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
33 Seeded Timecard Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
34 Configurable User Interface Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
35 Configurable User Interface Error Codes (Part 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

5
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 this document applies to HXT.H, Oracle Applications Release 11i.10

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
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.

6
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.

1.2 Structure of a Timecard Page


1.2.1 Time Building Blocks
When entering time, you actually create objects (database records) called time building blocks. Time entry for a particular day
creates a new time building block, each entry being a separate block. Each time building block may store information about what
that time represents; these are time building block attributes.
There are two types of time building blocks:

• 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.

1.2.2 User Interface Component Hierarchy


As previously mentioned, user interface components — hereafter known simply as components — are the objects belonging to a
timecard layout to make up the page.
Although the components on each layout can be very different they all follow a similar hierarchy - an example of this hierarchy
can be seen below:

• message box components to be show for errors/warnings/confirmations


• page status
• 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

7
∗ 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.

1.3 Layout Types


Each layout contains the component hierarchy definition for one page. Thus, it is beneficial to describe a layout by functional type
of page defined by that layout. Thus, we consider the following layout types:

• timecard (time entry page)

• review (timecard review page)

• confirmation (timecard confirmation page)

• details (timecard details page where applicable)

• export (template used for the timecard export functionality)

• notification (timecard review page as seen by the timecard approver)

• fragment (timecard review page as seen by an approver, but containing only those time entries for which the approver can
approve time, e.g. all the projects entries, all the payroll entries — this layout type is used in conjunction with the Entry Level
Approval functionality of OTL

• audit (the page on which audit entries, also known as reasons, are made)

A group of layouts comprising one layout from each type with common application fields, e.g. Payroll Timecard Layout, Payroll
Review Layout, Payroll Confirmation Layout, Payroll Notification Layout etc., is sometimes referred to as a layout set.

1.4 Delivered Layouts


In order to facilitate rapid implementation, a number of common timecard layout sets are delivered with OTL. These meet many re-
quirements for capturing time, or can be used as the basis for customization. Find these layout files in $APPL TOP/hxc/11.5/patch/115/im
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.

8
Figure 1: Time Building Blocks

9
1.4.1 Payroll
The payroll layouts delivered with the product are listed in table 1.

Layout Name Layout Code Layout Type Filename


Payroll Timecard Layout PAYROLL-TIMECARD TIMECARD hxczzhxclayt0000.ldt
Payroll Review Layout PAYROLL-REVIEW REVIEW hxczzhxclayt0005.ldt
Payroll Confirmation Layout PAYROLL-CONFIRMATION CONFIRMATION hxczzhxclayt0001.ldt
Payroll Export Timecard Layout PAYROLL-EXPORT-LAYOUT EXPORT hxczzhxclayt0002.ldt
Payroll Fragmented Timecard View PAYROLL-FRAGMENT FRAGMENT hxczzhxclayt0003.ldt
Payroll Notification Layout PAYROLL-NOTIFICATION NOTIFICATION hxczzhxclayt0051.ldt
Payroll OTLR Details Review Layout PAYROLL-HE-REVIEW REVIEW hxczzhxclayt0004.ldt
Payroll OTLR Details Notification Layout PAYROLL-HE-NOTIFICATION NOTIFICATION hxczzhxclayt0047.ldt

Table 1: Payroll Layouts

1.4.2 Projects
The projects layouts delivered with the product are listed in table 2.

Layout Name Layout Code Layout Type Filename


Projects Timecard Layout PROJECTS-TIMECARD TIMECARD hxczzhxclayt0019.ldt
Projects Review Layout PROJECTS-REVIEW REVIEW hxczzhxclayt0020.ldt
Projects Confirmation Layout PROJECTS-CONFIRMATION CONFIRMATION hxczzhxclayt0017.ldt
Projects Details Layout PROJECTS-DETAIL DETAIL hxczzhxclayt0065.ldt
Projects Export Timecard Layout PROJECTS-EXPORT-TIMECARD EXPORT hxczzhxclayt0018.ldt
Projects Notification Layout PROJECTS-NOTIFICATION NOTIFICATION hxczzhxclayt0052.ldt
Projects Fragmented Timecard View PROJECTS-FRAGMENT FRAGMENT hxczzhxclayt0058.ldt
Projects Change and Late Audit En- PROJECTS-AUDIT-LAYOUT AUDIT hxczzhxclayt0014.ldt
try Layout
Projects Change and Late Review PROJECTS-AUDIT-REVIEW REVIEW hxczzhxclayt0016.ldt
Layout
Projects Change and Late Confirma- PROJECTS-AUDIT-CONFIRMATION CONFIRMATION hxczzhxclayt0013.ldt
tion Layout
Projects Change and Late Audit No- PROJECTS-AUDIT-NOTIFICATION NOTIFICATION hxczzhxclayt0048.ldt
tification Layout

Table 2: Projects Layouts

10
1.4.3 Projects and Payroll
The projects-payroll layouts delivered with the product are listed in table 3.

Layout Name Layout Code Layout Type Filename


Projects and Payroll Timecard Layout PROJECTS-ALTERNATE-TIMECARD TIMECARD hxczzhxclayt0015.ldt
Projects and Payroll Review Layout PROJECTS-ALTERNATE-REVIEW REVIEW hxczzhxclayt0010.ldt
Projects and Payroll Confirmation Lay- PROJECTS-AL-CONFIRMATION CONFIRMATION hxczzhxclayt0007.ldt
out
Projects and Payroll Details Layout PROJECTS-ALTERNATE-DETAIL DETAIL hxczzhxclayt0012.ldt
Projects and Payroll Export Layout PROJPAYROLL-EXPORT-LAYOUT EXPORT hxczzhxclayt0021.ldt
Projects and Payroll Notification Layout PROJECTS-ALTERNATE-NOTIF NOTIFICATION hxczzhxclayt0053.ldt
Projects and Payroll Fragmented Time- PROJECTS-ALTERNATE-FRAGMENT FRAGMENT hxczzhxclayt0009.ldt
card View
Projects and Payroll Change and Late PROJECTS-ALT-AUDIT-LAYOUT AUDIT hxczzhxclayt0034.ldt
Audit Entry Layout
Projects and Payroll Change and Late PROJECTS-ALTERNATE-CLA-REVIEW REVIEW hxczzhxclayt0033.ldt
Review Layout
Projects and Payroll Change and Late PROJECTS-AL-CLA-CONFIRMATION CONFIRMATION hxczzhxclayt0006.ldt
Confirmation Layout
Projects and Payroll Change and Late PROJECTS-ALTERNATE-CLA-NOTIF NOTIFICATION hxczzhxclayt0049.ldt
Notification Layout
Entry Level Processing Projects Pay- ELP-PROJECTS-PAYROLL-TIMECARD TIMECARD hxczzhxclayt0025.ldt
roll Timecard Layout
Entry Level Processing Projects Pay- ELP-PROJECTS-PAYROLL-REVIEW REVIEW hxczzhxclayt0032.ldt
roll Review Layout
Entry Level Processing Projects Pay- ELP-PROJECTS-PAYROLL-CONF CONFIRMATION hxczzhxclayt0023.ldt
roll Confirmation Layout
Entry Level Processing Projects Pay- ELP-PROJECTS-PAYROLL-DETAIL DETAIL hxczzhxclayt0024.ldt
roll Details Layout
Entry Level Processing Projects Pay- ELP-PROJ-PAY-EXPORT-LAYOUT EXPORT hxczzhxclayt0035.ldt
roll Export Layout
Entry Level Processing Projects Pay- ELP-PROJECTS-PAYROLL-NOTIF NOTIFICATION hxczzhxclayt0050.ldt
roll Notification Layout
ELP Start-Stop Projects Payroll Time- ELP-OTLR-PROJECTS-PAY-TIMECARD TIMECARD hxczzhxclayt0060.ldt
card Layout
ELP Start-Stop Projects Payroll Re- ELP-OTLR-PROJECTS-PAY-REVIEW REVIEW hxczzhxclayt0063.ldt
view Layout
ELP Start-Stop Projects Payroll Con- ELP-OTLR-PROJECTS-PAY-CONF CONFIRMATION hxczzhxclayt0061.ldt
firmation Layout
ELP Start-Stop Projects Payroll De- ELP-OTLR-PROJECTS-PAY-DETAIL DETAIL hxczzhxclayt0059.ldt
tails Layout
ELP Start-Stop Projects Payroll Ex- ELP-OTLR-PROJ-PAY-EXP-LAYOUT EXPORT hxczzhxclayt0062.ldt
port Layout

Table 3: Projects and Payroll Layouts

11
1.4.4 Exception
The exception layouts delivered with the product are listed in table 4.

Layout Name Layout Code Layout Type Filename


Exception Layout Timecard Entry Page EXCEPTION-TIMECARD TIMECARD hxczzhxclayt0030.ldt
Exception Layout Timecard Review Page EXCEPTION-REVIEW REVIEW hxczzhxclayt0029.ldt
Exception Layout Timecard Confirma- EXCEPTION-CONFIRMATION CONFIRMATION hxczzhxclayt0026.ldt
tion Page
Exception Export Timecard Layout EXCEPTION-EXPORT-LAYOUT EXPORT hxczzhxclayt0027.ldt
Exception Layout Timecard Notifica- EXCEPTION-NOTIFICATION NOTIFICATION hxczzhxclayt0046.ldt
tion Page
Exception Fragmented Timecard View EXCEPTION-FRAGMENT FRAGMENT hxczzhxclayt0064.ldt
Exception OTLR Details Review Lay- EXCEPTION-HE-REVIEW REVIEW hxczzhxclayt0028.ldt
out
Exception OTLR Details Notification EXCEPTION-HE-NOTIFICATION NOTIFICATION hxczzhxclayt0045.ldt
Layout

Table 4: Exception Layouts

12
1.4.5 Enterprise Asset Management
The enterprise asset management layouts delivered with the product are listed in table 5.

Layout Name Layout Code Layout Type Filename


EAM Confirmation Layout EAM-CONFIRMATION CONFIRMATION eamhxclayt.ldt
EAM Review Layout EAM-REVIEW REVIEW eamhxclayre.ldt
EAM Timecard Layout EAM-TIMECARD TIMECARD eamhxclayco.ldt

Table 5: Enterprise Asset Management Layouts

1.4.6 Purchasing
The purchasing layouts delivered with the product are listed in table 6.

Layout Name Layout Code Layout Type Filename


Purchasing Timecard Layout PURCHASING-TIMECARD TIMECARD pozzhxclayt0054.ldt
Purchasing Review Timecard Layout PURCHASING-REVIEW-TIMECARD REVIEW pozzhxclayt0055.ldt
Purchasing Confirmation Timecard Layout PURCHASING-CONF-TIMECARD CONFIRMATION pozzhxclayt0056.ldt
Purchasing Notification Timecard Layout PURCHASING-NOTIF-TIMECARD NOTIFICATION pozzhxclayt0057.ldt

Table 6: Purchasing Layouts

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.

Layout Name Layout Code Layout Type Filename


Timecard Layout PROJECTS-PURCHASING-TIMECARD TIMECARD pazzhxclayt0039.ldt
Review Timecard Layout PROJECTS-PURCHASING-REVIEW REVIEW pazzhxclayt0040.ldt
Confirmation Timecard Layout PROJECTS-PURCHASING-CONFIRM CONFIRMATION pazzhxclayt0041.ldt
Audit Entry Layout PA-PO-AUDIT AUDIT pazzhxclayt0042.ldt
CLA Review Layout PROJECTS-PURCHASING-CLA-REVIEW REVIEW pazzhxclayt0043.ldt
CLA Confirmation PA-PO-CLA-CONFIRM CONFIRMATION pazzhxclayt0044.ldt

Table 7: Projects-Purchasing Layouts

13
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.

14
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.3).
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.

2.1 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.

2.2 Using an Existing Layout as a Basis for Customization


When creating a custom layout the easiest approach is to select one the delivered layouts, based on which is closest to your require-
ments, and then use it as a starting point for your custom layout. To avoid overwriting the delivered OTL layouts you must give
your new timecard layouts new names. Even if you do not plan to use the delivered layouts this change should still be made to avoid
your custom layout being overwritten when OTL patches are applied to your environment. In order to rename the layout, you need
to change the layout name and description in the loader file. You do this in the section at the top of the data file.
For example:
BEGIN HXC LAYOUTS "EXCEPTION-TIMECARD" "HXC"
OWNER = "CUSTOM"
DISPLAY LAYOUT NAME = "Exception Layout - Timecard Entry Page"
LAYOUT TYPE = "TIMECARD"

Could be changed to:


BEGIN HXC LAYOUTS "MODIFIED-EXCEPTION-TIMECARD" "HXC"
OWNER = "CUSTOM"
DISPLAY LAYOUT NAME = "Modified Layout - Timecard Entry Page"
LAYOUT TYPE = "TIMECARD"

15
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.

2.3 Uploading Timecard Layouts


To upload the new layouts (for each of the layouts in the set you are using, or have customized) to the database execute the following
command from the command line:
FNDLOAD username/password@dbname 0 Y UPLOAD $HXC TOP/patch/115/import/ hxclaytlayoutsld.lct ./layout.ldt
This command assumes the path environment variables are set correctly, so that the FNDLOAD executable lies on the path, and
the configured layout is in the current directory and in a file called layout.ldt.
Once the modified layout is successfully uploaded, it will be available in the OTL application Preferences form and you can give
it to a user, or groups of users as required.

2.4 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.4.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:

• Attribute Long Label (the text for the prompt)

• CSS Label Class Name (the CSS style name to be used for the prompt - this is optional and will be defaulted if not specified)

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.4.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.

2.5 Further Configuration Concepts


If configuring more than just the simpliest aspects of the timecard, it may be necessary to utilize the ADF. Thus, some aspects of the
ADF are described in the following sections, within the context of configuring the OTL timecard interface. Specially, the business
objects (BC4J or JBO) layer — these are java objects that contain or are business data — affect timecard interface configuration as
the data used by the user interface components is dependent on those objects. View objects and Application Modules are two of the
business objects that require configuration. An excellent discussion on these objects, and the Applications Development Framework
(ADF) in general are found in the ADF Development Guidelines document available from the Oracle Technology Network.

16
2.5.1 View Objects
A View Object is a standard BC4J object and the primary method used to query data into OTL Self-Service applications. If you
require a custom set of data to be shown on a timecard using a Choice List or LOV, then you may need to create a custom View
Object to perform this query. Some customizations may be done using the Custom Choice List Components that OTL delivers. View
Objects delivered by OTL should not be modified since these changes will be overwritten whenever a patch applied with changes to
the View Object is applied. View Objects can be developed using the wizard supplied with JDeveloper. Once created, the BC4J
objects should then be added to the classpath for the Apache/JServ server so they will be available for use within the OTL timecard
screen. Note: any custom View Objects should be contained in a custom Application Module (see below for additional information).

2.5.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:

QUALIFIER ATTRIBUTEx = ViewObjectName#ApplicationModuleName#ApplicationModuleClass

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:

QUALIFIER ATTRIBUTEx = MyViewObject#MyAM#my.custom.code.MyAM

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.

2.5.3 Apache/JServ server


When customizations have been performed on the timecard the Apache/Jserv process may need to be ’bounced’ before the changes
will take effect due to caching of data. In general the following changes will not need the middle tier to be restarted:

• Changes to the timecard layout

• Changes to prompts or messages used on the layout

The following changes require the middle tier to be restarted:

• Changes to BC4J objects (i.e. View Objects, Application Modules, etc.)

• Creation of or changes to LOV JRAD definitions (using the migration script that creates LOV definitions in JRAD from the
AK data are including here also)

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.

2.6 Delivered Configurable BC4J Objects


2.6.1 Configurable Choice List Components
To allow easy implementation of choice list components, OTL delivers a number of ’Configurable Choice Lists’. What this basically
means is that we deliver a View Object based on a configurable view, so rather than a customer having to use JDeveloper to create
their own BC4J view objects and application module, they can just alter the definition of the underlying configurable view and then
add it onto their configured layouts.
OTL currently delivers ten of these configurable view objects:
The configurable view consists of two columns:

DISPLAY VALUE VARCHAR2(30)


VALUE VARCHAR2(15)

17
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

Table 8: Delivered Custom Choice List View Objects

These names must be used in order that the configurable user interface can display the appopriate data in the choice list component
on the timecard interface, but components will default the attributes that specify these to the same names, so they do not need to
be specified in the layout. The Value column is the value that will actually be submitted with the timecard - the contents of the
DisplayValue column does not need to be meaningful at all as far as the submit process is concerned (although for the benefit of anyone
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:

SELECT full name, person id FROM per people f

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.

CREATE OR REPLACE FORCE VIEW HXC CUI CUSTOM1 V(display value,value)


AS SELECT full name DISPLAY VALUE,to char(person id) VALUE
FROM per people f ORDER BY full name

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.

2.6.2 Package Choice List


A package choice list is visually exactly the same as a normal choice list component on the page. The difference between the two is
the data source — in the case of a normal choice list, the data is queried from a table or view via the associated View Object. For
a package choice list the equivalent View Object is built from the result of a PL/SQL function call. The PL/SQL call should return
the data to be shown in the choice in display value/value pairs (each separated by ’—’). The call be made with any of the supported
tokens — see section 4 — for the timecard - all parameters should be of type varchar2.
A Package Choice List component is defined like any other component. It uses a context called PACKAGE CHOICE LIST of
the configurable user interface component 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

18
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:
QUALIFIER ATTRIBUTE1 = my custom code.test
QUALIFIER ATTRIBUTE2 = @RESOURCE IDENTIFIER ID|@TIMECARD BIND START DATE|TEST
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
--
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.

19
2.6.3 Custom Alternate Name components
OTL Alternate Functionality is a commonly configured option on the timecard interface, because it drastically simplifies data entry
for users. For example, the expenditure type seeded alias allows users to pick one value, which is converted by the system into an
expenditure type, hours (element) type and a system linkage function. Thus, the user is selecting one value, rather than three. For
a discussion of OTL alternate name functionality consult the OTL Application documentation.
To allow for simple configuration of alternate name components, OTL delivers five customizable alternate name objects. For the
Self-Service functionality of OTL only the ’OTL Alternate Name DFF Context’ type of alternate names are supported. This type of
alternate name is based on the context definition attached to the ’OTL Alternate Names’ descriptive FlexField. In the context you
configure the definition of the alternate name and the value that you wish to deposit to OTL.
For example, the ELEMENTS EXPENDITURE SLF context has the following segments:

• 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"
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"My Timecard Layout - ExpType PriceType"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"

20
QUALIFIER ATTRIBUTE1 = "AlternateNameItem1VO"
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
Let’s go over the relevant qualifier settings to explain how it works.
QUALIFIER ATTRIBUTE1: This specifies the custom alternate name view object to use for this component. OTL supports 5
of these custom definitions and the VO names for each of these are:
AlternateNameItem1VO
AlternateNameItem2VO
AlternateNameItem3VO
AlternateNameItem4VO
AlternateNameItem5VO

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.

2.7 LOVs and JRAD/MDS


The Oracle Applications Self-Service framework now uses the MDS dictionary (aka JRAD) to store all definitions for Self Service pages
including LOVs. OTL supports custom LOVs, but at the current time there is no applications interface to create LOV objects in the
MDS data dictionary (other than using a tool such as JDeveloper to create the regions by hand). Consult the ADF documentation
for a full description of the UI dictoinaries used in the development framework.
In order to allow continue configuration of LOVs using the AK professional forms OTL has provided a migration utility which
will allow you to migrate definitions from AK to MDS.

21
This utility is available as a procedure in the package HXC LOV MIGRATION. The definition is:

PROCEDURE migrate lov region


(p region code IN AK REGIONS VL.REGION CODE%TYPE DEFAULT NULL
,p region app short name IN FND APPLICATION.APPLICATION SHORT NAME%TYPE DEFAULT NULL
,p force IN VARCHAR2 DEFAULT NULL
);

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.

exec hxc lov migration.migrate lov region


(p region code => ’MY CUSTOM LOV’
,p region app short name => ’HXC’
,p force => ’Y’
);

22
3 Examples of Common Customizations
3.1 Adding a Custom Choice List to the Timecard
Using the Configurable timecard, you can add your own custom choice lists-where the list of values is defined outside Oracle Time
and Labor. We support up to ten custom lists. We access these values using a set of named views, which must have two columns
present, and a choice list component attached to the layout on which the custom choice list is required. The choice list com-
ponent can also be used to show custom display-only fields that are populated by a query. This can be done by making the
component read-only (ie. QUALIFIER ATTRIBUTE30 = ’Y’) and enabling the ’Always Execute for Read-Only’ functionality
(ie. QUALIFIER ATTRIBUTE3 = ’Y’) so that the query for the component will always be executed, even if no value is stored.
If multiple rows are returned by the query then only the first will be shown. The views are named: HXC CUI CUSTOMn V
where n is a number between 1 and 10. For example, HXC CUI CUSTOM1 V. These views must have at least two columns and
they must be called: ’DISPLAY VALUE’ and ’VALUE’. The column ’DISPLAY VALUE’ contains the values that are shown in
the choice list for the user to select, and consequently should be user-friendly for your user population. The ’VALUE’ column
contains the values that are actually written to the database, and are thus understood by custom code. Once the view is con-
structed, you should include a choice list component in the layout of your choice. Set the view object name qualifier to CustomnVO,
such as Custom1VO. Set the view object class qualifier to oracle.apps.hxc.selfservice.timecard.server.CustomnVO, such as
oracle.apps.hxc.selfservice.timecard.server.Custom1VO. The custom view objects can only be used for situations where you
do not need bind parameters to be present in the query - for other cases you will need to create your own View Object to use for the
component.
As an example, let’s assume you want to record which machines a person worked with when submitting their time. The names
and IDs of these machines are stored in a table called OUR MACHINES. You could create the following OTL custom view:

Create or replace view HXC CUI CUSTOM6 V


(DISPLAY VALUE
,VALUE)
as
select machine name
,machine id
from our machines o

Then you add the following component definition to a layout:

############################################################################
# Machine Name choice list on the timecard matrix
############################################################################
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"

23
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.2 Adding a Custom LOV to the Timecard


Creating a list of values (LOV) involves the following steps:

1. Create the View Object for the LOV

2. Create AK attributes used for the LOV screen

3. Create an AK region for rendering the LOV screen

4. Create AK region items inside the AK region for the LOV page

5. Run the migration script to copy the LOV definition from AK to the MDS repository

6. Modify a layout to include the LOV component

7. Include the new LOV View Object into your Apache/JServ environment

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.

3.2.1 Create the View Object for the LOV


The query used for the view object should select all the columns that you would like to see shown in the LOV page. In addition the
query should select any other columns that you wish to restrict the query by or save as an attribute on the timecard. Initial step is
to define the query according to your requirements, so for our example:

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

24
3.2.2 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. Complete the following fields: Attribute ID, Attribute Name, Application,
Data Type, Value Length, Style and Label. Leave the other fields blank or at their default value.
So for our example, you would need to create attributes for the following fields:
person id
full name
last name
date of birth
employee number
business group id
business group name
Specifically:

Attribute ID: CUSTOM PERSON ID


Attribute Name: My Custom LOV - Person ID
Application: Oracle Time and Labor
Data type: Number
Value Length: 15
Style: Text
Label: Person ID

Attribute ID: CUSTOM FULL NAME


Attribute Name: My Custom LOV - Full Name
Application: Oracle Time and Labor
Data type: Varchar2
Value Length: 240
Style: Text
Label: Full Name

Attribute ID: CUSTOM LAST NAME


Attribute Name: My Custom LOV - Last Name
Application: Oracle Time and Labor
Data type: Varchar2
Value Length: 40
Style: Text
Label: Last Name

Attribute ID: CUSTOM DATE OF BIRTH


Attribute Name: My Custom LOV - Date of Birth
Application: Oracle Time and Labor
Data type: Date
Value Length: 1
Style: Text
Label: Date of Birth

Attribute ID: CUSTOM EMPLOYEE NUMBER


Attribute Name: My Custom LOV - Employee Number
Application: Oracle Time and Labor
Data type: Varchar2
Value Length: 30
Style: Text
Label: Employee Number

Attribute ID: CUSTOM BUSINESS GROUP ID


Attribute Name: My Custom LOV - Business Group ID
Application: Oracle Time and Labor

25
Data type: Number
Value Length: 15
Style: Text
Label: Business Group ID

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

3.2.3 Create an AK region for rendering the LOV screen


Region ID: MY CUSTOM LOV
Region Name: My custom LOV
Application Name: Oracle Time and Labor
Object Name: ICX PROMPTS
Region Style: List of Values
Application Module Definition Name: oracle.apps.hxc.selfservice.timecard.server.TimecardAM
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.

3.2.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.

Attribute Type: Attribute


Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Person ID
Sequence: 10
Node Display: Checked
Queryable: Checked
Item Name: CustomPersonId
View Usage Name: CustomPersonVO
View Attribute Name: PersonId

Attribute Type: Attribute


Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Full Name
Sequence: 20
Node Display: Checked
Queryable: Checked
Item Name: CustomFullName
View Usage Name: CustomPersonVO
View Attribute Name: FullName

Attribute Type: Attribute

26
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

Attribute Type: Attribute


Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Date of Birth
Sequence: 40
Node Display: Checked
Queryable: Checked
Item Name: CustomDateOfBirth
View Usage Name: CustomPersonVO
View Attribute Name: DateOfBirth

Attribute Type: Attribute


Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Employee Number
Sequence: 50
Node Display: Checked
Queryable: Checked
Item Name: CustomEmployeeNumber
View Usage Name: CustomPersonVO
View Attribute Name: EmployeeNumber

Attribute Type: Attribute


Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Business Group ID
Sequence: 60
Node Display: Checked
Queryable: Checked
Item Name: CustomBusinessGroupId
View Usage Name: CustomPersonVO
View Attribute Name: BusinessGroupId

Attribute Type: Attribute


Application: Oracle Time and Labor
Attribute Name: My Custom LOV - Business Group Name
Sequence: 70
Node Display: Checked
Queryable: Checked
Item Name: CustomBusinessGroupName
View Usage Name: CustomPersonVO
View Attribute Name: BusinessGroupName

3.2.5 Run the migration script to copy the LOV definition from AK to the MDS repository
3.2.6 Modify a layout to include the LOV component
For our example, the component definition is:-

########################################################################
# My Custom Person LOV #
#######################################################################

27
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’

3.2.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

28
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.

3.3 Changing the title of the timecard page


The default title for the timecard entry page is:
Time Entry: @RI NAME, @RA NUMBER
Where RI NAME is the token for the name of the employee entering time and RA NUMBER is their employee number.
To change the title modify the text associated with prompt HXC TIMECARD HEADER TITLE, within the AK HXC CUI TIMECARD
region. Alternatively, you can create a new prompt and then alter the layout definition to use that prompt instead of the delivered
one.
So, for example, lets change the title to say Timecard for Employee, where Employee is the name of the employee.
In professional forms, go to the AK regions form. Query on the region HXC CUI TIMECARD, highlight the correct row (if you have
more than one result from doing a partial match), and then press the ’Region Items’ button at the bottom of the form. In the region
items form, query on the Attribute ’Timecard Header Title’ (you can look up the attribute names based on the attribute code by
searching in the ’Seeded Prompts’ section of this document) and then change the ’Attribute Long Label’ text for the item to:
Timecard for @RI NAME

3.4 Changing the label for a column in the Timecard


Changing any label in OTL can be done by editing the text for the label in the professional AK form. To identify the attribute name
which you need to change there are two methods. Firstly, you can search for the text of the prompt in the reference section of this
document to find the name of the attribute. The second method, if the correct label cannot be found, or there are multiple choices
as to which it may be is the inspect the layout file.
Prompts can be attached to components in two ways - to best illustrate these two methods lets take a look at a couple of examples
using the inter-period navigation control on the Projects timecard layout.
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - Inter Period Nav Control"
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 = "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"

BEGIN HXC LAYOUT COMP PROMPTS "PERIOD GO LABEL" "AK PROMPT"


OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PERIOD GO LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Inter Period Nav Control"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "INTER PERIOD NAV CONTROL"
QUALIFIER ATTRIBUTE1 = "N"

29
QUALIFIER ATTRIBUTE16 = "1"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|TEMPLATE|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS
First of all, prompts can be directly attached to the component - this method is used when for example the prompt is associated
directly with the component (eg. The label for a text field). This is the case for the inter-period navigation control - the prompt is
set using attributes directly on the component itself:
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PERIOD LABEL"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
Here you can see the prompt for the component is referring to the attribute HXC TIMECARD PERIOD LABEL in the region
HXC CUI TIMECARD. The second way of attaching a prompt onto a component is used when the prompt is not directly associated
with the component in question, or when more than one label needs to be attached. In the case of the inter-period navigation control
we need a secondary label to use as the text for the ’Go’ button. This label is defined as a different entity attached to the component:
BEGIN HXC LAYOUT COMP PROMPTS "PERIOD GO LABEL" "AK PROMPT"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PERIOD GO LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS
The label is referring to the attribute HXC TIMECARD PERIOD GO LABEL in the region HXC CUI TIMECARD. You will
note the key for the prompt entity is ’PERIOD GO LABEL’ - this value should not be changed. It is used internally by the component
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.

3.5 Adding a Component to the Timecard Header


Adding a component to the header section of the timecard is simply a case of creating your component, and adding it to the layout
as a child of the header table. To illustrate this example, let’s use the header section for the Projects timecard:
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - Header Table Layout Component"
OWNER = "ORACLE"
SEQUENCE = "70"
COMPONENT DEFINITION = "TABLE LAYOUT"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Top Level Building Block"
LAST UPDATE DATE = "2004/05/24"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Header Table Layout Component"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TABLE LAYOUT"
QUALIFIER ATTRIBUTE1 = "2"
QUALIFIER ATTRIBUTE3 = "2"
QUALIFIER ATTRIBUTE16 = "1"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"

30
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "Y"
QUALIFIER ATTRIBUTE21 = "Y"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Header Field Table Layout Component"
OWNER = "ORACLE"
SEQUENCE = "80"
COMPONENT DEFINITION = "TABLE LAYOUT"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Table Layout Component"
ATTRIBUTE1 = "TOP"
LAST UPDATE DATE = "2004/05/24"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Header Field Table Layout Component"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TABLE LAYOUT"
QUALIFIER ATTRIBUTE1 = "2"
QUALIFIER ATTRIBUTE3 = "2"
QUALIFIER ATTRIBUTE16 = "1"
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Inter Period Nav Control Label"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "DISPLAY LABEL"
QUALIFIER ATTRIBUTE17 = "OraPromptText"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|TEMPLATE|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

31
BEGIN HXC LAYOUT COMPONENTS
"Projects Timecard Layout - Inter Period Nav Control"
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 = "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"

BEGIN HXC LAYOUT COMP PROMPTS "PERIOD GO LABEL" "AK PROMPT"


OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD PERIOD GO LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Inter Period Nav Control"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "INTER PERIOD NAV CONTROL"
QUALIFIER ATTRIBUTE1 = "N"
QUALIFIER ATTRIBUTE16 = "1"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|TEMPLATE|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Override Approver Label"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI TIMECARD APPR OVERRIDE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "110"
COMPONENT DEFINITION = "DISPLAY LABEL"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/24"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Override Approver Label"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "DISPLAY LABEL"
QUALIFIER ATTRIBUTE17 = "OraPromptText"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"

32
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE25 = "CUI"
QUALIFIER ATTRIBUTE26 = "COMPONENT PROPERTY"
QUALIFIER ATTRIBUTE27 = "TIMECARD SHOW OVERRIDE APPROVER"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Override Approver"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Override Approver"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "ApproverOverrideLOVVO"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "HXC CUI OVERRIDE APPROVER LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "30"
QUALIFIER ATTRIBUTE6 =
"HxcCuiOvraprApproverName|OVERRIDE APPROVER-DISPLAY|CRITERIA|N|HxcCuiOvraprPersonId|
OVERRIDE APPROVER|RESULT|N|HxcCuiOvraprApproverName|OVERRIDE APPROVER-DISPLAY|RESULT|N"
QUALIFIER ATTRIBUTE8 = "ApproverName"
QUALIFIER ATTRIBUTE9 = "PersonId#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.ApproverOverrideLOVVO"
QUALIFIER ATTRIBUTE17 = "NONE"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "APPROVAL"
QUALIFIER ATTRIBUTE27 = "Attribute10"
QUALIFIER ATTRIBUTE28 = "OVERRIDE APPROVER"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Comments Field"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI TIMECARD COMMENTS"

33
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "130"
COMPONENT DEFINITION = "TEXT FIELD"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Table Layout Component"
ATTRIBUTE1 = "TOP"
LAST UPDATE DATE = "2004/05/24"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Comments Field"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TEXT FIELD"
QUALIFIER ATTRIBUTE1 = "Y"
QUALIFIER ATTRIBUTE2 = "Y"
QUALIFIER ATTRIBUTE3 = "30"
QUALIFIER ATTRIBUTE4 = "3"
QUALIFIER ATTRIBUTE5 = "2000"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "N"
QUALIFIER ATTRIBUTE25 = "TIME BUILDING BLOCK ATTRIBUTE"
QUALIFIER ATTRIBUTE27 = "CommentText"
QUALIFIER ATTRIBUTE28 = "Comments"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS

END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Template Label"
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 = "140"
COMPONENT DEFINITION = "DISPLAY LABEL"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Header Field Table Layout Component"
LAST UPDATE DATE = "2004/05/24"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Template Label"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "DISPLAY LABEL"
QUALIFIER ATTRIBUTE17 = "OraPromptText"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|TEMPLATE|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE25 = "CUI"
QUALIFIER ATTRIBUTE26 = "COMPONENT PROPERTY"
QUALIFIER ATTRIBUTE27 = "TIMECARD TEMPLATE FUNCTIONALITY"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

34
BEGIN HXC LAYOUT COMPONENTS
"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

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Template Control"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TEMPLATE CONTROL"
QUALIFIER ATTRIBUTE1 = "N"
QUALIFIER ATTRIBUTE16 = "2"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|TEMPLATE|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

This header section renders a two-column layout - with the inter-period navigation control, template control, and override approver
control on the left, and the comments field on the right. Furthermore, the left side of this layout has a nested table to align the fields
to the left of each other, rather than having them placed directly after their field label. So for our example, let’s add our component to
the left side of this two-column layout, and place it between the inter-period navigation control and the override approver component.
To maintain the same appearance as exists already in the header field, this means we need to split the component into the label,
and the rest of the component. Ok, so now on to defining our component. For our example, let’s say we want to show a read-only
field in the header that will display the users ’payroll code’ which is retrieved from a PL/SQL function call. Our example payroll
code function takes the parameter of the resource id and returns the code to be displayed. The function resides in the package
MY CUSTOM PACKAGE and has the following specification:

FUNCTION get payroll code


(p resource id NUMBER
)

35
RETURN VARCHAR2;

Since we need to show a value based on a PL/SQL call, we can use the Package Choice List component. Normally this would be
used to show an modifiable choice list on the page, but by setting it to be read-only it will only render a single value which is what
we need. We also need to set qualifier attribute6 for the component since there will be no ’id’ value stored for the field since it is just
returned based on the employee id of the person entering time - the function used by the package choice list does need to return an
id value, but it does not matter what the value is - we can just specify a dummy value.
So our current tasks for this implementation are:

• Create AK data for the component prompt


• Create wrapper PL/SQL function to call the payroll code function and return it in the format needed for the package choice
list

• Create the component to show the label for our custom field and add it to the layout

• Create the component to show the read-only function result and add it to the layout

3.5.1 Create AK data for the component prompt


Lets assume the following details are used for the prompt:

Region: MY CUSTOM TIMECARD


Application: HXC (Oracle Time and Labor)
Attribute Code: CUSTOM TIMECARD PROMPT
Attribute Long Label: Payroll Code

3.5.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));
--
-- now return the result in the correct format just using a dummy
-- id
--
RETURN ’1’ || l payroll code;
END get display payroll code;

36
3.5.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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Custom Field - Payroll code label"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "DISPLAY LABEL"
QUALIFIER ATTRIBUTE17 = "OraPromptText"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|TEMPLATE|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

You can see changes to the component name and qualifier name here, updates to the region and attribute code to point to the
new prompt we created earlier, and the sequence set to the number we decided on.

3.5.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"

BEGIN HXC LAYOUT COMP QUALIFIERS "Custom Field - Payroll Code"


OWNER = "ORACLE"
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

37
3.6 Adding a Component to the Timecard Matrix
The part of the layout that renders the timecard matrix for the Projects Timecard layout can be seen below:

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
OWNER = "ORACLE"
SEQUENCE = "180"
COMPONENT DEFINITION = "TIME BUILDING BLOCK"
RENDER TYPE = "WEB"
PARENT COMPONENT =
"Projects Timecard Layout - Top Level Building Block"
LAST UPDATE DATE = "2004/05/24"

BEGIN HXC LAYOUT COMP PROMPTS "TOTAL LABEL" "AK PROMPT"


OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI TOTAL LABEL"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS

BEGIN HXC LAYOUT COMP PROMPTS "CALCULATE LABEL" "AK PROMPT"


OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC CUI CALCULATE"
ATTRIBUTE APP SHORT NAME = "HXC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP PROMPTS

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

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

38
BEGIN HXC LAYOUT COMP QUALIFIERS
"Projects Timecard Layout - Day Scope Building blocks for worker timecard matrix"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TIME BUILDING BLOCK"
QUALIFIER ATTRIBUTE1 = "V"
QUALIFIER ATTRIBUTE2 = "D"
QUALIFIER ATTRIBUTE3 = "D"
QUALIFIER ATTRIBUTE4 = "5"
QUALIFIER ATTRIBUTE5 = "Y"
QUALIFIER ATTRIBUTE6 = "Y"
QUALIFIER ATTRIBUTE7 = "Y"
QUALIFIER ATTRIBUTE8 = "Y"
QUALIFIER ATTRIBUTE9 = "Y"
QUALIFIER ATTRIBUTE10 = "RIGHT"
QUALIFIER ATTRIBUTE16 = "1"
QUALIFIER ATTRIBUTE20 = "Y"
QUALIFIER ATTRIBUTE25 = "TIME BUILDING BLOCK"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS "Projects Timecard Layout - Measure"


OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD QUANTITY"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "190"
COMPONENT DEFINITION = "TEXT FIELD"
RENDER TYPE = "WEB"
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 - Measure"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "TEXT FIELD"
QUALIFIER ATTRIBUTE1 = "N"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "5"
QUALIFIER ATTRIBUTE4 = "1"
QUALIFIER ATTRIBUTE6 = "OraTableCellNumberBand"
QUALIFIER ATTRIBUTE7 = "OraTableCellNumber"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "N"
QUALIFIER ATTRIBUTE25 = "TIME BUILDING BLOCK ATTRIBUTE"
QUALIFIER ATTRIBUTE27 = "Measure"
QUALIFIER ATTRIBUTE28 = "Measure"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - System Linkage Function"
OWNER = "ORACLE"

39
COMPONENT VALUE = "SYSTEMLINKAGEFUNCTION"
SEQUENCE = "200"
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - System Linkage Function"
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 = "PROJECTS"
QUALIFIER ATTRIBUTE27 = "Attribute5"
QUALIFIER ATTRIBUTE28 = "SYSLINKFUNC"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS "Projects 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 = "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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects 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"
QUALIFIER ATTRIBUTE8 = "ProjectNumber"
QUALIFIER ATTRIBUTE9 = "ProjectId#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.ProjectLOVVO"
QUALIFIER ATTRIBUTE17 = "OraTableCellText"

40
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/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS "Projects 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 = "220"
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"

BEGIN HXC LAYOUT COMP PROMPTS "HxcCuiTaskProjectId" "AK PROMPT"


OWNER = "ORACLE"
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/24"
END HXC LAYOUT COMP PROMPTS

BEGIN HXC LAYOUT COMP QUALIFIERS "Projects 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"
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"

41
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "PROJECTS"
QUALIFIER ATTRIBUTE27 = "Attribute2"
QUALIFIER ATTRIBUTE28 = "TASK"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects 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 = "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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Expenditure Type"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "ExpenditureType2LOVVO"
QUALIFIER ATTRIBUTE2 = "N"
QUALIFIER ATTRIBUTE3 = "HXC CUI EXPTYPE2 LOV"
QUALIFIER ATTRIBUTE4 = "809"
QUALIFIER ATTRIBUTE5 = "12"
QUALIFIER ATTRIBUTE6 =
"HxcCuiExptypeDispColumn|EXPTYPE-DISPLAY|CRITERIA|N|HxcCuiExptypeExpType|EXPTYPE|RESULT|
N|HxcCuiExptypeDispColumn|EXPTYPE-DISPLAY|RESULT|N|HxcCuiExptypeSysLinkFunc|
SYSLINKFUNC|RESULT|N"
QUALIFIER ATTRIBUTE7 = "SYSLINKFUNC|SystemLinkageFunction"
QUALIFIER ATTRIBUTE8 = "DisplayColumn"
QUALIFIER ATTRIBUTE9 = "ExpenditureType"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.ExpenditureType2LOVVO"
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/24"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS

42
"Projects Timecard Layout - Delete button"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD DELETE"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "240"
COMPONENT DEFINITION = "SUBMIT ICON"
RENDER TYPE = "WEB"
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

END HXC LAYOUT COMPONENTS

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Details button"
OWNER = "ORACLE"
REGION CODE = "HXC CUI TIMECARD"
REGION CODE APP SHORT NAME = "HXC"
ATTRIBUTE CODE = "HXC TIMECARD DETAILS"
ATTRIBUTE CODE APP SHORT NAME = "HXC"
SEQUENCE = "250"
COMPONENT DEFINITION = "SUBMIT ICON"
RENDER TYPE = "WEB"
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 - Details button"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "SUBMIT ICON"
QUALIFIER ATTRIBUTE1 = "details"
QUALIFIER ATTRIBUTE2 = "detailsicon enabled.gif"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE5 = "ENABLED"
QUALIFIER ATTRIBUTE18 = "EXCLUDE"
QUALIFIER ATTRIBUTE19 = "|CSV|"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "R"

43
QUALIFIER ATTRIBUTE28 = "Details"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"My Timecard Layout - ExpType PriceType"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "AlternateNameItem1VO"
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 =
EXPENDITURE 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

In order to add this component to the layout we need to firstly consider where we want to place it, for this example lets put it to
the right of the expenditure type field, using a sequence of 235. Next we need to identify the parts of the new component definition
we need to change in order to add it to our layout:

44
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - Custom Field - ExpType PriceType"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "LOV"
QUALIFIER ATTRIBUTE1 = "AlternateNameItem1VO"
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"

45
QUALIFIER ATTRIBUTE8 = "DisplayValue"
QUALIFIER ATTRIBUTE9 = "Value#NUMBER"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.AlternateNameItem1VO"
QUALIFIER ATTRIBUTE11 =
EXPENDITURE 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

3.7 Adding an OTL Information Type to the Timecard


The OTL Timecard allows for the addition of data fields that are not specific to an Oracle Application, but are necessary for an
individual company. The new data fields are available to the self-service timecard after first being defined in the Descriptive Flex
Field ’OTL Information Types’
To define the ’OTL Information Type’ Descriptive Flex Field: Navigation to define a new OTL Information Type Descriptive
Flex Field Context / Segment:
• System Administrator
– Application
∗ Flexfield
∗ Descriptive
∗ Segments
• Then: query on Title ’OTL Information Types’
– Unfreeze the Flexfield Definition
– Add a new, blank line (Context Code)
∗ Add a Name
∗ Add Segments
∗ Description
∗ Value Set (optional)
∗ Define Prompts ¿ List of Values
∗ Define Prompts ¿ Window
∗ Save the new Segments / Context
∗ Re-Freeze the DFF
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.6 and 2.7.
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.

QUALIFIER ATTRIBUTE22 = "L"


QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "New Information Type Context"
QUALIFIER ATTRIBUTE27 = "ATTRIBUTE##"
END HXC LAYOUT COMP QUALIFIERS
END HXC LAYOUT COMPONENTS

46
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

3.8 Adding additional element input values


Extra Element Input values may be added to a configured Timecard, with the extra input values validated and retrieved to BEE.
The delivered Payroll and Exception layouts include an Alternate Name Hours Type component that reference an HR / Payroll
Hours Type (Element). The user enterable input values defined on an element are associated to the Element in the OTL Information
Types Descriptive Flex Field when the OTL Generate Flex Mapping Process is executed for a specific Element Set. The segments
created are those defined in HR / Payroll as User enterable.
The Additional Input Value added to the configured layout must exist on all elements displayed to the user AND must be deposited
to the same OTL Information Type Segment for all elements. The OTL Information Types Element segments should be defined to
a specific Segment value, since the configured layout references a specific segment in QUALIFIER ATTRIBUTE27, with Dummy
Element Context defined in QUALIFIER ATTRIBUTE26.
The same segment may be defined for different elements input values if the Input Value’s sequence number is defined as 12, 13,
14, or 15. (E.g. Element Input Value with Sequence number 12, will then have Segment 12 for all ELEMENT - ##### defined in
the OTL Information Types Descriptive Flex Field).
NOTE - If the sequence value is anything other than the 12-15, then the Generate Flex Mapping Process may define the input
values to different segment values for different elements, producing unexpected results on a configured timecard.
Add Company defined Choice Lists or LOVs based on information previously defined in sections 2.6 and 2.7.
An example of adding an Input Value defined as OTL Information Types, Dummy Element Context, and Segment 12 for all
elements

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"

47
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

3.9 Configuring the Cost Center component


The seeded Exception and Payroll timecard layouts include a Cost Center component. The component references a specific FND
value set (US#Cost Center) and saves the cost center entries to SEGMENT1 of the Cost Allocation Key Flex Field. Within the
delivered OTL timecard LDT file, the cost center is referenced in the section marked ## Cost Center ##, as follows:
############################################################################
# Cost center choice list on the timecard matrix
############################################################################
BEGIN HXC LAYOUT COMPONENTS "Exception Timecard Layout - Cost Center"
OWNER = "CUSTOM"
COMPONENT VALUE = "COSTCENTER"
SEQUENCE = "120"
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 COST CENTER"
ATTRIBUTE CODE APP SHORT NAME = "HXC"

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.)

48
CREATE OR REPLACE FORCE VIEW HXC CUI CUSTOM9 V
( display value ,value )
AS
select flex value display value, 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’

(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 required changes (in bold).
############################################################################
# Cost center choice list on the timecard matrix
############################################################################
BEGIN HXC LAYOUT COMPONENTS "Exception Timecard Layout - Cost Center"
OWNER = "CUSTOM"
COMPONENT VALUE = "COSTCENTER"
SEQUENCE = "120"
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 COST CENTER"
ATTRIBUTE CODE APP SHORT NAME = "HXC"

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” )

49
• 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 in the lines in RED (above)
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.
8. Associate the new AK Regions and Attributes to the following lines in the Cost Center section of the LDT file:
• REGION CODE = ”HXC CUI TIMECARD”
• REGION CODE APP SHORT NAME = ”HXC”
• ATTRIBUTE CODE = ”HXC TIMECARD COST CENTER”
• ATTRIBUTE CODE APP SHORT NAME = ”HXC”

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

Attribute ID VALUE (Used on Timecard LDT File as ATTRIBUTE CODE)


Attribute Name Meaningful Name (Used in Region )
Application Oracle Time and Labor (or shown as Capture)
ApplicationData Type VARCHAR2
Label Value to Show on Timecard

• Define Region

Region ID VALUE (Used on Timecard LDT File as REGION CODE)


Region Name Meaningful Name
Application Oracle Time and Labor (or shown as Capture)
Object Name ICX PROMPTS
Region Style Page Layout
Number of Columns 1

• After you have defined the Region, select ¡Region Items¿ button to add the attributes to the Region.

Attribute Type Attribute


Application Oracle Time and Labor
Attribute Name Attribute Name (created above)
Sequence #
Item Style Text

50
3.10 Adding OTLR Detail to the Review and Confirmation Pages
With the March 2002 release of Oracle Time and Labor, the timecard review and confirmation pages can show the user-entered
timecard data as if the OTL rules and policies had been applied. When the user clicks the Review button on the timecard, the
timecard calls OTLR and applies the proper rules and policies to the entered time. This OTLR API passes back a set of detail time
building blocks and attributes to the timecard. The timecard will not display these blocks and attributes on the screen unless specified
detail components are present in the layout. NOTE: In addition to setting up the layout correctly, you must do the following for
each employee who is to review their time detail in Self-Service:

• Set the Evaluate OTL Rules segment of the Self Service Preference to allow Rules Evaluation to Yes.

• Assign the employee to OTLR structures and policies

• Set Autogen to Yes on the Assignment Time Information window

3.10.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.11 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.

3.11.1 Setting the Attribute Category


The trick then, with this implementation is to make the data in the time store appear exactly as it would have if the user had
navigated to the details page and made the entries there.
The key point is to make the building block information type associated with these PA DFF timecard attributes be ’Dummy
Paexpitdff Context’ and have the appropriate attribute category, e.g. ’PAEXPITDFF - GLOBAL’ or ’PAEXPITDFF - ST’. This
ensures that the PA application understands what these attributes are, and that the generic retrieval code component of OTL can
find the data properly without modification.
This means in the layout definition, we must specify ’Dummy Paexpitdff Context’ and not the attribute category we want directly.
i.e. QUALIFIER ATTRIBUTE26 must be ’Dummy Paexpitdff Context’ for any DFF component we add to the matrix. This ensures
any attributes created by the OTL timecard have the correct building block information type id, and can thus be found by the generic
retrieval and will be sent to Projects correctly.
However, by default the attribute category given to a timecard attribute is the same as the building block information type id,
which is bad now because the value ’Dummy Paexpitdff Context’ is unlikely to be a valid context in the expenditure items flexfield
definition. Thus, we must set the attribute category attribute of the timecard attribute correctly. This can be done in one of two
ways:

51
1. via a result item from an LOV (Hidden Field)

2. as a value coming from an Alias definition e.g. for a choice list or LOV (Hidden field)

Note although we must include a component supporting the attribute category in the layout definition, the user does not need
to have any knowledge of the attribute category, however if the DFF fields only comprise free-text fields, then this is the only
implementation choice.
In all three cases, a component must exist in the layout definition supporting the attribute category ensuring proper function
of the timecard and retrieval. An example HIDDEN FIELD component, for use e.g. with a DFF structure that includes a choice
appears:

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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - DFF Attribute Category"
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 Paexpitdff Context"
QUALIFIER ATTRIBUTE27 = "AttributeCategory"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS

END HXC LAYOUT COMPONENTS

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.

3.11.2 Aliasing A Segment Value To Set The Attribute Category


If the DFF context definition includes a choice list component, and the timecard layout has no custom LOV included, then the least
obvious option for setting the attribute category is to use an OTL Alternate Name on one choice list segment. This ensures that
when the alternate name is resolved by the timecard deposit code, the attribute category and the appropriate segment value are set
properly.
To do this, execute the following steps:

A Navigate to the descriptive flexfield segments form under an application developer responsibility, and create e.g. ’PA DFF ALTERNA
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)

52
(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.
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:

BEGIN HXC LAYOUT COMPONENTS


"Projects Timecard Layout - Alternate Name DFF Activity"
OWNER = "ORACLE"
COMPONENT VALUE = "DFFALTNAMEACTIVITY"
SEQUENCE = "260"
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - DFF Attribute Category"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom1VO"
QUALIFIER ATTRIBUTE4 = "N"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom1VO"

53
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

END HXC LAYOUT COMPONENTS

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:

create or replace force view HXC CUI CUSTOM1 V


(display value,
value)
as
(select tl.alias value name,
b.alias value id
from hxc alias values tl tl,
hxc alias values b,
hxc alias definitions ad
where tl.language = userenv(’LANG’)
and tl.alias value id = b.alias value id
and b.alias definition id = ad.alias definition id
and ad.alias definition name = <Alternate Name Definition>
)
/

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.

3.11.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:

54
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"

BEGIN HXC LAYOUT COMP QUALIFIERS


"Projects Timecard Layout - DFF Attribute Category"
OWNER = "ORACLE"
QUALIFIER ATTRIBUTE CATEGORY = "CHOICE LIST"
QUALIFIER ATTRIBUTE1 = "Custom1VO"
QUALIFIER ATTRIBUTE4 = "Y"
QUALIFIER ATTRIBUTE10 =
"oracle.apps.hxc.selfservice.timecard.server.Custom1VO"
QUALIFIER ATTRIBUTE17 = "NONE"
QUALIFIER ATTRIBUTE20 = "N"
QUALIFIER ATTRIBUTE21 = "Y"
QUALIFIER ATTRIBUTE22 = "L"
QUALIFIER ATTRIBUTE25 = "FLEX"
QUALIFIER ATTRIBUTE26 = "Dummy Paexpitdff Context"
QUALIFIER ATTRIBUTE27 = "AttributeCategory"
LAST UPDATE DATE = "2004/05/24"
END HXC LAYOUT COMP QUALIFIERS

END HXC LAYOUT COMPONENTS

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.

3.11.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.

55
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.

Key to tables below


Many components and their qualifiers have very specific uses and are not intended to be changed or used other than by OTL
development.

Table Entry Meaning


D OTL Development Use Only - this field should be used, or the value
not changed from that delivered.
! Caution - this attribute has usually been implemented for a very
specific purpose and should not be changed since it may have un-
desirable side-affects.
M Applicable to the attributes on the timecard matrix only
* Applicable to specific components only
C Note - Value is case sensitive

Table 9: Component Tables Key

4.1.1 Global attributes


Context: GLOBAL DATA ELEMENTS
Description: Global attributes are present for all components, although that does not mean they actually have a use for all
components. An attribute is designated to be global if it applies to a significant number of components. Attributes marked as for
OTL Development Use Only should not be altered by customers unless you have been instructed to do so by OTL Development. The
global attributes are shown in table 10.
Notes:

1. Display modes can be used to remove or specifically include components in a particular layout context. This is primarily
targeted at the layouts that are re-used in different screens. Eg. The timecard entry layout is also used in the template create
page. By using the EXCLUDE setting, the component will not be shown if the current display mode exists in qualifier 19. The
INCLUDE setting means that the component will only be shown if the mode exists in qualifier 19.

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.

56
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 10: Global Attributes, applicable to every component. Required attribute(s) in bold.

57
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.

4.1.3 Choice List


Context:CHOICE LIST
Description: This component can be used to display a choice list (also known as a poplist) on your layout. The list is based on a
SQL query on a database object as defined in the attached View Object.
Notes: This component can be used in conjunction with the custom view object functionality provided with OTL, or with new View
Objects. Other notes for qualifers described in the table:

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 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.

4. This option is used to enable or disable prompt display - you may for example wish to disable prompt display if you want to
format your component along with others in a table and would prefer to render the labels separately from the components to
get the correct alignment.

5. 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’.

58
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 11: Choice List Components. Required Attribute(s) are displayed in bold.

59
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 *

No. Purpose Description Valid Values Notes


1 FlexField Name Name of the descriptive FlexField A valid Flex-
Field name.
2 FlexField App Short Application short name of the de- A valid short
Name scriptive FlexField (eg. HXC) application
code.
3 Default Context The default selected context for the Flex- A valid context (D)(!)
Field
4 Show Context List Flag to turn the context list for the Flex- Y,N (D)(!)
Field on or off
5 Region Name The region code for the page The correct (D)
region code
6 Region Application The application id of the region for A valid and (D)
ID the page correct appli-
cation id

Table 12: Descriptive flexfield component qualifing attributes. Required attribute(s) are displayed in bold.

60
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.

4.1.6 Display Label


Context:DISPLAY LABEL
Description:This component is used to show a label on the layout. The label text is retrieved from the prompt data attached to
the component.

4.1.7 Display Text


Context:DISPLAY TEXT
Description:This component is used to display a block of text on the page - it is intended for larger and usually multi-line sections
of text (unlike the Display Label component which is intended for short label text). The source of text for the label is a standard
Oracle Applications message.

No. Purpose Description Valid Values Notes


1 Message Name The alias of the message to display Valid message
(the alias links to a prompt object alias name
attached to the component which in
turn points to an FND message)

Table 13: Display text component qualifing attributes. Required attribute(s) are displayed in bold.

4.1.8 Hidden Field


Context:HIDDEN FIELD
Description:The hidden field component is used to create a HTML form field, which is basically a non-visible form item which is
submitted along with the page. The common use for this common in the OTL configurable UI is in conjunction with LOVs when the
requirement is for the LOV criteria to populate multiple IDs to be submitted when a value is selected.

4.1.9 Hours Type Table


Context:HOURSTYPE TABLE
Description: This component is used to display the Hours Type table on the confirmation pages of various layout sets.

4.1.10 Inter-Period Navigation Control


Context: INTER PERIOD NAV CONTROL
Description: This component is used to display the inter-period navigation choice list and ’go’ button on timecard entry layouts.
Notes: Oracle Development Use Only

No. Purpose Description Valid Values Notes


1 Show Prompt Flag to determine whether or not the com- Y,N (D)
ponent should render its own prompt

Table 14: Inter Period Navigational Control component qualifing attributes. Required attribute(s) are displayed in bold.

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

61
No. Purpose Description Valid Values Notes
1 Show Required Key Show required field message Y,N (D)

Table 15: Key notation component qualifing attributes. Required attribute(s) are displayed in bold.

4.1.12 List Of Values


Context: LOV
Description: This component is used to display a List-of-Values (LOV) component on a timecard layout. Various criteria can be
set up to dynamically configure both the value available (based on other fields) as well as the fields that will be populated when a
result is selected from the list. This component is best suited for scenarios when a field has many possible values (since the data does
not need to be included in the page, and the query fires only when the user does a search and Is often restricted further to improve
performance), or if there is a requirement for multiple fields to be populated, or the field to be restricted by other values the user has
entered on the page.
Notes:

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
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’.

62
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.

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 16: List of Values component qualifing attributes. Required attribute(s) are displayed in bold.

63
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

No. Purpose Description Valid Values Notes


1 Type Type of dialog to display ERROR,
WARNING,
INFORMA-
TION
2 Text Message Name The alias of the message to display Valid message
(the alias links to a prompt object alias name
attached to the component which in
turn points to an FND message)
3 Display at the Top of the Flag as to whether or not this dialog will Y,N
Page be shown in the page status region at the
top of the page

Table 17: Message Box component qualifing attributes. Required attribute(s) are displayed in bold.

4.1.14 Notification Day Detail


Context:NOTIFICATION DAY DETAIL
Description:This component is used to display the day detail in notification layouts.
Notes:Development Use Only

4.1.15 Package Choice List


Context:PACKAGE CHOICE LIST
Description:This component is used to display a choice list on a layout that is based on the result of a PL/SQL function call rather
than the traditional SQL query.
Notes:See Package Choice List in the Configuration Concepts section for more information. Other notes from the qualifier table are:

1. 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’.

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.

4.1.16 Page Status


Context: PAGE STATUS
Description:This shows a standard Oracle Applications framework page status component, which is used to render page controls
and messages.
Notes:Oracle Development Use Only

4.1.17 Spacer
Context:SPACER
Description:This component can be used to add extra white space between components on the page.
Notes:

64
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 18: Package Choice List component qualifing attributes. Required attribute(s) are displayed in bold.

No. Purpose Description Valid Values Notes


1 Text Instruction Text instruction to include in the page (D)
status component
2 Required Field Controls whether or not the re- Y,N (D)
quired field component is displayed

Table 19: Page Status component qualifing attributes. Required attribute(s) are displayed in bold.

4.1.18 Submit Button


Context:SUBMIT BUTTON
Description:This component creates a submit button on the page.
Notes: Oracle Internal Development Use Only.

4.1.19 Submit Icon


Context:SUBMIT ICON
Description:This component is the same as a submit button, but uses an icon as the displayed item rather than a rendered button.
Notes: Oracle Internal Development Use Only.

4.1.20 Summary Table


Context:SUMMARY TABLE
Description: Used to display the CLA summary table on a timecard layout.
Notes: Oracle Internal Development Use Only.

4.1.21 Table Layout


Context:TABLE LAYOUT
Description: This component creates a HTML table layout based on any child components attached to it. It is primarily used for
formatting of screens, achieving the desired layout and ensuring correct alignment of fields.
Notes:
1. The table will render based on the number of columns and the child components attached to the table. Using the sequence
order the component will display each child in a new table cell, moving to a new row once the column count has been reached.

4.1.22 Template Control


Context:TEMPLATE CONTROL
Description:This component is used to display the template control on the timecard entry page. The component consists of the
prompt, choice list containing the available templates, an overwrite checkbox (which can be turned off via preferences) and the submit
button.

65
No. Purpose Description Valid Values Notes
1 Spacer Type The orientation of the spacer VERTICAL,
HORIZON-
TAL
2 Spacer Size The size of the spacer (in pixels) Numeric

Table 20: Spacer component qualifing attributes. Required attribute(s) are displayed in bold.

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 21: Submit Button component qualifing attributes. Required attribute(s) are displayed in bold.

Notes: Oracle Internal Development Use Only

4.1.23 Text Field


Context: TEXT FIELD
Description: This component is used to display a text field component on the layout.
Notes:

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.1.24 Timecard Fragmentation Cluster


Context: TIMECARD FRAGMENTATION CLUSTER
Description: This component is used to display a fragmented view of the timecard on layouts.
Notes: Oracle Internal Development Only

4.1.25 Time Building Block


Context:TIME BUILDING BLOCK
Description: This component is used to control the rendering of the page based on timecard data. It is used to both control the
data linking of the all of attributes, and also to render the timecard matrix.
Notes: Oracle Internal Development Use Only

4.2 Tokens
Table 28 displays the list of currently understood tokens, e.g. for use as bind parameters etc.

4.3 Seeded Prompts


4.3.1 HXC CUI TIMECARD Region
4.3.2 HXC CUI TIMECARD REVIEW Region
4.3.3 HXC CUI TIMECARD CONFIRMATION Region

4.4 Seeded Messages


4.5 CUI Error Codes
Codes in italics are internal development debugging messages and will not usually be seen.

66
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)
2 Enabled Icon The icon to display when the button Valid icon im- (D)
is enabled age
3 Disabled Icon The icon to display when the button is Valid icon image (D)
disabled
4 Show When Dis- Flag to determine if the disabled Y,N (D)
abled? icon should be shown
5 Default Value The default state of the icon DISABLED, (D)
ENABLED

Table 22: Submit Icon component qualifing attributes. Required attribute(s) are displayed in bold.

No. Purpose Description Valid Values Notes


1 VO Name This is the name of the view object Valid view ob- (D)(C)
that is attached to the component ject name
(1)
2 Fully Qualified VO Full class reference of the view ob- A valid view (D)(C)
Name ject for the component object refer-
ence

Table 23: Summary Table component qualifing attributes. Required attribute(s) are displayed in bold.

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 24: Table Layout component qualifing attributes. Required attribute(s) are displayed in bold.

No. Purpose Description Valid Values Notes


1 Show Prompt Flag to determine whether or not the com- Y,N (D)
ponent should render its own prompt

Table 25: Template Control component qualifing attributes. Required attribute(s) are displayed in bold.

67
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 26: Text Field component qualifing attributes. Required attribute(s) are displayed in bold.

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 27: Time Building Block component qualifing attributes. Required attribute(s) are displayed in bold.

68
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.

Table 28: Currently recognized tokens

69
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

Table 29: Timecard region seeded prompts (Part 1.)

70
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

Table 30: Timecard region seeded prompts (Part 2.)

71
Code Name Long Label
HXC TCNOTIFICATION HEADER Timecard Notification Timecard Entries
Header Title
HXC TCREVIEW CHANGES HEADER TC Audit Page Header Change Reasons: @RI NAME,
@RA NUMBER
HXC TCREVIEW COMMENTS LABEL Timecard Review Com- Comments
ments Label
HXC TCREVIEW HEADER TITLE Timecard Review Review: @RI NAME,
Header Title @RA NUMBER
HXC TCREVIEW HOURS EXPLOSION Timecard Review Hours Time Detail
Explosion Matrix Header
HXC TCREVIEW PERIOD LABEL Timecard Review Period Timecard Period
Label
HXC TCREVIEW PERIOD TEXT Timecard Review Period @TIMECARD PERIOD LENGTH
Text day(s)
HXC TCREVIEW WEEKSTART LABEL Timecard Review Week Week Starting
Starting Label
HXC TC AUDIT HEADER Audit Summary Header Audit Summary
HXC TC CHANGE HEADER Audit Page Change Changed Entries
Header
HXC TC LATE HEADER Audit Page Late Header Late Entries
HXC TC REVIEW HOURS ENT HEADER Timecard Review Hours Hours Entered
Entered Header

Table 31: Timecard Review region seeded prompts

Code Name Long Label


HXC TC AUDIT HEADER Audit Summary Header Audit Summary
HXC TC CHANGE HEADER Audit Page Change Changed Entries
Header
HXC TC CONF APPROVER LABEL Timecard Confirmation Approver
Approver Label
HXC TC CONF HEADER Timecard Confirmation Confirmation:
Header @RI NAME,
@RA NUMBER
HXC TC CONF HOURS ENT HEADER Timecard Confirmation Hours Entered
Hours Entered Header
HXC TC CONF SUMMARY HEADER Timecard Confirmation Summary
Summary Header
HXC TC CONF VAC BAL LABEL Timecard Confirmation Vacation Balance
Vacation Balance Label
HXC TC LATE HEADER Audit Page Late Header

Table 32: Timecard Confirmation region seeded prompts

72
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¿

Table 33: Seeded Timecard Messages

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

Table 34: Configurable User Interface Error Codes

73
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

Table 35: Configurable User Interface Error Codes (Part 2)

74
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

75

Vous aimerez peut-être aussi