+ All Categories
Home > Documents > Time Card Configuration Guide

Time Card Configuration Guide

Date post: 01-Jun-2018
Category:
Upload: kiran-nambari
View: 228 times
Download: 0 times
Share this document with a friend

of 55

Transcript
  • 8/9/2019 Time Card Configuration Guide

    1/136

    Oracle ApplicationsOracle Time and Labor

    Conguring The Oracle Time and Labor Timecard User InterfaceWhite Paper ∗

    Author(s): Oracle Time and Labor Development

    Generation Date: June 9, 2010

    Abstract

    This document details the conguration options a timecard layout designer has when constructing a custom layout. OTLcurrently allows customization of timecard layouts via modication of AOL loader les which are then loaded into the database.

    c 2004 Oracle Corporation. All rights reserved.

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

    1

  • 8/9/2019 Time Card Configuration Guide

    2/136

    Contributors

    Name PositionMark Stewart Applications DeveloperAndrew Rundell Development ManagerJoel Dupont Applications DeveloperJohn Finnegan Principle Functional AnalystKris Van Der Pleog Functional AnalystAnima Prasad Senior Development ManagerBalakrishna Bayragi Applications DeveloperAmarnath Krishnamoorthy Senior Applications Developer

    Change Record

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

    August 6th

    , 2007 Amritha Nuthi 115.1 Modied to indicate correct functionality forpackage choice listMarch 25 th , 2008 Amritha Nuthi 115.2 Modied to show only the delivered seeded layouts and

    to complete the missing lines in some examplesFebruary 09 th , 2010 Amarnath Krishnamoorthy 115.3 Reviewed the document and added few examples which desc

    how to create custom choice list, LOV, prompts and text

    Reference Documents

    Name DescriptionRelease 11i Documentation Oracle Applications Documentation - information on FNDLOAD

    and FlexeldsADF Applications Development Framework - information on java ob- jects, such as View Objects, Application Modules etc.

    2

    http://www.oracle.com/technology/documentation/jdev/adf_guidelines_manual.pdfhttp://download.oracle.com/docs/virtual/index.htmlhttp://./versions/%201153.pdfhttp://./versions/%201152.pdfhttp://./versions/%201151.pdfhttp://./versions/%201150.pdfmailto:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]

  • 8/9/2019 Time Card Configuration Guide

    3/136

    Contents Introduction

    1.1 Executive Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Structure of a Timecard Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    1.2.1 Time Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.2 User Interface Component Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    1.3 Layout Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4 Delivered Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    1.4.1 Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.2 Pro jects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.3 Projects and Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4.4 Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.5 Enterprise Asset Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.6 Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.7 Projects-Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4.8 Payroll Layout delivered in Release 12.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.9 Project Layouts delivered in Release 12.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.10 Project and Payroll Layouts delivered in Release 12.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    1.5 Using the OAF Personalization Functionality With Timecard Conguration . . . . . . . . . . . . . . . . . . . . . . . . 19

    Timecard Conguration Basics 202.1 What can be congured on a Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.2 The Layout File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3 Using an Existing Layout as a Basis for Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.4 Uploading Timecard Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.5 Labels and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    2.5.1 Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.5.2 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    2.6 Further Conguration Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.6.1 View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.6.2 Application Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.6.3 Apache/JServ server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    2.7 Delivered Congurable BC4J Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.7.1 Congurable Choice List Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.7.2 Package Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.7.3 Custom Alternate Name components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    2.8 LOVs and JRAD/MDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.8.1 LOV Custom Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    Examples of Common Customizations 293.1 Adding a Comment Field to the Timecard Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2 Adding a Custom Choice List to the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.3 Adding a Custom LOV to the Timecard using the Custom LOV Objects . . . . . . . . . . . . . . . . . . . . . . . . . . 33.3.1 Create the supporting database view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.2 Add the LOV component to the timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.3 Personalize the LOV region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.4 Adding a Custom LOV to the Timecard without using the Custom LOV Objects . . . . . . . . . . . . . . . . . . . . . 33.4.1 Create the View Object for the LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4.2 Create AK attributes used for the LOV screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4.3 Create an AK region for rendering the LOV screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4.4 Create AK region items inside the AK region for the LOV page . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3

  • 8/9/2019 Time Card Configuration Guide

    4/136

    3.4.5 Run the migration script to copy the LOV denition from AK to the MDS repository . . . . . . . . . . . . . . 43.4.6 Modify a layout to include the LOV component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4.7 Include the new LOV View Object into your Apache/Jserv environment . . . . . . . . . . . . . . . . . . . . . . 4

    3.5 Changing the title of the timecard page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.6 Changing the label for a column in the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.7 Adding a Component to the Timecard Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.7.1 Create AK data for the component prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.7.2 Create wrapper PL/SQL function to call the payroll code function and return it in the format needed for the

    package choice list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.7.3 Create the component to show the label for our custom eld and add it to the layout . . . . . . . . . . . . . . 523.7.4 Create the component to show the read-only function result and add it to the layout . . . . . . . . . . . . . . . 52

    3.8 Adding a Component to the Timecard Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.9 Adding an OTL Information Type to the Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.10 Adding additional element input values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.11 Conguring the Cost Center component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.12 Adding OTLR Detail to the Review and Conrmation Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.12.1 Creating the Detail Time Building Blocks in the Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.13 Adding the Details Page DFF Segments to the Timecard matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63.13.1 Setting the Attribute Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.13.2 Aliasing A Segment Value To Set The Attribute Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.13.3 The Simple Approach: An Always-execute choice list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.13.4 Other Segment Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.14 Congure Expenditure Type As Choice List Using Alternate Names in Projects Payroll Layout . . . . . . . . . . . . . 743.14.1 Dene a New OTL Alternate Names Type Descriptive Flexeld Context / Segment: . . . . . . . . . . . . . . . 743.14.2 Mapping the Segments/Attributes to respective components: . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.14.3 Creating Alternate Name for the Alternate Name Type ET EXPENDITURE TYPES: . . . . . . . . . . . . . . 753.14.4 Create A Custom View and Dene Layouts: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.15 Conguring Cost Center as a LOV in Payroll Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.15.1 Create AK attributes used for the LOV screen : . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.15.2 Create an AK region for rendering the LOV screen: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.15.3 Create AK region items inside the AK region for the LOV page: . . . . . . . . . . . . . . . . . . . . . . . . . . 3.15.4 Migration of Ak Region to MDS Repository,Creation of Custom View and Dene Layouts: . . . . . . . . . . . 83.16 Adding Custom LOVs, Custom Choice List and Text Field to a Payroll Layout . . . . . . . . . . . . . . . . . . . . . . 8

    3.16.1 Create AK attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.2 Add Attributes to AK Region: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.3 Create database views: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.16.4 Create AK regions for rendering the LOVs: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.5 Create AK region items inside the AK region for the LOV page: . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.6 Setting up the Custom LOV xml and java les: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.7 Migration of Ak Region to MDS Repository: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.8 LDT le customization to change prompt from Hours Type to Job Type: . . . . . . . . . . . . . . . . . . . . . 93.16.9 LDT le customization to include choice list: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.10 LDT le customization to include source and destination LOVs: . . . . . . . . . . . . . . . . . . . . . . . . . . 3.16.11LDT le customization to include text eld: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.17 Congure an Entry Level Processing Timecard Layout to capture Project, Task and Expenditure Type Information inCost Allocation Key Flexeld segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.17.1 Create AK attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.17.2 Add Attributes to AK Region: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 .17.3 Create database views: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.17.4 Add Project Id, Task Id and Expenditure Type segments to Cost Allocation KFF: . . . . . . . . . . . . . . . . 1043.17.5 LDT le hxczzhxclayt0025.ldt customization to include JOB and LOCATION choice lists: . . . . . . . . . . . . 105

    4

  • 8/9/2019 Time Card Configuration Guide

    5/136

    3.17.6 LDT le hxczzhxclayt0025.ldt customization to add Cost Center eld: . . . . . . . . . . . . . . . . . . . . . . . 103.17.7 LDT le hxczzhxclayt0025.ldt customization to map Project Information to Cost Allocation KFF: . . . . . . . 1073.17.8 Attributes data stored in database: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.17.9 Batch Element Entry form showing the additional segments in Cost Allocation KFF: . . . . . . . . . . . . . . . 113

    Technical Reference Guide 1144.1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    4.1.1 Global attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.2 Accrual Balance Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.3 Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.4 Descriptive FlexField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.5 Display Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.6 Display Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.7 Display Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.8 Hidden Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.9 Hours Type Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.10 Inter-Period Navigation Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.11 Key Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.12 List Of Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.13 Message Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.14 Notication Day Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.15 Package Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 .1 .16 Page Sta tus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.17 Spacer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.18 Submit Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.19 Submit Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.20 Summary Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.21 Table Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 .1.22 Template Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.23 Text Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    4.1.24 Timecard Fragmentation Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 .1.25 Time Building Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.2 Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    Troubleshooting and Frequently Asked Questions 1365.1 FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    5

  • 8/9/2019 Time Card Configuration Guide

    6/136

    List of Tables1 Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Pro jects Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Pro jects and Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Exception Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Enterprise Asset Management Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Pro jects-Purchasing Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 R12.1 Payroll Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Projects Layouts - With Project & Task details concatenated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Projects and Payroll Layouts - With Project & Task details concatenated . . . . . . . . . . . . . . . . . . . . . . . . . 111 Delivered Custom Choice List View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Component Tables Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Global Attributes, applicable to every component. Required attribute(s) in bold. . . . . . . . . . . . . . . . . . . . . . 11514 Choice List Components. Required Attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115 Descriptive exeld component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 11816 Display text component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 11917 Inter Period Navigational Control component qualing attributes. Required attribute(s) are displayed in bold. . . . . 11918 Key notation component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 12019 List of Values component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 12220 Message Box component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 12321 Package Choice List component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 12422 Page Status component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 12423 Spacer component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . 12424 Submit Button component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . 12525 Submit Icon component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . 12526 Summary Table component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . 12527 Table Layout component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . 12628 Template Control component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . 126

    29 Text Field component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . 12730 Time Building Block component qualing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . 12831 Currently recognized tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Timecard region seeded prompts (Part 1.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Timecard region seeded prompts (Part 2.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Timecard Review region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Timecard Conrmation region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Seeded Timecard Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Congurable User Interface Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Congurable User Interface Error Codes (Part 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    6

  • 8/9/2019 Time Card Configuration Guide

    7/136

    List of Figures1 Time Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 What can be Congured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Timecard Matrix Line Comment Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Alternate Name Denition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Custom LOV Showing Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Custom LOV Showing Locations after personalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Dening New OTL Alternate Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Mapping Segements/Attributes to respective components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Preference Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Time Entry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 AK Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 AK Region items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Preference page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Time Entry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Congured Airlines Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Additional Element Input Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 AK Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Add Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 LOV AK Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 LOV AK Region items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Flight Source and Destination LOVs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Congured ELP Timecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23 Additional Element Input Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 AK Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Add Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Cost Allocation KFF Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 HXC TIME ATTRIBUTES table data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Cost Allocation KFF Segments in BEE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    7

  • 8/9/2019 Time Card Configuration Guide

    8/136

    Preface

    AudienceThis document describes the Oracle Time and Labor congurable timecard interface. It is a How-To guide as well as techn

    eference document. In order to congure an Oracle Time and Labor timecard user interface working knowledge of the OracleApplications generic loader, FNDLOAD, plus its associated pre-requisite knowledge, as well as a basic understanding of a web pagend Oracle Flexelds is required. For more complex congurations, 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 componentsuch as View Objects. Consult the appropriate reference documents for more detailed information on these Oracle Application speciceatures.

    Document StructureThere are ve sections to this document:

    • Section 1 provides introductory material, including and executive overview, which is appropriate background reading for peoplewishing to understand, but not implement a congurable user interface.

    • Section 2 describes the basics of timecard conguration, and at high level discusses the various objects and techniques employedwhen modifying the interface.

    • Section 3 builds on the previous section to provide explicit examples of typical congurations, 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 congurable components and objects associated with the congurableuser interface.

    • Finally, section 5 describes what to do in the case of an unexplained conguration error, and contains a list of frequently askedquestions.

    For very simple timecard congurations, e.g. just changing a prompt or moving a eld from one place to another, only the rsthree sections are required reading. For more complex congurations, e.g. adding a dependent list of values, the technical referenceection is invaluable.

    This version of the document applies to HXT.H onwards, Oracle Applications Release 11 i .10, Release 12.0 anRelease 12.1

    1 Introduction

    .1 Executive OverviewOracle Time & Labor (OTL) permits conguration of the timecard interface. Inclusion or exclusion of UI features, e.g. labels and

    uttons, as well as choosing the elds shown on the timecard lie within the conguration module. These elds can be the deliveredet, or custom elds, 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

    nown as a layout. Currently, a layout describes the user interface for one page, and thus there are OTL layouts for the timecardntry, review, conrmation, notication, approval, audit and details pages, as well as a layout that describes what information isvailable for offline time entry — the export layout. This enables the maximum level of conguration. Layouts are held in normal text

    les; these are loaded into the database using the standard applications loader utility (FNDLOAD), and conguration le suppliedy OTL. There are many delivered layouts that provide a timecard user interface congured for various applications, or combinationsf 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 aseight, color, size, direction, data source and so on. This extra information is held in a standard Oracle Applications Flexeld,alled Self Service Congurable UI Flexeld . Each of the user interface components has a context within this exeld, the segments

    8

  • 8/9/2019 Time Card Configuration Guide

    9/136

    f which are known as component qualiers, or just qualiers. The column names in the OTL database for these qualiers areQUALIFIER ATTRIBUTE1 through QUALIFIER ATTIRBUTE30. Use of a exeld to store this extra information ensures aonsistent approach to user interface components within the congurable user interface module, and makes it easier to add supportor additional components in the future.

    In conjuction with the standard Oracle Applications Development Framework (ADF) personalization feature, the OTL timecardongurable user interface module permits every aspect of the timecard page to be changed, within the normal limits of HTML.

    When conguring a timecard page, it is important to understand how the user interface components relate to the data generatedn the OTL time store. In this way, the most appropriate conguration is efficiently and accurately created. This document uses

    many OTL concepts to streamline the conguration for the application, and thus the relationship between the data and the usernterface components on the page is now described.

    .2 Structure of a Timecard Page.2.1 Time Building Blocks

    When entering time, you actually create objects (database records) called time building blocks. Time entry for a particular dayreates a new time building block, each entry being a separate block. Each time building block may store information about whathat 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 until5:00 PM, or from August 20th to August 26th.

    • A measure time building block is an entry of time that is a specic amount of time. For this type of time building block thereis 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 withoutparent) is the TIMECARD time building block, and represents the range of time for which this timecard exists, such as a week ormonth.

    Time building blocks have one or more child blocks and one parent block. You can attach blocks to other blocks, and build theomplete timecard for a period of time. Each day associated with this timecard is a child time building block of that TIMECARDime 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 timeuilding blocks associated with it, and these are the time entries associated with the timecard.

    The data model reects the user interface of the timecard page. Consider a square split in half. This square represents the screen,nd in one half, we render the attributes associated with the TIMECARD time building block, such as the comment text eld, in thether half, we render all the child building blocks of this block, the days and entries. Next, the process occurs for these child blocks,amely a square split in half, in one half we render the attributes the other we render the child building blocks of this block, and son. 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,imply doing that can lead to a confusing and repetitive user interface. To avoid this, the user interface component qualiers aresed to ensure that the timecard user interface makes sense. However, in principle, it is clear that there is a correspondance betweenhe hierarchical nature of the user interface components, and the hierarchical nature of the time store building block data structure.

    .2.2 User Interface Component HierarchyAs previously mentioned, user interface components — hereafter known simply as components — are the objects belonging to aimecard 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 hierarchyan be seen below:

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

    • page status

    9

  • 8/9/2019 Time Card Configuration Guide

    10/136

    • top level building block

    – header table layout∗ header eld table layout

    · inter-period navigation control label· inter-period navigation control component· override approver label· override approver component· template control label· template control component

    ∗ comments component– timecard matrix building block

    ∗ measure eld∗ project LOV∗ task LOV∗ expenditure type LOV∗ delete control∗ details control

    – template save table layout∗ save template name eld∗ save template submit control

    You will note the use of tables within this hierarchy - this is the primary way of formatting or aligning elds in HTML. So forxample, in the header table the outer table denition allows us to show the navigation/override/template elds on one side of theage and the comments eld on the other side. The nested table allows us to make sure that the eld labels and components areligned with each other to improve the visual appearance of the page. Note : For readers experienced with the ADF, it is clear thaach of these OTL congurable user interface components maps to a OAF web bean, and that the hierarchy described here is addedn its entirity to the web bean hierarchy used by OAF to render self service pages.

    .3 Layout TypesEach layout contains the component hierarchy denition for one page. Thus, it is benecial to describe a layout by functional type

    f page dened by that layout. Thus, we consider the following layout types:

    • timecard (time entry page)

    • review (timecard review page)

    • conrmation (timecard conrmation page)

    • details (timecard details page where applicable)

    • export (template used for the timecard export functionality)

    • notication (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 LevelApproval 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 elds, e.g. Payroll Timecard Layout, PayrollReview Layout, Payroll Conrmation Layout, Payroll Notication Layout etc., is sometimes referred to as a layout set.

    10

  • 8/9/2019 Time Card Configuration Guide

    11/136

    .4 Delivered Layoutsn order to facilitate rapid implementation, a number of common timecard layout sets are delivered with OTL. These meet manyequirements for capturing time, or can be used as the basis for customization.ind these layout les in $APPL TOP/hxc/11.5/patch/115/import/US/, where $APPL TOP is the mount and directory where

    Oracle Applications is installed. These layout sets are named after the application-specic data entry elds dened within them,.g. the Projects layout set contains components for a Project entry eld, a Task entry eld, an expenditure type eld and so on.

    There are four application-specic layout sets delivered with the OTL product: Payroll, Projects, Projects and Payroll — these areayouts with both the projects application and payroll application elds dened, and an Exception-based time reporting layout.

    11

  • 8/9/2019 Time Card Configuration Guide

    12/136

    Figure 1: Time Building Blocks

    12

  • 8/9/2019 Time Card Configuration Guide

    13/136

    .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.ldtPayroll Review Layout PAYROLL-REVIEW REVIEW hxczzhxclayt0005.ldtPayroll Conrmation Layout PAYROLL-CONFIRMATION CONFIRMATION hxczzhxclayt0001.ldtPayroll Export Timecard Layout PAYROLL-EXPORT-LAYOUT EXPORT hxczzhxclayt0002.ldtPayroll Fragmented Timecard View PAYROLL-FRAGMENT FRAGMENT hxczzhxclayt0003.ldtPayroll Notication Layout PAYROLL-NOTIFICATION NOTIFICATION hxczzhxclayt0051.ldtPayroll OTLR Details Review Layout PAYROLL-HE-REVIEW REVIEW hxczzhxclayt0004.ldtPayroll OTLR Details Notication Layout PAYROLL-HE-NOTIFICATION NOTIFICATION hxczzhxclayt0047.ldt

    Table 1: Payroll Layouts

    .4.2 ProjectsThe projects layouts delivered with the product are listed in table 2.

    Layout Name Layout Code Layout Type FilenameProjects Timecard Layout PROJECTS-TIMECARD TIMECARD hxczzhxclayt0019.ldtProjects Review Layout PROJECTS-REVIEW REVIEW hxczzhxclayt0020.ldtProjects Conrmation Layout PROJECTS-CONFIRMATION CONFIRMATION hxczzhxclayt0017.ldtProjects Details Layout PROJECTS-DETAIL DETAIL hxczzhxclayt0065.ldtProjects Export Timecard Layout PROJECTS-EXPORT-TIMECARD EXPORT hxczzhxclayt0018.ldtProjects Notication Layout PROJECTS-NOTIFICATION NOTIFICATION hxczzhxclayt0052.ldtProjects Fragmented Timecard View PROJECTS-FRAGMENT FRAGMENT hxczzhxclayt0058.ldtProjects Change and Late Audit En-

    try Layout

    PROJECTS-AUDIT-LAYOUT AUDIT hxczzhxclayt0014.ldt

    Projects Change and Late ReviewLayout

    PROJECTS-AUDIT-REVIEW REVIEW hxczzhxclayt0016.ldt

    Projects Change and Late Conrma-tion Layout

    PROJECTS-AUDIT-CONFIRMATION CONFIRMATION hxczzhxclayt0013.ldt

    Projects Change and Late Audit No-tication Layout

    PROJECTS-AUDIT-NOTIFICATION NOTIFICATION hxczzhxclayt0048.ldt

    Table 2: Projects Layouts

    13

  • 8/9/2019 Time Card Configuration Guide

    14/136

    .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.ldtProjects and Payroll Review Layout PROJECTS-ALTERNATE-REVIEW REVIEW hxczzhxclayt0010.ldtProjects and Payroll Conrmation Lay-out

    PROJECTS-AL-CONFIRMATION CONFIRMATION hxczzhxclayt0007.ldt

    Projects and Payroll Details Layout PROJECTS-ALTERNATE-DETAIL DETAIL hxczzhxclayt0012.ldtProjects and Payroll Export Layout PROJPAYROLL-EXPORT-LAYOUT EXPORT hxczzhxclayt0021.ldtProjects and Payroll Notication Layout PROJECTS-ALTERNATE-NOTIF NOTIFICATION hxczzhxclayt0053.ldtProjects and Payroll Fragmented Time-card View

    PROJECTS-ALTERNATE-FRAGMENT FRAGMENT hxczzhxclayt0009.ldt

    Projects and Payroll Change and LateAudit Entry Layout

    PROJECTS-ALT-AUDIT-LAYOUT AUDIT hxczzhxclayt0034.ld

    Projects and Payroll Change and LateReview Layout

    PROJECTS-ALTERNATE-CLA-REVIEW REVIEW hxczzhxclayt0033.ldt

    Projects and Payroll Change and LateConrmation Layout

    PROJECTS-AL-CLA-CONFIRMATION CONFIRMATION hxczzhxclayt0006.ldt

    Projects and Payroll Change and LateNotication Layout

    PROJECTS-ALTERNATE-CLA-NOTIF NOTIFICATION hxczzhxclayt0049.ldt

    Entry Level Processing Projects Pay-roll Timecard Layout

    ELP-PROJECTS-PAYROLL-TIMECARD TIMECARD hxczzhxclayt0025.ldt

    Entry Level Processing Projects Pay-roll Review Layout

    ELP-PROJECTS-PAYROLL-REVIEW REVIEW hxczzhxclayt0032.ldt

    Entry Level Processing Projects Pay-roll Conrmation Layout

    ELP-PROJECTS-PAYROLL-CONF CONFIRMATION hxczzhxclayt0023.ldt

    Entry Level Processing Projects Pay-roll Details Layout

    ELP-PROJECTS-PAYROLL-DETAIL DETAIL hxczzhxclayt0024.ldt

    Entry Level Processing Projects Pay-roll Export Layout

    ELP-PROJ-PAY-EXPORT-LAYOUT EXPORT hxczzhxclayt0035.ldt

    Entry Level Processing Projects Pay-roll Notication Layout

    ELP-PROJECTS-PAYROLL-NOTIF NOTIFICATION hxczzhxclayt0050.ldt

    Table 3: Projects and Payroll Layouts

    14

  • 8/9/2019 Time Card Configuration Guide

    15/136

    .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.ldtException Layout Timecard Review Page EXCEPTION-REVIEW REVIEW hxczzhxclayt0029.ldtException Layout Timecard Conrma-tion Page

    EXCEPTION-CONFIRMATION CONFIRMATION hxczzhxclayt0026.ldt

    Exception Export Timecard Layout EXCEPTION-EXPORT-LAYOUT EXPORT hxczzhxclayt0027.ldtException Layout Timecard Notica-tion Page

    EXCEPTION-NOTIFICATION NOTIFICATION hxczzhxclayt0046.ldt

    Exception Fragmented Timecard View EXCEPTION-FRAGMENT FRAGMENT hxczzhxclayt0064.ldtException OTLR Details Review Lay-out

    EXCEPTION-HE-REVIEW REVIEW hxczzhxclayt0028.ldt

    Exception OTLR Details NoticationLayout

    EXCEPTION-HE-NOTIFICATION NOTIFICATION hxczzhxclayt0045.ldt

    Table 4: Exception Layouts

    .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 FilenameEAM Conrmation Layout EAM-CONFIRMATION CONFIRMATION eamhxclayt.ldtEAM Review Layout EAM-REVIEW REVIEW eamhxclayre.ldtEAM Timecard Layout EAM-TIMECARD TIMECARD eamhxclayco.ldt

    Table 5: Enterprise Asset Management Layouts

    .4.6 Purchasing

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

    Layout Name Layout Code Layout Type FilenamePurchasing Timecard Layout PURCHASING-TIMECARD TIMECARD pozzhxclayt0054.ldtPurchasing Review Timecard Layout PURCHASING-REVIEW-TIMECARD REVIEW pozzhxclayt0055.ldtPurchasing Conrmation Timecard Layout PURCHASING-CONF-TIMECARD CONFIRMATION pozzhxclayt0056.ldtPurchasing Notication Timecard Layout PURCHASING-NOTIF-TIMECARD NOTIFICATION pozzhxclayt0057.ldt

    Table 6: Purchasing Layouts

    15

  • 8/9/2019 Time Card Configuration Guide

    16/136

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

    Layout Name Layout Code Layout Type FilenameTimecard Layout PROJECTS-PURCHASING-TIMECARD TIMECARD pazzhxclayt0039.ldtReview Timecard Layout PROJECTS-PURCHASING-REVIEW REVIEW pazzhxclayt0040.ldtConrmation Timecard Layout PROJECTS-PURCHASING-CONFIRM CONFIRMATION pazzhxclayt0041.ldtAudit Entry Layout PA-PO-AUDIT AUDIT pazzhxclayt0042.ldtCLA Review Layout PROJECTS-PURCHASING-CLA-REVIEW REVIEW pazzhxclayt0043.ldtCLA Conrmation PA-PO-CLA-CONFIRM CONFIRMATION pazzhxclayt0044.ldt

    Table 7: Projects-Purchasing Layouts

    .4.8 Payroll Layout delivered in Release 12.1

    The payroll layout delivered for ORACLE E-BUSINESS SUITE 12.1 with the product is listed in table 8.

    Layout Name Layout Code Layout Type FilenamePayroll OTLR Details Conrma-tion Layout

    PAYROLL-HE-CONFIRMATION CONFIRMATION hxczzhxclayt0081.ldt

    Table 8: R12.1 Payroll Layouts

    16

  • 8/9/2019 Time Card Configuration Guide

    17/136

    .4.9 Project Layouts delivered in Release 12.1

    The projects layouts delivered for ORACLE E-BUSINESS SUITE 12.1 with the product are listed in table 9.

    Layout Name Layout Code Layout Type Filename

    Projects Timecard Layout - WithProject & Task details concatenated PROJECTS-DETAILS-TIMECARD TIMECARD hxczzhxclayt0082.ldt

    Projects Review Layout - WithProject & Task details concatenated

    PROJECTS-DETAILS-REVIEW REVIEW hxczzhxclayt0083.ldt

    Projects Conrmation Layout -With Project & Task details concate-nated

    PROJECTS-DET-CONFIRM CONFIRMATION hxczzhxclayt0088.ldt

    Projects Details Layout - WithProject & Task details concatenated

    PROJECTS-DET-DETAIL DETAIL hxczzhxclayt0087.ldt

    Projects Export Timecard Layout -With Project & Task details concate-nated

    PROJECTS-DET-EXP-TIMECARD EXPORT hxczzhxclayt0086.ldt

    Projects Notication Layout - WithProject & Task details concatenated

    PROJECTS-DET-NOTIF NOTIFICATION hxczzhxclayt0084.ldt

    Projects Fragmented Timecard View- With Project & Task details con-catenated

    PROJECTS-DET-FRAGMENT FRAGMENT hxczzhxclayt0085.ldt

    Projects Change and Late Audit En-try Layout - With Project & Taskdetails concatenated

    PROJECTS-DET-AUDIT-LAYOUT AUDIT hxczzhxclayt0091.ldt

    Projects Change and Late ReviewLayout - With Project & Task de-tails concatenated

    PROJECTS-DET-AUDIT-REV REVIEW hxczzhxclayt0089.ldt

    Projects Change and Late Conrma-tion Layout - With Project & Taskdetails concatenated

    PROJECTS-DET-AUDIT-CONFIRM CONFIRMATION hxczzhxclayt0092.ldt

    Projects Change and Late Audit No-tication Layout - With Project &Task details concatenated

    PROJECTS-DET-AUDIT-NOTIF NOTIFICATION hxczzhxclayt0090.ldt

    Table 9: Projects Layouts - With Project & Task details concatenated

    .4.10 Project and Payroll Layouts delivered in Release 12.1

    The projects-payroll layouts delivered for ORACLE E-BUSINESS SUITE 12.1 with the product are listed in table 10.

    17

  • 8/9/2019 Time Card Configuration Guide

    18/136

    Layout Name Layout Code Layout Type FilenameProjects and Payroll Timecard Layout - WithProject & Task details concatenated

    PROJECTS-DET-ALT-TIMECARD TIMECARD hxczzhxclayt0093

    Projects and Payroll Review Layout - WithProject & Task details concatenated

    PROJECTS-DET-ALT-REVIEW REVIEW hxczzhxclayt0094

    Projects and Payroll Conrmation Layout - WithProject & Task details concatenated

    PROJECTS-DET-AL-CONF CONFIRMATION hxczzhxclayt0100.ldt

    Projects and Payroll Details Layout - WithProject & Task details concatenated

    PROJECTS-DET-ALT-DETAIL DETAIL hxczzhxclayt0098

    Projects and Payroll Export Layout - WithProject & Task details concatenated

    PROJPAY-DETAIL-EXPORT EXPORT hxczzhxclayt0099

    Projects and Payroll Notication Layout - WithProject & Task details concatenated

    PROJECTS-DET-ALT-NOTIF NOTIFICATION hxczzhxclayt0095.ldt

    Projects and Payroll Fragmented Timecard View- With Project & Task details concatenated

    PROJECTS-DET-ALT-FRAG FRAGMENT hxczzhxclayt0096

    Projects and Payroll Change and Late AuditEntry Layout - With Project & Task detailsconcatenated

    PROJECTS-DET-ALT-AUD-LAYOUT AUDIT hxczzhxclayt0104

    Projects and Payroll Change and Late Re-view Layout - With Project & Task detailsconcatenated

    PROJECTS-DET-ALT-CLA-REVIEW REVIEW hxczzhxclayt0101

    Projects and Payroll Change and Late Con-rmation Layout - With Project & Task de-tails concatenated

    PROJECTS-DET-ALT-CLA-CONF CONFIRMATION hxczzhxclayt0103.

    Projects and Payroll Change and Late Noti-cation Layout - With Project & Task detailsconcatenated

    PROJECTS-DET-ALT-CLA-NOTIF NOTIFICATION hxczzhxclayt0102.

    Entry Level Processing Projects - Payroll

    Timecard Layout - With Project & Task de-tails concatenated

    ELP-PROJ-DET-PAY-TIMECARD TIMECARD hxczzhxclayt0105

    Entry Level Processing Projects - Payroll Re-view Layout - With Project & Task detailsconcatenated

    ELP-PROJ-DET-PAY-REVIEW REVIEW hxczzhxclayt0106

    Entry Level Processing Projects - PayrollConrmation Layout - With Project & Taskdetails concatenated

    ELP-PROJ-DET-PAY-CONF CONFIRMATION hxczzhxclayt0110.

    Entry Level Processing Projects - Payroll De-tails Layout - With Project & Task detailsconcatenated

    ELP-PROJ-DET-PAY-DETAIL DETAIL hxczzhxclayt0109

    Entry Level Processing Projects - Payroll Ex-port Layout - With Project & Task detailsconcatenated

    ELP-PROJ-DET-PAY-EXP-LAYOUT EXPORT hxczzhxclayt0108

    Entry Level Processing Projects - Payroll No-tication Layout - With Project & Task de-tails concatenated

    ELP-PROJ-DET-PAY-NOTIF NOTIFICATION hxczzhxclayt0107.

    Table 10: Projects and Payroll Layouts - With Project & Task details concatenated

    18

  • 8/9/2019 Time Card Configuration Guide

    19/136

    .5 Using the OAF Personalization Functionality With Timecard Congurationn short, for any page rendered with the Oracle Time and Labor (OTL) timecard conguration utility, no UI components can beersonalized using the standard Oracle Applications Framework (OAF) functionality. All changes to the page must be made via the

    Oracle Time and Labor page layout denition.

    The one exception to this rule are the pages rendered in the LOV pop-up windows. While the LOVs themselves are controlled by theOTL timecard conguration utility, the pages rendered in the pop-up list of values windows are not. Thus, the OAF Personalizatiunctionality can be used to personalize those windows. For example, if the project id column in the Projects LOV pop-up should beidden, a customer should create a personalization at the desired level and hide that column. If the columns should be renamed oreordered, again, this should be done via the personalization framework delivered with the OAF.

    19

  • 8/9/2019 Time Card Configuration Guide

    20/136

    2 Timecard Conguration BasicsThe fastest mechanism of conguring 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 modications. The document covershe majority of customizations, which are to the timecard header — the comments eld, period list control and template control

    widgets — and timecard matrix — the time attributes and time entry elds. In summary, the minimal number of steps to conguretimecard 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 congure the components of the timecard.

    4. Upload the timecard layout to the database using FNDLOAD (see section 2.4).

    NOTE: Do not use Web Application Dictionary or the OA Conguration Framework to congure the layouts.However, there are items on the OTL timecard pages such as the product branding and buttons which are outside the scope of theongurable user interface. Thus use the personalization framework to modify to those user interface components, e.g. to change theranding, or the labels on the buttons.

    2.1 What can be congured on a Timecard

    Figure 2: What can be Congured

    PINK = Standard AOL Messages that can be modied via AOL message formGREEN = AK prompts that can be modied in the AK region item or attribute formsRED = Attribute components in the timecard layout that can be modied via the conguration LDTsBLACK = Information on the timecard layout that can be controlled via preferences

    20

  • 8/9/2019 Time Card Configuration Guide

    21/136

    2.2 The Layout FileAs previously mentioned, the timecard layout containing a set of user interface component, and associated qualifer descriptions, is

    eld in a simple text le. Use FNDLOAD , the generic AOL loader utility, to upload the le data into the OTL CongurableUser Interface database tables. Read the AOL documentation, within the Oracle Applications release 11 i documentation, for m

    nformation on FNDLOAD. In common with all FNDLOAD compatible les, OTL delivers a conguration le, which denes thetructure of the layout les. This conguration le denes the entities, and entity attributes that are present within the le, whichre in the form of name value pairs unless part of the developer key for the attribute. For example, the HXC LAYOUT entity haswo keys, the layout name, and the application short name that owns the layout (at the moment this is only OTL) and then aumber of attributes, such as the display layout name and the layout type. In OTL, each of the entities denied in the conguration

    le maps to an OTL table, e.g. the HXC LAYOUTS entity maps to the HXC LAYOUTS table. Each of the entity keys, or entityttributes in the loader le maps directly or via a key to columns in those entities. E.g. DISPLAY LAYOUT NAME maps to theatabase column, DISPLAY LAYOUT NAME, while PARENT COMPONENT maps to the column PARENT COMPONENT ID,s the parent component species a key attribute of an entity. The conguration le is:

    $APPL TOP/hxc/11.5/patch/115/import/hxclaytlayoutsld.lct

    nd must be used in conjunction with FNDLOAD when uploading the layout.

    2.3 Using an Existing Layout as a Basis for CustomizationWhen 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

    our new timecard layouts new names. Even if you do not plan to use the delivered layouts this change should still be made to avoidour custom layout being overwritten when OTL patches are applied to your environment. In order to rename the layout, you needo change the layout name and description in the loader le. You do this in the section at the top of the data le.

    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"

    These changes must be made for any layout you are modifying, and it is also a good idea to change the lename of the loader leo avoid confusion with the OTL delivered les.

    2.4 Uploading Timecard LayoutsTo upload the new layouts (for each of the layouts in the set you are using, or have customized) to the database execute the followingommand from the command line:

    FNDLOAD username/password@dbname 0 Y UPLOAD $HXC TOP/patch/115/import/hxclaytlayoutsld.lct ./layout.ldtThis command assumes the path environment variables are set correctly, so that the FNDLOAD executable lies on the path, and

    he congured layout is in the current directory and in a le called layout.ldt .Once the modied layout is successfully uploaded, it will be available in the OTL application Preferences form and you can give

    t to a user, or groups of users as required.

    21

  • 8/9/2019 Time Card Configuration Guide

    22/136

    2.5 Labels and MessagesThere are two concepts used to store any text that is displayed on an OTL timecard screen - prompts and messages. In general, formall amounts of text, use a prompt, otherwise use a message, which can be considerably more descriptive. For example, the tip athe top of the timecard page is a message, while the Project label in the timecard matrix is a prompt. All component prompts and

    ther items such as titles, button labels, etc. are dened as prompts.

    .5.1 Labels

    All labels in the OTL congurable 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 congurable UI for customized timecards. AK data for our purpose, is

    ened as a region containing one or more region items. For OTL, the region is just a ’container’ for all of the prompts - to see anxample 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 haveone-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 elds when querying labels - the ones used, and that should be set (other than mandatory elds suchs 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 specied)

    When creating your own custom prompts you should take note of the attribute code (for the attribute referenced by your regiontem), along with the region code and application you have created the region items under - this information will be needed to utilizehese labels within your congured timecard layout.

    .5.2 Messages

    Messages in OTL use the standard Applications Object Library message functionality to provide a translatable and customizableolution for longer sections of text. When creating messages you should note the message name you have specied, along with thepplication name you have used.

    2.6 Further Conguration Conceptsf conguring 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 conguring the OTL timecard interface. Specially, the businessbjects (BC4J or JBO) layer — these are java objects that contain or are business data — affect timecard interface conguration ashe data used by the user interface components is dependent on those objects. View objects and Application Modules are two of theusiness objects that require conguration. An excellent discussion on these objects, and the Applications Development FrameworkADF) in general are found in the ADF Development Guidelines document available from the Oracle Technology Network.

    .6.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 youequire 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. ViewObjects delivered by OTL should not be modied since these changes will be overwritten whenever a patch applied with changes tohe View Object is applied. View Objects can be developed using the wizard supplied with JDeveloper. Once created, the BC4Jbjects should then be added to the classpath for the Apache/JServ server so they will be available for use within the OTL timecardcreen. Note: any custom View Objects should be contained in a custom Application Module (see below for additional information).

    22

  • 8/9/2019 Time Card Configuration Guide

    23/136

    .6.2 Application Modules

    An Application Module is a BC4J object which can be considered a ’container’ for View Objects. Note: If you create your ownustom View Objects then you should also create an Application Module to contain them. In order for the timecard page to functionroperly with custom view objects, the OTL congurable 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 congurable user interfacemust know the name of the custom application module. So when referencing a view object as part of the qualiers for a user interfaceomponent, 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 qualier 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 layoutmatches that of your code.

    .6.3 Apache/JServ server

    When customizations have been performed on the timecard the Apache/Jserv process may need to be ’bounced’ before the changeswill 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 denitions (using the migration script that creates LOV denitions in JRAD from theAK 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 theser has logged out and signed in again.

    2.7 Delivered Congurable BC4J Objects.7.1 Congurable Choice List Components

    To allow easy implementation of choice list components, OTL delivers a number of ’Congurable Choice Lists’. What this basicallymeans is that we deliver a View Object based on a congurable view, so rather than a customer having to use JDeveloper to createheir own BC4J view objects and application module, they can just alter the denition of the underlying congurable view and thendd it onto their congured layouts.

    OTL currently delivers ten of these congurable view objects:The congurable view consists of two columns:

    DISPLAY VALUE VARCHAR2(30)VALUE VARCHAR2(15)

    These names must be used in order that the congurable user interface can display the appopriate data in the choice list componentn the timecard interface, but components will default the attributes that specify these to the same names, so they do not need toe specied 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 benet of anyone

    23

  • 8/9/2019 Time Card Configuration Guide

    24/136

    View Object Name View Object Class Congurable View NameCustom1VO oracle.apps.hxc.selfservice.timecard.server.Custom1VO HXC CUI CUSTOM1 VCustom2VO oracle.apps.hxc.selfservice.timecard.server.Custom2VO HXC CUI CUSTOM2 VCustom3VO oracle.apps.hxc.selfservice.timecard.server.Custom3VO HXC CUI CUSTOM3 VCustom4VO oracle.apps.hxc.selfservice.timecard.server.Custom4VO HXC CUI CUSTOM4 VCustom5VO oracle.apps.hxc.selfservice.timecard.server.Custom5VO HXC CUI CUSTOM5 VCustom6VO oracle.apps.hxc.selfservice.timecard.server.Custom6VO HXC CUI CUSTOM6 VCustom7VO oracle.apps.hxc.selfservice.timecard.server.Custom7VO HXC CUI CUSTOM7 VCustom8VO oracle.apps.hxc.selfservice.timecard.server.Custom8VO HXC CUI CUSTOM8 VCustom9VO oracle.apps.hxc.selfservice.timecard.server.Custom9VO HXC CUI CUSTOM9 VCustom10VO oracle.apps.hxc.selfservice.timecard.server.Custom10VO HXC CUI CUSTOM10 V

    Table 11: Delivered Custom Choice List View Objects

    sing the timecard it should obviously make some sense!). Note : For exibility both columns are delivered as type VARCHAR2, sf 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 nanto 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 statemento it is easier to nd 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) VALUEFROM 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 specied the aliases for tholumns so they match the expected names within the View Object. Note : Given the nature of HTML all possible selections fohoice list (both displayed text and the selection value) are part of the generated page. It is strongly advised that Choice Lists onlye 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.f the user is using a dial-up connection.

    Information : There is an Applications Object Library prole which controls the maximum number of rows fetched for a ViewObject. This prole is called ’FND: View Object Max Fetch Size’ and is set to a default of 200. Without changing this prole option,his 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, butan be run manually to create template views for testing, or alternatively you can copy and modify the script to contain your customiew objects which can then be created by running the script. This script can be found under $HXC TOP/patch/115/sql/hxccuivw.sql

    .7.2 Package Choice ListA package choice list is visually exactly the same as a normal choice list component on the page. The difference between the two ishe 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

    package choice list the equivalent View Object is built from the result of a PL/SQL function call. The PL/SQL call should returnhe data to be shown in the choice in display value/value pairs (each separated by ’—’). The call be made with any of the supportedokens — see section 4 — for the timecard - all parameters should be of type varchar2.

    Currently only one instance of a Package Choice List component can exist on a Self-Service page. A Package Choice List components dened like any other component. It uses a context called PACKAGE CHOICE LIST of the congurable user interface component

    24

  • 8/9/2019 Time Card Configuration Guide

    25/136

    ualifer exeld. Attributes associated with this context, dene the behaviour of this component, and tell the congurable usernterface code how to call the package. In QUALIFIER ATTRIBUTE1 the package and function name to be called are specied, and

    QUALIFIER ATTRIBUTE2 contains the parameter list for the function. Parameters for the function call are bound by position, sot is important to make sure the order they specied in the layout matches that of the function. Literal values may also be passed inhe parameter list - this could be used, for example, if you wanted to use the same function for a multiple components on the pageut be able to identify each of the components and have the code behave slightly differently for each. As an example, lets create aunction called ’test’ in the package ’my custom code’ that takes 3 parameters - the person id of the user, the timecard start datend 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.testQUALIFIER 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 toe shown in the choice list. This is the function supporting the choice list, and so this is just an example, obviously a conguredunction could perform any operation, as long as the return parameter meets the specication dened 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’) THENl return value := ’1|Test1|2|Test2|3|Test3’;ELSEl return value := ’10|Display1|20|Display2|30|Display3’;END IF;---- return values

    25

  • 8/9/2019 Time Card Configuration Guide

    26/136

    --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 he 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 prole which controls the maximum number of rows fetched for a View Object.This prole is called ’FND: View Object Max Fetch Size’ and is set to a default of 200.

    .7.3 Custom Alternate Name components

    OTL Alternate Functionality is a commonly congured option on the timecard interface, because it drastically simplies data entryor users. For example, the expenditure type seeded alias allows users to pick one value, which is converted by the system into anxpenditure type, hours (element) type and a system linkage function. Thus, the user is selecting one value, rather than three. Fordiscussion of OTL alternate name functionality consult the OTL Application documentation.

    To allow for simple conguration of alternate name components, OTL delivers ve customizable alternate name objects. For theelf-Service functionality of OTL only the ’OTL Alternate Name DFF Context’ type of alternate names are supported. This type of lternate name is based on the context denition attached to the ’OTL Alternate Names’ descriptive FlexField. In the context youongure the denition 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 denitions. This segment is used when you wish to dene more than one alternateame with the same set of values, but with different names. In order to uniquely identify them the identier segment should be used.or this example, when the ELEMENTS EXPENDITURE SLF alternate name type is submit, the values that are deposited are aayroll 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 denition. This is done using the alternate name mapping professional form. Performa query based on the ’OTL Alternate Name DFF Context’ and your context as the type and then enter the mappings yourequire. For each segment of your context, you should link the correct mapping component that will be used when depositingthe information into OTL.

    • Once the alternate name context and mappings are complete it can be utilized by attaching the ’Self-Service timecard alternatename set dened for a user’ preference as needed.

    • Next, your timecard layouts should be modied to include the custom alternate name component. These components aredelivered as VO denitions that are plugged into an LOV or choicelist component with some specic qualiers set.

    Lets use an example to illustrate how an alternate name could be added onto a timecard layout with an LOV component.

    BEGIN HXC LAYOUT COMPONENTS" My Timecard Layout - ExpType PriceType"OWNER = "ORACLE"

    26

  • 8/9/2019 Time Card Configuration Guide

    27/136

    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 =

    Ë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 QUALIFIERSEND HXC LAYOUT COMPONENTS

    Let’s go over the relevant qualier settings to explain how it works.QUALIFIER ATTRIBUTE1: This species the custom alternate name view object to use for this component. OTL supports 5f these custom denitions and the VO names for each of these are:

    AlternateNameItem1VOAlternateNameItem2VOAlternateNameItem3VOAlternateNameItem4VOAlternateNameItem5VO

    27

  • 8/9/2019 Time Card Configuration Guide

    28/136

    QUALIFIER ATTRIBUTE3: For each of the custom alternate name view objects there is an LOV region delivered which referenceshem - 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 qualier contains the bind variables used for the alternate name denition - the rst parameterhould always be the type of alternate name, with the second being the timecard bind end date and the last the timecard bind startate.

    QUALIFIER ATTRIBUTE26, 27 and 28: These qualiers contain values that tell the OTL deposit process how to handle theselternate name objects. In qualier attribute26 the OTL ALIAS ITEM1 context is specied which is used to identify the alternateame in the attribute structure - the actual context does not exist.

    2.8 LOVs and JRAD/MDSThe Oracle Applications Self-Service framework now uses the MDS dictionary (aka JRAD) to store all denitions for Self Service pagesncluding 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 documentationor a full description of the UI dictoinaries used in the development framework.

    In order to allow continue conguration of LOVs using the AK professional forms OTL has provided a migration utility whichwill allow you to migrate denitions from AK to MDS.

    This utility is available as a procedure in the package HXC LOV MIGRATION. The denition 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 specied then the procedure will attempt tomigrate any LOV denitions created under application code 809 (HXC) that have no previously been migrated (there is also a scriptvailable 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 denition of an LOV and need to migrate it again then you need to call the procedure with the forcearameter set to ’Y’ so that the previous denition 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 denition that wreviously 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’);

    .8.1 LOV Custom Objects

    Beginning with HXT.J Cumulative backports 1, patch 4634379, customizable list of values objects were introduced, facilitating easyddition or replacement of list of values on the timecard. The BC4J object is called CustomLov1VO , and the custom MDS regs called CuiCustomLov1RN . The BC4J object references the HXC CUI CUSTOM LOV1 V view, and this view must be present on tatabase before the list of values will work.

    28

  • 8/9/2019 Time Card Configuration Guide

    29/136

    3 Examples of Common Customizations

    3.1 Adding a Comment Field to the Timecard LineThe delivered timecard layouts inc


Recommended