oracle otl timecard layout customication

Upload: foolish

Post on 07-Aug-2018

446 views

Category:

Documents


7 download

TRANSCRIPT

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    1/138

    Oracle Applications

    Oracle Time and Labor

    Configuring The Oracle Time and Labor Timecard User Interface

    White Paper∗

    Author(s): Oracle Time and Labor Development

    Generation Date: June 7, 2012

    Abstract

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

    c2012 Oracle Corporation. All rights reserved.

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

    1

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    2/138

    Contributors

    Name PositionMark Stewart   Applications DeveloperAndrew Rundell   Development Manager

    Joel Dupont   Applications DeveloperJohn Finnegan   Principle Functional AnalystKris Van Der Pleog   Functional AnalystAnima Prasad   Group ManagerBalakrishna Bayragi   Senior Applications EngineerAmarnath Krishnamoorthy   Senior Applications Engineer

    Change Record 

    Date Author Version Change Reference

    February 1st, 2005 Andrew Rundell 115.0 Converted to PDF, WIKI, LaTeX

    August 6th

    , 2007 Amritha Nuthi 115.1 Modified to indicate correct functionality forpackage choice list

    March 25th, 2008 Amritha Nuthi 115.2 Modified to show only the delivered seeded layouts andto complete the missing lines in some examples

    February 09th, 2010 Amarnath Krishnamoorthy 115.3 Reviewed the document and added few examples whichhow to create custom choice list, LOV, prompts and tex

    June 07th, 2012 Balakrishna Bayragi 115.4 Added section 3.18

    Reference Documents

    Name DescriptionRelease 11i Documentation Oracle Applications Documentation - information on FNDLOADand Flexfields

    ADF 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/%201154.pdfhttp://./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/21/2019 Oracle OTL Timecard Layout Customication

    3/138

    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 Pro jects and Payroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4.4 Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4.5 Enterprise Asset Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4.6 Purchasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4.7 Pro jects-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 Configuration . . . . . . . . . . . . . . . . . . . . . . . .

    Timecard Configuration Basics 2.1 What can be configured 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 Configuration Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.6.1 View Ob jects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.6.2 Application Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.6.3 Apache/JServ server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    2.7 Delivered Configurable BC4J Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.7.1 Configurable 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 Ob jects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    Examples of Common Customizations 3.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 . . . . . . . . . . . . . . . . . . . . . . . . . .3.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 . . . . . . . . . . . . . . . . . . . . .3.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/21/2019 Oracle OTL Timecard Layout Customication

    4/138

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

    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 field and add it to the layout . . . . . . . . . . . . . .3.7.4 Create the component to show the read-only function result and add it to the layout . . . . . . . . . . . . . . .

    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 Configuring the Cost Center component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.12 Adding OTLR Detail to the Review and Confirmation 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.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 Configure Expenditure Type As Choice List Using Alternate Names in Projects Payroll Layout . . . . . . . . . . . . .3.14.1 Define a New OTL Alternate Names Type Descriptive Flexfield Context / Segment: . . . . . . . . . . . . . . .3.14.2 Mapping the Segments/Attributes to respective components: . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.14.3 Creating Alternate Name for the Alternate Name Type ET EXPENDITURE TYPES: . . . . . . . . . . . . . .3.14.4 Create A Custom View and Define Layouts: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.15 Configuring 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 Define Layouts: . . . . . . . . . . .

    3.16 Adding Custom LOVs, Custom Choice List and Text Field to a Payroll Layout . . . . . . . . . . . . . . . . . . . . . .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 files: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.16.7 Migration of Ak Region to MDS Repository: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.16.8 LDT file customization to change prompt from Hours Type to Job Type: . . . . . . . . . . . . . . . . . . . . .3.16.9 LDT file customization to include choice list: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.16.10 LDT file customization to include source and destination LOVs: . . . . . . . . . . . . . . . . . . . . . . . . . .

    3.16.11LDT file customization to include text field: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.17 Configure an Entry Level Processing Timecard Layout to capture Project, Task and Expenditure Type Information in

    Cost Allocation Key Flexfield segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.17.1 Create AK attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.17.2 Add Attributes to AK Region: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3. 17. 3 Create database vi ews: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.17.4 Add Project Id, Task Id and Expenditure Type segments to Cost Allocation KFF: . . . . . . . . . . . . . . . .3.17.5 LDT file hxczzhxclayt0025.ldt customization to include JOB and LOCATION choice lists: . . . . . . . . . . . .

    4

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    5/138

    3.17.6 LDT file hxczzhxclayt0025.ldt customization to add Cost Center field: . . . . . . . . . . . . . . . . . . . . . . .3.17.7 LDT file hxczzhxclayt0025.ldt customization to map Project Information to Cost Allocation KFF: . . . . . . .3.17.8 Attributes data stored in database: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.17.9 Batch Element Entry form showing the additional segments in Cost Allocation KFF: . . . . . . . . . . . . . . .

    3.18 Confirmation Check box on Timecard review page for Time Accuracy . . . . . . . . . . . . . . . . . . . . . . . . . . .

    4 Technical Reference Guide 4.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 Notification Day Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.15 Package Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 . 1 . 1 6 P a g e S t a t u s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .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 Tem pl ate Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    4.1.23 Text Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.24 Timecard Fragmentation Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 1. 25 Ti m e Bui l di ng Bl ock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

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

    5

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    6/138

    List of Tables

    1 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Projects and Payroll Layouts - With Project & Task details concatenated . . . . . . . . . . . . . . . . . . . . . . . . .11 Delivered Custom Choice List View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 Component Tables Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Global Attributes, applicable to every component. Required attribute(s) in bold. . . . . . . . . . . . . . . . . . . . . .14 Choice List Components. Required Attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . . . . . . . . .15 Descriptive flexfield component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . .16 Display text component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . .17 Inter Period Navigational Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . .18 Key notation component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . .19 List of Values component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . .20 Message Box component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . .21 Package Choice List component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . .22 Page Status component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . .23 Spacer component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . . . .24 Submit Button component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . .25 Submit Icon component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . .26 Summary Table component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . .27 Table Layout component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . .28 Template Control component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . .

    29 Text Field component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . . . . . . . .30 Time Building Block component qualifing attributes. Required attribute(s) are displayed in bold. . . . . . . . . . . . .31 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 Confirmation region seeded prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36 Seeded Timecard Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 Configurable User Interface Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 Configurable User Interface Error Codes (Part 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    6

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    7/138

    List of Figures

    1 Time Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 What can be Configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Timecard Matrix Line Comment Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    4 Alternate Name Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Custom LOV Showing Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Custom LOV Showing Locations after personalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Defining New OTL Alternate Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Mapping Segements/Attributes to respective components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Preference Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Time Entry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 AK Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 AK Region items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Preference page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14 Time Entry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 Configured 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 Configured 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    29 Confirmation Check box on Timecard review page for Time Accuracy . . . . . . . . . . . . . . . . . . . . . . . . . . .

    7

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    8/138

    Preface

    Audience

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

    eference document. In order to configure an Oracle Time and Labor timecard user interface working knowledge of the OApplications generic loader, FNDLOAD, plus its associated pre-requisite knowledge, as well as a basic understanding of a web p

    nd Oracle Flexfields is required. For more complex configurations, such as custom list of values, some familiarity with the OApplications Development Framework (ADF) is required. For example, additional list of values may require new ADF componuch as View Objects. Consult the appropriate reference documents for more detailed information on these Oracle Application speeatures.

    Document Structure

    There are five sections to this document:

    •  Section 1 provides introductory material, including and executive overview, which is appropriate background reading for pewishing 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 emplowhen modifying the interface.

    •   Section 3 builds on the previous section to provide explicit examples of typical configurations, e.g. changing the window 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 configuuser interface.

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

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

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

    1 Introduction

    1.1 Executive Overview

    Oracle Time & Labor (OTL) permits configuration of the timecard interface. Inclusion or exclusion of UI features, e.g. labelsuttons, as well as choosing the fields shown on the timecard lie within the configuration module. These fields can be the delivet, 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, an

    nown as a layout. Currently, a layout describes the user interface for one page, and thus there are OTL layouts for the timentry, review, confirmation, notification, approval, audit and details pages, as well as a layout that describes what informativailable for offline time entry — the export layout. This enables the maximum level of configuration. Layouts are held in normalles; these are loaded into the database using the standard applications loader utility (FNDLOAD), and configuration file suppy OTL. There are many delivered layouts that provide a timecard user interface configured for various applications, or combinatf 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, suceight, color, size, direction, data source and so on. This extra information is held in a standard Oracle Applications Flexalled  Self Service Configurable UI Flexfield . Each of the user interface components has a context within this flexfield, the segm

    8

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    9/138

    f which are known as component qualifiers, or just qualifiers. The column names in the OTL database for these qualifiersQUALIFIER ATTRIBUTE1 through QUALIFIER ATTIRBUTE30. Use of a flexfield to store this extra information ensur

    onsistent approach to user interface components within the configurable user interface module, and makes it easier to add supor additional components in the future.

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

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

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

    1.2 Structure of a Timecard Page

    .2.1 Time Building Blocks

    When entering time, you actually create ob jects (database records) called time building blocks. Time entry for a particularreates a new time building block, each entry being a separate block. Each time building block may store information about what 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 u5: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 tis 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 withparent) is the TIMECARD time building block, and represents the range of time for which this timecard exists, such as a weemonth.

    Time building blocks have one or more child blocks and one parent block. You can attach blocks to other blocks, and buildomplete timecard for a period of time. Each day associated with this timecard is a child time building block of that TIMECAime building block. Day building blocks are range building blocks, and represent the amount of time within that day (they sta

    midnight on that particular day, and end at one second before midnight on the same day). Each day may have one or more uilding 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 scrnd in one half, we render the attributes associated with the TIMECARD time building block, such as the comment text field, inther half, we render all the child building blocks of this block, the days and entries. Next, the process occurs for these child bloamely a square split in half, in one half we render the attributes the other we render the child building blocks of this block, ann. 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. Howimply doing that can lead to a confusing and repetitive user interface. To avoid this, the user interface component qualifiersed to ensure that the timecard user interface makes sense. However, in principle, it is clear that there is a correspondance betwhe hierarchical nature of the user interface components, and the hierarchical nature of the time store building block data struct

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

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

    •   page status

    9

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    10/138

    •   top level building block

    –  header table layout

    ∗  header field table layout

    ·   inter-period navigation control label

    ·   inter-period navigation control component

    ·  override approver label

    ·  override approver component

    ·   template control label

    ·  template control component

    ∗  comments component

    –   timecard matrix building block

    ∗   measure field

    ∗   project LOV

    ∗   task LOV

    ∗   expenditure type LOV

    ∗  delete control∗  details control

    –  template save table layout

    ∗  save template name field

    ∗  save template submit control

    You will note the use of tables within this hierarchy - this is the primary way of formatting or aligning fields in HTML. Sxample, in the header table the outer table definition allows us to show the navigation/override/template fields on one side ofage and the comments field on the other side. The nested table allows us to make sure that the field labels and componentligned with each other to improve the visual appearance of the page.   Note: For readers experienced with the ADF, it is clear ach of these OTL configurable user interface components maps to a OAF web bean, and that the hierarchy described here is an 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 f 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 approverapprove time, e.g. all the projects entries, all the payroll entries — this layout type is used in conjunction with the Entry LApproval 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, PaReview Layout, Payroll Confirmation Layout, Payroll Notification Layout etc., is sometimes referred to as a layout set.

    10

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    11/138

    1.4 Delivered Layouts

    n order to facilitate rapid implementation, a number of common timecard layout sets are delivered with OTL. These meet manequirements for capturing time, or can be used as the basis for customization.

    Find these layout files in $APPL TOP/hxc/11.5/patch/115/import/US/, where $APPL TOP is the mount and directory where

    Oracle Applications is installed. These layout sets are named after the application-specific data entry fields defined within them.g. the Projects layout set contains components for a Project entry field, a Task entry field, an expenditure type field and so o

    There are four application-specific layout sets delivered with the OTL product: Payroll, Projects, Projects and Payroll — theseayouts with both the projects application and payroll application fields defined, and an Exception-based time reporting layout

    11

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    12/138

    Figure 1: Time Building Blocks

    12

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    13/138

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

    Table 1: Payroll Layouts

    .4.2 Projects

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

    Layout Name Layout Code Layout Type Filename

    Pro jects Timecard Layout PROJECTS-TIMECARD TIMECARD hxczzhxclayt0019.ldtProjects Review Layout PROJECTS-REVIEW REVIEW hxczzhxclayt0020.ldtProjects Confirmation Layout PROJECTS-CONFIRMATION CONFIRMATION hxczzhxclayt0017.ldtProjects Details Layout PROJECTS-DETAIL DETAIL hxczzhxclayt0065.ldtProjects Export Timecard Layout   PROJECTS-EXPORT-TIMECARD   EXPORT hxczzhxclayt0018.ldtProjects Notification 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 Confirma-tion Layout

    PROJECTS-AUDIT-CONFIRMATION   CONFIRMATION hxczzhxclayt0013.ldt

    Projects Change and Late Audit No-tification Layout

    PROJECTS-AUDIT-NOTIFICATION   NOTIFICATION hxczzhxclayt0048.ldt

    Table 2: Projects Layouts

    13

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    14/138

    .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.lProjects and Payroll Review Layout   PROJECTS-ALTERNATE-REVIEW   REVIEW hxczzhxclayt0010.lProjects and Payroll Confirmation Lay-

    out

    PROJECTS-AL-CONFIRMATION CONFIRMATION hxczzhxclayt0007.l

    Projects and Payroll Details Layout   PROJECTS-ALTERNATE-DETAIL   DETAIL hxczzhxclayt0012.lProjects and Payroll Export Layout   PROJPAYROLL-EXPORT-LAYOUT   EXPORT hxczzhxclayt0021.lProjects and Payroll Notification Layout   PROJECTS-ALTERNATE-NOTIF NOTIFICATION hxczzhxclayt0053.lProjects and Payroll Fragmented Time-

    card View

    PROJECTS-ALTERNATE-FRAGMENT   FRAGMENT hxczzhxclayt0009.l

    Projects and Payroll Change and LateAudit Entry Layout

    PROJECTS-ALT-AUDIT-LAYOUT   AUDIT hxczzhxclayt0034.l

    Projects and Payroll Change and LateReview Layout

    PROJECTS-ALTERNATE-CLA-REVIEW   REVIEW hxczzhxclayt0033.l

    Projects and Payroll Change and LateConfirmation Layout

    PROJECTS-AL-CLA-CONFIRMATION   CONFIRMATION hxczzhxclayt0006.l

    Projects and Payroll Change and LateNotification Layout

    PROJECTS-ALTERNATE-CLA-NOTIF   NOTIFICATION hxczzhxclayt0049.l

    Entry Level Processing Projects Pay-roll Timecard Layout

    ELP-PROJECTS-PAYROLL-TIMECARD   TIMECARD hxczzhxclayt0025.l

    Entry Level Processing Projects Pay-roll Review Layout

    ELP-PROJECTS-PAYROLL-REVIEW   REVIEW hxczzhxclayt0032.l

    Entry Level Processing Projects Pay-roll Confirmation Layout

    ELP-PROJECTS-PAYROLL-CONF   CONFIRMATION hxczzhxclayt0023.l

    Entry Level Processing Projects Pay-roll Details Layout

    ELP-PROJECTS-PAYROLL-DETAIL   DETAIL hxczzhxclayt0024.l

    Entry Level Processing Projects Pay-

    roll Export Layout

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

    Entry Level Processing Projects Pay-roll Notification Layout

    ELP-PROJECTS-PAYROLL-NOTIF   NOTIFICATION hxczzhxclayt0050.l

    Table 3: Projects and Payroll Layouts

    14

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    15/138

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

    EXCEPTION-CONFIRMATION CONFIRMATION hxczzhxclayt0026.ld

    Exception Export Timecard Layout EXCEPTION-EXPORT-LAYOUT EXPORT hxczzhxclayt0027.ldException Layout Timecard Notifica-tion Page

    EXCEPTION-NOTIFICATION NOTIFICATION hxczzhxclayt0046.ld

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

    EXCEPTION-HE-REVIEW REVIEW hxczzhxclayt0028.ld

    Exception OTLR Details NotificationLayout

    EXCEPTION-HE-NOTIFICATION NOTIFICATION hxczzhxclayt0045.ld

    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 Confirmation 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.ldPurchasing Review Timecard Layout   PURCHASING-REVIEW-TIMECARD   REVIEW pozzhxclayt0055.ldPurchasing Confirmation Timecard Layout PURCHASING-CONF-TIMECARD   CONFIRMATION pozzhxclayt0056.ldPurchasing Notification Timecard Layout PURCHASING-NOTIF-TIMECARD   NOTIFICATION pozzhxclayt0057.ld

    Table 6: Purchasing Layouts

    15

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    16/138

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

    Layout Name Layout Code Layout Type FilenameTimecard Layout   PROJECTS-PURCHASING-TIMECARD   TIMECARD pazzhxclayt0039.ldReview Timecard Layout   PROJECTS-PURCHASING-REVIEW   REVIEW pazzhxclayt0040.ldConfirmation Timecard Layout PROJECTS-PURCHASING-CONFIRM CONFIRMATION pazzhxclayt0041.ldAudit Entry Layout PA-PO-AUDIT AUDIT pazzhxclayt0042.ldCLA Review Layout PROJECTS-PURCHASING-CLA-REVIEW REVIEW pazzhxclayt0043.ldCLA Confirmation PA-PO-CLA-CONFIRM CONFIRMATION pazzhxclayt0044.ld

    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 Filename

    Payroll OTLR Details Confirma-tion Layout

    PAYROLL-HE-CONFIRMATION CONFIRMATION hxczzhxclayt0081.l

    Table 8: R12.1 Payroll Layouts

    16

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    17/138

    .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 Confirmation 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 Notification Layout - With

    Project & 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 Confirma-tion Layout - With Project & Taskdetails concatenated

    PROJECTS-DET-AUDIT-CONFIRM   CONFIRMATION hxczzhxclayt0092.ldt

    Projects Change and Late Audit No-tification 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/21/2019 Oracle OTL Timecard Layout Customication

    18/138

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

    PROJECTS-DET-ALT-TIMECARD   TIMECARD hxczzhxclayt009

    Projects and Payroll Review Layout - WithProject & Task details concatenated

    PROJECTS-DET-ALT-REVIEW   REVIEW hxczzhxclayt009

    Projects and Payroll Confirmation Layout - With

    Project & Task details concatenated

    PROJECTS-DET-AL-CONF CONFIRMATION hxczzhxclayt010

    Projects and Payroll Details Layout - WithProject & Task details concatenated

    PROJECTS-DET-ALT-DETAIL   DETAIL hxczzhxclayt009

    Projects and Payroll Export Layout - WithProject & Task details concatenated

    PROJPAY-DETAIL-EXPORT   EXPORT hxczzhxclayt009

    Projects and Payroll Notification Layout - With

    Project & Task details concatenated

    PROJECTS-DET-ALT-NOTIF NOTIFICATION hxczzhxclayt009

    Projects and Payroll Fragmented Timecard View

    - With Project & Task details concatenated

    PROJECTS-DET-ALT-FRAG   FRAGMENT hxczzhxclayt009

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

    PROJECTS-DET-ALT-AUD-LAYOUT   AUDIT hxczzhxclayt010

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

    PROJECTS-DET-ALT-CLA-REVIEW   REVIEW hxczzhxclayt010

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

    PROJECTS-DET-ALT-CLA-CONF   CONFIRMATION hxczzhxclayt010

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

    PROJECTS-DET-ALT-CLA-NOTIF   NOTIFICATION hxczzhxclayt010

    Entry Level Processing Projects - Payroll

    Timecard Layout - With Project & Task de-tails concatenated

    ELP-PROJ-DET-PAY-TIMECARD   TIMECARD hxczzhxclayt010

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

    ELP-PROJ-DET-PAY-REVIEW   REVIEW hxczzhxclayt010

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

    ELP-PROJ-DET-PAY-CONF   CONFIRMATION hxczzhxclayt011

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

    ELP-PROJ-DET-PAY-DETAIL   DETAIL hxczzhxclayt010

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

    concatenated

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

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

    ELP-PROJ-DET-PAY-NOTIF   NOTIFICATION hxczzhxclayt010

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

    18

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    19/138

    1.5 Using the OAF Personalization Functionality With Timecard Configuration

    n short, for any page rendered with the Oracle Time and Labor (OTL) timecard configuration utility, no UI components caPersonalized  using the standard Oracle Applications Framework (OAF) functionality. All changes to the page must be made viaOracle 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 bOTL timecard configuration utility, the pages rendered in the pop-up list of values windows are not. Thus, the OAF  Personalizaunctionality can be used to personalize those windows. For example, if the project id column in the Projects LOV pop-up shouidden, a customer should create a personalization at the desired level and hide that column. If the columns should be renameeordered, again, this should be done via the personalization framework delivered with the OAF.

    19

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    20/138

    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 functionaThis white paper describes this process in detail, and illustrates with examples of common modifications. The document co

    he majority of customizations, which are to the timecard header — the comments field, period list control and template con

    widgets — and timecard matrix — the time attributes and time entry fields. In summary, the minimal number of steps to confitimecard layout are:

    1. Use one of the seeded timecard layouts as a basis, or create a new timecard layout.

    2. You must rename the timecard layout.

    3. You configure the components of the timecard.

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

    NOTE: Do not use Web Application Dictionary or the OA Configuration Framework to configure the layoHowever, there are items on the OTL timecard pages such as the product branding and buttons which are outside the scope o

    onfigurable user interface. Thus use the personalization framework to modify to those user interface components, e.g. to change

    randing, or the labels on the buttons.

    2.1 What can be configured on a Timecard

    Figure 2: What can be Configured

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

    20

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    21/138

    2.2 The Layout File

    As previously mentioned, the timecard layout containing a set of user interface component, and associated qualifer descriptioneld in a simple text file. Use  FNDLOAD, the generic AOL loader utility, to upload the file data into the OTL Configur

    User Interface database tables. Read the AOL documentation, within the Oracle Applications release 11i   documentation, for m

    nformation on FNDLOAD. In common with all FNDLOAD compatible files, OTL delivers a configuration file, which definestructure of the layout files. This configuration file defines the entities, and entity attributes that are present within the file, wre in the form of name value pairs unless part of the developer key for the attribute. For example, the HXC LAYOUT entitywo keys, the layout name, and the application short name that owns the layout (at the moment this is only OTL) and thumber of attributes, such as the display layout name and the layout type. In OTL, each of the entities definied in the configurale maps to an OTL table, e.g. the HXC LAYOUTS entity maps to the HXC LAYOUTS table. Each of the entity keys, or ettributes in the loader file maps directly or via a key to columns in those entities. E.g. DISPLAY LAYOUT NAME maps toatabase column, DISPLAY LAYOUT NAME, while PARENT COMPONENT maps to the column PARENT COMPONENTs the parent component specifies a key attribute of an entity. The configuration file 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 Customization

    When creating a custom layout the easiest approach is to select one the delivered layouts, based on which is closest to your reqments, 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 aour custom layout being overwritten when OTL patches are applied to your environment. In order to rename the layout, you o 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"

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

    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 follow

    ommand 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,he 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 cant to a user, or groups of users as required.

    21

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    22/138

    2.5 Labels and Messages

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

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

    .5.1 Labels

    All labels in the OTL configurable UI are translatable and customizable via the AK Developer responsibility in Oracle ApplicatNew labels can also be created in AK and used within the configurable UI for customized timecards. AK data for our purpo

    efined as a region containing one or more region items. For OTL, the region is just a ’container’ for all of the prompts - to sexample of this you can review the region ’HXC CUI TIMECARD’ which contains most of the prompts for the timecard entry

    — see section 4. Each region item is based on an attribute, which are reusable, but for the purposes of OTL you will usually one-to-one mapping between region items and attributes. When creating region items there are many possible settings, but

    will only use a subset of these fields when querying labels - the ones used, and that should be set (other than mandatory fields ss 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 specifi

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

    .5.2 Messages

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

    2.6 Further Configuration Concepts

    f configuring more than just the simpliest aspects of the timecard, it may be necessary to utilize the ADF. Thus, some aspects oADF are described in the following sections, within the context of configuring the OTL timecard interface. Specially, the bus

    bjects (BC4J or JBO) layer — these are java objects that contain or are business data — affect timecard interface configuratiohe data used by the user interface components is dependent on those objects. View objects and Application Modules are two ousiness objects that require configuration. An excellent discussion on these objects, and the Applications Development FramewADF) 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. Ifequire 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 V

    Object to perform this query. Some customizations may be done using the Custom Choice List Components that OTL delivers. VObjects delivered by OTL should not be modified since these changes will be overwritten whenever a patch applied with chang

    he View Object is applied. View Objects can be developed using the wizard supplied with JDeveloper. Once created, the Bbjects should then be added to the classpath for the Apache/JServ server so they will be available for use within the OTL timecreen. Note: any custom View Objects should be contained in a custom Application Module (see below for additional informat

    22

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    23/138

    .6.2 Application Modules

    An Application Module is a BC4J object which can be considered a ’container’ for View Objects. Note: If you create yourustom View Objects then you should also create an Application Module to contain them. In order for the timecard page to funcroperly with custom view objects, the OTL configurable user interface code must instantiate the custom containing applica

    module before the custom view object from which to retrieve the appropriate business data. Thus, the configurable user intemust know the name of the custom application module. So when referencing a view object as part of the qualifiers for a user inter

    omponent, 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 ’Mywith 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 laymatches 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 chawill 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

    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 onceser has logged out and signed in again.

    2.7 Delivered Configurable BC4J Objects

    .7.1 Configurable Choice List Components

    To allow easy implementation of choice list components, OTL delivers a number of ’Configurable Choice Lists’. What this basimeans is that we deliver a View Object based on a configurable view, so rather than a customer having to use JDeveloper to cr

    heir own BC4J view objects and application module, they can just alter the definition of the underlying configurable view and dd 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)

    These names must be used in order that the configurable user interface can display the appopriate data in the choice list compon the timecard interface, but components will default the attributes that specify these to the same names, so they do not neee specified in the layout. The Value column is the value that will actually be submitted with the timecard - the contents o

    DisplayValue column does not need to be meaningful at all as far as the submit process is concerned (although for the benefit of any

    23

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    24/138

    View Object Name View Object Class Configurable View Name

    Custom1VO 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 flexibility both columns are delivered as type VARCHARf 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 nnto 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 statemo 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 forolumns so they match the expected names within the View Object.   Note: Given the nature of HTML all possible selections hoice list (both displayed text and the selection value) are part of the generated page. It is strongly advised that Choice Lists e used when the result set shown is not excessive, otherwise the size of the page can be large, which may slow down rendering

    f 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 V

    Object. This profile is called ’FND: View Object Max Fetch Size’ and is set to a default of 200. Without changing this profile opthis 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 patchan be run manually to create template views for testing, or alternatively you can copy and modify the script to contain your cuiew objects which can then be created by running the script. This script can be found under $HXC TOP/patch/115/sql/hxccuivw

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

    he data source — in the case of a normal choice list, the data is queried from a table or view via the associated View Objectpackage choice list the equivalent View Object is built from the result of a PL/SQL function call. The PL/SQL call should re

    he data to be shown in the choice in display value/value pairs (each separated by ’—’). The call be made with any of the suppookens — 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 compos defined like any other component. It uses a context called PACKAGE CHOICE LIST of the configurable user interface compon

    24

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    25/138

    ualifer flexfield. Attributes associated with this context, define the behaviour of this component, and tell the configurable nterface code how to call the package. In QUALIFIER ATTRIBUTE1 the package and function name to be called are specified

    QUALIFIER ATTRIBUTE2 contains the parameter list for the function. Parameters for the function call are bound by positiont is important to make sure the order they specified in the layout matches that of the function. Literal values may also be passhe parameter list - this could be used, for example, if you wanted to use the same function for a multiple components on the put be able to identify each of the components and have the code behave slightly differently for each. As an example, lets crea

    unction called ’test’ in the package ’my custom code’ that takes 3 parameters - the person id of the user, the timecard start nd 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 value shown in the choice list. This is the function supporting the choice list, and so this is just an example, obviously a config

    unction could perform any operation, as long as the return parameter meets the specification defined above.

    FUNCTION test

    (p resource id in varchar2

    ,p timecard start date in varchar2

    ,p mode flag in varchar2

    )

    RETURN varchar2

    IS--

    l resource id NUMBER;

    l start date DATE;

    l return value VARCHAR2(200);

    --

    BEGIN

    --

    -- convert parameters

    --

    l resource id := TO NUMBER(p resource id);

    l start date := fnd date.canonical to date(p timecard start date);

    --

    -- switch base on the mode flag and set return value based on it--

    IF (p mode flag = ’TEST’) THEN

    l return value := ’1|Test1|2|Test2|3|Test3’;

    ELSE

    l return value := ’10|Display1|20|Display2|30|Display3’;

    END IF;

    --

    -- return values

    25

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    26/138

    --

    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 pahe 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 ObThis profile 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 configured option on the timecard interface, because it drastically simplifies data eor users. For example, the expenditure type seeded alias allows users to pick one value, which is converted by the system intxpenditure type, hours (element) type and a system linkage function. Thus, the user is selecting one value, rather than three.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

    elf-Service functionality of OTL only the ’OTL Alternate Name DFF Context’ type of alternate names are supported. This typlternate name is based on the context definition attached to the ’OTL Alternate Names’ descriptive FlexField. In the contextonfigure 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 alter

    ame with the same set of values, but with different names. In order to uniquely identify them the identifier segment should be uFor this example, when the ELEMENTS EXPENDITURE SLF alternate name type is submit, the values that are deposited a

    ayroll 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. Perfa query based on the ’OTL Alternate Name DFF Context’ and your context as the type and then enter the mappingsrequire. For each segment of your context, you should link the correct mapping component that will be used when deposthe information into OTL.

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

    •   Next, your timecard layouts should be modified to include the custom alternate name component. These componentdelivered as VO definitions that are plugged into an LOV or choicelist component with some specific qualifiers set.

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

    BEGIN HXC LAYOUT COMPONENTS

    " My Timecard Layout - ExpType PriceType"

    OWNER = "ORACLE"

    26

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    27/138

    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 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 suppof these custom definitions and the VO names for each of these are:

    AlternateNameItem1VOAlternateNameItem2VOAlternateNameItem3VOAlternateNameItem4VOAlternateNameItem5VO

    27

  • 8/21/2019 Oracle OTL Timecard Layout Customication

    28/138

    QUALIFIER ATTRIBUTE3: For each of the custom alternate name view objects there is an LOV region delivered which referehem - 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 paramhould always be the type of alternate name, with the second being the timecard bind end date and the last the timecard bind sate.

    QUALIFIER ATTRIBUTE26, 27 and 28: These qualifiers contain values that tell the OTL deposit process how to handle tlternate name objects. In qualifier attribute26 the OTL ALIAS ITEM1 context is specified which is used to identify the alterame in the attribute structure - the actual context does not exist.

    2.8 LOVs and JRAD/MDS

    The Oracle Applications Self-Service framework now uses the MDS dictionary (aka JRAD) to store all definitions for Self Service pncluding LOVs. OTL supports custom LOVs, but at the current time there is no applications interface to create LOV objects in

    MDS data dictionary (other than using a tool such as JDeveloper to create the regions by hand). Consult the ADF documentaor 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 wwill allow you to migrate definitions from AK to MDS