Oracle® E-Business SuiteDeveloper's GuideRelease 12.2Part No. E22961-10

November 2013

Oracle E-Business Suite Developer's Guide, Release 12.2

Part No. E22961-10

Copyright © 1995, 2013, Oracle and/or its affiliates. All rights reserved.

Primary Author:     Sara Woodhull, Mildred Wang

Contributing Author:     Santiago Bastidas, Eric Bing, Kevin Brown, George Buzsaki, Anne Carlson, Steven Carter, Robert Farrington, Paul Ferguson, Cliff Godwin, Kevin Hudson, Clara Jaeckel, Gustavo Jimenez, Taka Kamiya, Vinod Khatri, George Khoury, Robert Nix, Gursat Olgun, Lisa Parekh, Jan Smith, Susan Stratton, Leslie Studdard, Martin Taylor, Venkata Vengala, Peter Wallack, Aaron Weisberg, Maxine Zasowski

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

    iii

 Contents

Send Us Your Comments

Preface

1 Overview of Coding StandardsOverview of Coding Standards.................................................................................................1-1The Standard Development Environment................................................................................1-5Overview of Building an Oracle E-Business Suite Application............................................ 1-11

2 Setting Up Your Application FrameworkOverview of Setting Up Your Application Framework........................................................... 2-1

3 Preparing for Online PatchingIntroduction............................................................................................................................... 3-1Preparing the Environment....................................................................................................... 3-4Running the Readiness Reports................................................................................................3-5Running the Online Patching Database Standards Checker................................................... 3-6Running the Global Standards Compliance Checker (GSCC)................................................ 3-6

4 Preparation of Customizations in a Release 12.2 UpgradePreparation of Customizations in a Release 12.2 Upgrade.......................................................4-1

5 Handling Customizations in an Online Patching-Enabled EnvironmentIntroduction............................................................................................................................... 5-1Online Patching Considerations............................................................................................... 5-1

iv

Applying Customizations......................................................................................................... 5-4The Custom Synchronization Driver File.................................................................................5-4

6 Developer Guidelines for Customizations in an Online Patching-Enabled Environment

Overview................................................................................................................................... 6-1

7 Database Object Development Standards for Online PatchingIntroduction............................................................................................................................... 7-1Editioned Objects...................................................................................................................... 7-3Effectively-Editioned Objects................................................................................................. 7-10Non-Editioned Objects............................................................................................................7-31Example of Disabling Functionality During Online Patching.............................................. 7-37Blocking a Concurrent Program while Online Patching........................................................7-37Examples of SQL Replacements for PL/SQL Functions......................................................... 7-37Example of a Deferred Drop................................................................................................... 7-39

8 XML Definition File UtilitiesOverview................................................................................................................................... 8-1XDF Generation Utility............................................................................................................. 8-2XDF Comparison Utility ...........................................................................................................8-7

9 Building Database ObjectsOverview of Building Your Database Objects......................................................................... 9-1Using Cost-Based Optimization............................................................................................... 9-1Tracking Data Changes with Record History (WHO).............................................................. 9-1Oracle Declarative Constraints................................................................................................. 9-4LONG, LONG RAW and RAW Datatypes............................................................................... 9-6LONG to CLOB Conversion Procedures.................................................................................. 9-6Columns Using a Reserved Word............................................................................................. 9-8Views......................................................................................................................................... 9-8Sequences................................................................................................................................ 9-10Table Registration API............................................................................................................ 9-11

10 Using PL/SQL in Oracle E-Business SuiteOverview of Using PL/SQL in Oracle E-Business Suite........................................................ 10-1Replacements for Oracle Forms Built-ins............................................................................. 10-11Coding Item, Event and Table Handlers.............................................................................. 10-13

    v

11 Setting the Properties of Container ObjectsSetting the Properties of Container Objects........................................................................... 11-1Modules................................................................................................................................... 11-1Windows.................................................................................................................................. 11-2Canvases ................................................................................................................................. 11-5Blocks....................................................................................................................................... 11-6Regions ................................................................................................................................. 11-13

12 Setting the Properties of Widget ObjectsSetting the Properties of Widget Objects............................................................................... 12-1Text Items................................................................................................................................ 12-1

Date Fields......................................................................................................................... 12-2Display Items .......................................................................................................................... 12-3Poplists ....................................................................................................................................12-4Option Groups ........................................................................................................................ 12-5Check Boxes ............................................................................................................................ 12-5Buttons .................................................................................................................................... 12-5Lists of Values (LOVs) ........................................................................................................... 12-7

LOV Behaviors................................................................................................................... 12-8LOVs in ENTER-QUERY Mode....................................................................................... 12-10

Alerts ..................................................................................................................................... 12-10Editors ................................................................................................................................... 12-11Flexfields ...............................................................................................................................12-11Setting Item Properties.......................................................................................................... 12-11

Using APP_ITEM_PROPERTY.SET_PROPERTY............................................................ 12-11Item Properties with Unique Oracle E-Business Suite Behavior...................................... 12-12Impact of Item-level and Item-instance-level Settings .................................................... 12-16Setting Properties at Design Time.................................................................................... 12-16Setting Visual Attributes Programmatically.................................................................... 12-16

13 Controlling Window, Block, and Region BehaviorControlling Window Behavior................................................................................................13-1Positioning Windows Upon Opening.................................................................................... 13-1Closing Windows.................................................................................................................... 13-2Setting Window Titles Dynamically...................................................................................... 13-4Controlling Block Behavior.................................................................................................... 13-4Coding Master-Detail Relations............................................................................................. 13-4Coordination Between Windows............................................................................................ 13-5Implementing a Combination Block...................................................................................... 13-6

vi

Coding Tabbed Regions.......................................................................................................... 13-9Definitions......................................................................................................................... 13-9Tabbed Region Behavior.................................................................................................... 13-9Three Degrees of Coding Difficulty................................................................................. 13-10

Implementing Tabbed Regions............................................................................................ 13-11Creating the Layout in Forms Developer..............................................................................13-12Coding Your Tab Handler..................................................................................................... 13-13Tab Handler Logic................................................................................................................. 13-14WHEN-TAB-PAGE-CHANGED Logic................................................................................. 13-14WHEN-NEW-ITEM-INSTANCE Logic................................................................................ 13-18Handling Dynamic Tabs....................................................................................................... 13-19Other Code You May Need................................................................................................... 13-20Coding Alternative Region Behavior....................................................................................13-21

Alternative Regions......................................................................................................... 13-21Example: Coding an Alternative Region..........................................................................13-22

Controlling Records in a Window........................................................................................ 13-25Duplicating Records........................................................................................................ 13-25Renumbering All Records in a Window.......................................................................... 13-26

Passing Instructions to a Form.............................................................................................. 13-27

14 Enabling Query BehaviorOverview of Query Find......................................................................................................... 14-1

Raising Query Find on Form Startup ................................................................................ 14-1Implementing Row-LOV........................................................................................................ 14-1

Implementing Find Windows............................................................................................ 14-3

15 Coding Item BehaviorItem Relations..........................................................................................................................15-1

Dependent Items................................................................................................................ 15-2Conditionally Dependent Item.......................................................................................... 15-4Multiple Dependent Items................................................................................................. 15-5Two Master Items and One Dependent Item..................................................................... 15-6Cascading Dependence...................................................................................................... 15-7Mutually Exclusive Items...................................................................................................15-9Mutually Inclusive Items................................................................................................. 15-10Mutually Inclusive Items with Dependent Items.............................................................15-11Conditionally Mandatory Items.......................................................................................15-12

Defaults................................................................................................................................. 15-14Integrity Checking.................................................................................................................15-14

Uniqueness Check............................................................................................................15-14

    vii

Referential Integrity Check.............................................................................................. 15-15The Calendar ........................................................................................................................ 15-18

Advanced Calendar Options........................................................................................... 15-19Calendar Examples.......................................................................................................... 15-20

CALENDAR: Calendar Package........................................................................................... 15-21

16 Controlling the Toolbar and the Default MenuPulldown Menus and the Toolbar.......................................................................................... 16-1

Menu and Toolbar Entries................................................................................................. 16-1Save and Proceed............................................................................................................... 16-6Synchronizing.................................................................................................................... 16-7Application-Specific Entries: Special Menus...................................................................... 16-7Customizing Right-Mouse Menus (Popup Menus)........................................................... 16-8

APP_POPUP: Right-Mouse Menu Control...........................................................................16-10APP_POPUP.INSTANTIATE.......................................................................................... 16-10

APP_SPECIAL: Menu and Toolbar Control......................................................................... 16-11APP_SPECIAL.INSTANTIATE........................................................................................16-11APP_SPECIAL.ENABLE.................................................................................................. 16-13APP_SPECIAL.GET_CHECKBOX................................................................................... 16-14APP_SPECIAL.SET_CHECKBOX.................................................................................... 16-15

17 Menus and Function SecurityOverview of Menus and Function Security............................................................................ 17-1

Terms ................................................................................................................................ 17-2Forms and Subfunctions ................................................................................................... 17-3How Function Security Works .......................................................................................... 17-4Using Form Functions........................................................................................................ 17-5

Function Security Standards................................................................................................... 17-7General Function and Menu Standards............................................................................. 17-7Form Function Standards...................................................................................................17-8Subfunction Standards....................................................................................................... 17-9

Function Security Reports..................................................................................................... 17-10Function Security APIs for PL/SQL Procedures................................................................... 17-11

FND_FUNCTION.TEST...................................................................................................17-11FND_FUNCTION.QUERY.............................................................................................. 17-12FND_FUNCTION.EXECUTE...........................................................................................17-13FND_FUNCTION.USER_FUNCTION_NAME............................................................... 17-15FND_FUNCTION.CURRENT_FORM_FUNCTION........................................................17-15

Forms Window ..................................................................................................................... 17-16Forms Block..................................................................................................................... 17-16

viii

18 Message DictionaryOverview of Message Dictionary............................................................................................18-1

Major Features .................................................................................................................. 18-1Definitions .........................................................................................................................18-2

Implementing Message Dictionary........................................................................................ 18-3Create Your Message Directories....................................................................................... 18-3Define Your Messages ....................................................................................................... 18-3Create Your Message Files................................................................................................. 18-4Code Logic to Set Up Messages......................................................................................... 18-5Code Logic to Display Messages........................................................................................18-6

Message Dictionary APIs for PL/SQL Procedures..................................................................18-8FND_MESSAGE.CLEAR................................................................................................... 18-8FND_MESSAGE.DEBUG................................................................................................... 18-8FND_MESSAGE.ERASE.................................................................................................... 18-9FND_MESSAGE.ERROR................................................................................................... 18-9FND_MESSAGE.GET...................................................................................................... 18-10FND_MESSAGE.HINT.................................................................................................... 18-11FND_MESSAGE.QUESTION...........................................................................................18-11FND_MESSAGE.RETRIEVE............................................................................................ 18-13FND_MESSAGE.SET_NAME.......................................................................................... 18-13FND_MESSAGE.SET_STRING........................................................................................ 18-14FND_MESSAGE.SET_TOKEN.........................................................................................18-15FND_MESSAGE.SHOW.................................................................................................. 18-16FND_MESSAGE.WARN.................................................................................................. 18-17

Application Message Standards ...........................................................................................18-18Definitions .......................................................................................................................18-18Message Naming Standards............................................................................................ 18-19Message Numbering Standards....................................................................................... 18-20Message Type Standards................................................................................................. 18-22Message Description Standards....................................................................................... 18-24

Message Content Standards.................................................................................................. 18-25Message Token Standards................................................................................................18-25A Few General Guidelines for Writing Good Messages.................................................. 18-28When the User Needs to Get Help................................................................................... 18-29Complex Messages...........................................................................................................18-31Specific Types of Message Content.................................................................................. 18-31Message Writing Style..................................................................................................... 18-33Special Purpose Messages................................................................................................ 18-42

Messages Window................................................................................................................. 18-44

    ix

Messages Page....................................................................................................................... 18-46

19 User ProfilesOverview of User Profiles ...................................................................................................... 19-1

Definitions .........................................................................................................................19-1Defining New User Profile Options .................................................................................. 19-2Setting User Profile Option Values ................................................................................... 19-2Setting Your Personal User Profile .................................................................................... 19-3

Implementing User Profiles ................................................................................................... 19-3Predefined User Profile Options ....................................................................................... 19-4

FND_PROFILE: User Profile APIs ......................................................................................... 19-5FND_PROFILE.PUT.......................................................................................................... 19-6FND_PROFILE.GET...........................................................................................................19-6FND_PROFILE.VALUE..................................................................................................... 19-7

User Profile C Functions ........................................................................................................ 19-7afpoget............................................................................................................................... 19-7afpoput...............................................................................................................................19-8

Profiles Window...................................................................................................................... 19-8

20 FlexfieldsOverview of Flexfields ........................................................................................................... 20-1

Definitions .........................................................................................................................20-3Building a Flexfield into Your Application ....................................................................... 20-6Flexfields and Application Upgrades ................................................................................20-7

Implementing Key Flexfields .................................................................................................20-8Defining Key Flexfield Database Columns ....................................................................... 20-9Registering Your Key Flexfield Table.............................................................................. 20-12Registering Your Key Flexfield ....................................................................................... 20-12Add Your Flexfield to Your Forms.................................................................................. 20-13

Implementing Descriptive Flexfields .................................................................................. 20-13Planning for Reference Fields.......................................................................................... 20-13Defining Descriptive Flexfield Database Columns ......................................................... 20-14Adding a Descriptive Flexfield to a Table with Existing Data ........................................ 20-15Protected Descriptive Flexfields.......................................................................................20-15Registering Your Descriptive Flexfield Table ..................................................................20-16Registering Your Descriptive Flexfield ........................................................................... 20-16Add Your Flexfield to Your Forms.................................................................................. 20-16

Adding Flexfields to Your Forms.......................................................................................... 20-16Create Your Hidden Fields.............................................................................................. 20-17Create Your Displayed Fields.......................................................................................... 20-18

x

Create Your Flexfield Definition...................................................................................... 20-19Invoke Your Flexfield Definition from Several Event Triggers........................................ 20-19

Flexfield Definition Procedures............................................................................................20-20Key Flexfield Definition Syntax....................................................................................... 20-21Range (Type) Flexfield Definition Syntax........................................................................ 20-23Descriptive Flexfield Definition Syntax........................................................................... 20-24Flexfield Definition Arguments....................................................................................... 20-25Flexfield Definition Examples.......................................................................................... 20-42Updating Flexfield Definitions.........................................................................................20-44Update Key Flexfield Definition Syntax...........................................................................20-45Update Range (Type) Flexfield Definition Syntax........................................................... 20-47Update Descriptive Flexfield Definition Syntax...............................................................20-48Updating Flexfield Definition Example........................................................................... 20-49Using Key Flexfields in Find Windows............................................................................20-49Using Range Flexfields in Query Find Windows............................................................. 20-51

Troubleshooting Flexfields................................................................................................... 20-52Register Key Flexfields .........................................................................................................20-54Register Descriptive Flexfields ............................................................................................ 20-59

21 Overview of Concurrent ProcessingOverview of Concurrent Processing ...................................................................................... 21-1

Basic Application Development Needs .............................................................................21-1Major Features .................................................................................................................. 21-2Definitions .........................................................................................................................21-3

Overview of Designing Concurrent Programs ...................................................................... 21-6Submitting Concurrent Programs on the Client.............................................................. 21-11Using Concurrent Processing .......................................................................................... 21-12Automated Recovery for Concurrent Processing ............................................................21-13

Overview of Implementing Concurrent Processing ............................................................21-15Choosing Your Implementation ......................................................................................21-15

22 Defining Concurrent ProgramsDefining Concurrent Programs...............................................................................................22-1Concurrent Program Libraries Window ................................................................................ 22-4

23 Coding Oracle Tools Concurrent ProgramsOracle Tool Concurrent Programs.......................................................................................... 23-1

SQL*PLUS Programs......................................................................................................... 23-1PL/SQL Stored Procedures.................................................................................................23-2SQL*Loader........................................................................................................................23-3

    xi

Accepting Input Parameters For Oracle Tool Programs ................................................... 23-3Naming Your Oracle Tool Concurrent Program ............................................................... 23-4

24 Coding Oracle Reports Concurrent ProgramsOracle Reports ........................................................................................................................ 24-1

Concurrent Processing with Oracle Reports...................................................................... 24-1Oracle Reports Parameters.................................................................................................24-3Accessing User Exits and Profile Options.......................................................................... 24-4

User Exits Used in Oracle Reports.......................................................................................... 24-5FND SRWINIT / FND SRWEXIT....................................................................................... 24-5FND FLEXIDVAL / FND FLEXSQL................................................................................... 24-5

Using Dynamic Currency in Oracle Reports.......................................................................... 24-5FND FORMAT_CURRENCY User Exit............................................................................. 24-6

Example Report Using FND FORMAT_CURRENCY.......................................................... 24-10Sample Report Output..................................................................................................... 24-10Procedure for Sample Report........................................................................................... 24-11

Oracle Reports Troubleshooting...........................................................................................24-14Frequently Asked Questions............................................................................................24-15

25 Coding C and Pro*C Concurrent ProgramsCoding C and Pro*C Concurrent Programs............................................................................ 25-1

Pro*C Concurrent Programs ............................................................................................. 25-1Header Files Used With Concurrent Programs..................................................................25-7

Concurrent Processing Pro*C Utility Routines ......................................................................25-7

26 PL/SQL APIs for Concurrent ProcessingOverview................................................................................................................................. 26-1FND_CONC_GLOBAL Package............................................................................................. 26-1

FND_CONC_GLOBAL.REQUEST_DATA........................................................................ 26-1FND_CONC_GLOBAL.SET_REQ_GLOBALS................................................................... 26-2Example............................................................................................................................. 26-3

FND_CONCURRENT Package............................................................................................... 26-4FND_CONCURRENT.AF_COMMIT.................................................................................26-4FND_CONCURRENT.AF_ROLLBACK............................................................................ 26-4FND_CONCURRENT.GET_REQUEST_STATUS (Client or Server)................................. 26-5FND_CONCURRENT.WAIT_FOR_REQUEST (Client or Server)..................................... 26-8FND_CONCURRENT.SET_COMPLETION_STATUS (Server)......................................... 26-8

FND_FILE: PL/SQL File I/O.................................................................................................... 26-9FND_FILE.PUT.................................................................................................................. 26-9FND_FILE.PUT_LINE..................................................................................................... 26-10

xii

FND_FILE.NEW_LINE.................................................................................................... 26-10FND_FILE.PUT_NAMES................................................................................................. 26-11FND_FILE.CLOSE........................................................................................................... 26-11Error Handling.................................................................................................................26-12

FND_PROGRAM: Concurrent Program Loaders................................................................. 26-12FND_PROGRAM.MESSAGE........................................................................................... 26-13FND_PROGRAM.EXECUTABLE.................................................................................... 26-13FND_PROGRAM.DELETE_EXECUTABLE.....................................................................26-14FND_PROGRAM.REGISTER...........................................................................................26-15FND_PROGRAM.DELETE_PROGRAM..........................................................................26-17FND_PROGRAM.PARAMETER..................................................................................... 26-17FND_PROGRAM.DELETE_PARAMETER......................................................................26-19FND_PROGRAM.INCOMPATIBILITY........................................................................... 26-19FND_PROGRAM.DELETE_INCOMPATIBILITY............................................................26-20FND_PROGRAM.REQUEST_GROUP.............................................................................26-20FND_PROGRAM.DELETE_GROUP............................................................................... 26-21FND_PROGRAM.ADD_TO_GROUP.............................................................................. 26-21FND_PROGRAM.REMOVE_FROM_GROUP................................................................. 26-21FND_PROGRAM.PROGRAM_EXISTS............................................................................26-22FND_PROGRAM.PARAMETER_EXISTS........................................................................26-22FND_PROGRAM.INCOMPATIBILITY_EXISTS..............................................................26-23FND_PROGRAM.EXECUTABLE_EXISTS.......................................................................26-23FND_PROGRAM.REQUEST_GROUP_EXISTS............................................................... 26-23FND_PROGRAM.PROGRAM_IN_GROUP.................................................................... 26-24FND_PROGRAM.ENABLE_PROGRAM......................................................................... 26-24

FND_REQUEST Package...................................................................................................... 26-25FND_REQUEST.SET_OPTIONS (Client or Server)..........................................................26-25FND_REQUEST.SET_REPEAT_OPTIONS (Client or Server)..........................................26-26FND_REQUEST.SET_PRINT_OPTIONS (Client or Server).............................................26-27FND_REQUEST.SUBMIT_REQUEST (Client or Server)..................................................26-28FND_REQUEST.ADD_NOTIFICATION (Client or Server).............................................26-29FND_REQUEST.SET_MODE (Server)............................................................................. 26-29Example Request Submissions.........................................................................................26-31

FND_REQUEST_INFO and Multiple Language Support (MLS)........................................ 26-33FND_REQUEST_INFO.GET_PARAM_NUMBER........................................................... 26-34FND_REQUEST_INFO.GET_PARAM_INFO.................................................................. 26-34FND_REQUEST_INFO.GET_PROGRAM........................................................................26-34FND_REQUEST_INFO.GET_PARAMETER.................................................................... 26-35Example MLS Function.................................................................................................... 26-35

FND_SET: Request Set Loaders............................................................................................ 26-36FND_SET.MESSAGE....................................................................................................... 26-37

    xiii

FND_SET.CREATE_SET.................................................................................................. 26-37FND_SET.DELETE_SET...................................................................................................26-38FND_SET.ADD_PROGRAM........................................................................................... 26-38FND_SET.REMOVE_PROGRAM.................................................................................... 26-39FND_SET.PROGRAM_PARAMETER............................................................................. 26-40FND_SET.DELETE_PROGRAM_PARAMETER..............................................................26-41FND_SET.ADD_STAGE.................................................................................................. 26-42FND_SET.REMOVE_STAGE........................................................................................... 26-43FND_SET.LINK_STAGES................................................................................................ 26-43FND_SET.INCOMPATIBILITY........................................................................................26-44FND_SET.DELETE_INCOMPATIBILITY........................................................................ 26-45FND_SET.ADD_SET_TO_GROUP.................................................................................. 26-46FND_SET.REMOVE_SET_FROM_GROUP..................................................................... 26-46

FND_SUBMIT: Request Set Submission............................................................................. 26-46FND_SUBMIT.SET_MODE..............................................................................................26-47FND_SUBMIT.SET_REL_CLASS_OPTIONS................................................................... 26-47FND_SUBMIT.SET_REPEAT_OPTIONS......................................................................... 26-48FND_SUBMIT_SET.REQUEST_SET................................................................................ 26-48FND_SUBMIT.SET_PRINT_OPTIONS............................................................................ 26-49FND_SUBMIT.ADD_PRINTER....................................................................................... 26-49FND_SUBMIT.ADD_NOTIFICATION............................................................................ 26-50FND_SUBMIT.SET_NLS_OPTIONS................................................................................ 26-50FND_SUBMIT.SUBMIT_PROGRAM...............................................................................26-50FND_SUBMIT.SUBMIT_SET........................................................................................... 26-51Examples of Request Set Submission............................................................................... 26-52

27 Standard Request SubmissionOverview of Standard Request Submission ..........................................................................27-1

Basic Application Development Needs .............................................................................27-1Major Features .................................................................................................................. 27-2Definitions .........................................................................................................................27-4Controlling Access to Your Reports and Programs ...........................................................27-5

Implementing Standard Request Submission ...................................................................... 27-5Developing Reports for Standard Request Submission .................................................... 27-5Defining Parameter Validation ......................................................................................... 27-6Defining Your Report or Other Program .......................................................................... 27-7Cross-application Reporting ............................................................................................. 27-8

28 Request SetsOverview of Request Sets....................................................................................................... 28-1

xiv

Stage Functions.................................................................................................................. 28-1

29 Logging Framework OverviewOverview................................................................................................................................. 29-1Target Audience...................................................................................................................... 29-1Key Features............................................................................................................................ 29-1Terminology............................................................................................................................ 29-2Logging Configuration Parameters.........................................................................................29-4

Overview........................................................................................................................... 29-4AFLOG_ENABLED........................................................................................................... 29-5AFLOG_LEVEL................................................................................................................. 29-6AFLOG_MODULE.............................................................................................................29-8AFLOG_FILENAME.......................................................................................................... 29-9AFLOG_ECHO.................................................................................................................. 29-9

30 Logging Guidelines for DevelopersOverview................................................................................................................................. 30-1APIs.......................................................................................................................................... 30-1Handling Errors....................................................................................................................... 30-2Performance Standards........................................................................................................... 30-2Module Source.........................................................................................................................30-3

Module Name Standards................................................................................................... 30-6Module Name Examples.................................................................................................... 30-7

Severities................................................................................................................................. 30-7Large Text and Binary Message Attachments.........................................................................30-9Automatic Logging and Alerting for Seeded Message Dictionary Messages..................... 30-11General Logging Tips............................................................................................................ 30-11How to Log from Java............................................................................................................ 30-11How to Log from PL/SQL...................................................................................................... 30-17How to Log from C................................................................................................................ 30-18How to Log in Concurrent Programs.................................................................................... 30-19How to Raise System Alerts.................................................................................................. 30-20

31 The Template FormOverview of the TEMPLATE Form......................................................................................... 31-1Libraries in the TEMPLATE Form.......................................................................................... 31-2Special Triggers in the TEMPLATE form............................................................................... 31-4

Triggers That Often Require Some Modification............................................................... 31-6Triggers That Cannot Be Modified.....................................................................................31-9

    xv

32 AttachmentsOverview of Attachments....................................................................................................... 32-1

Definitions......................................................................................................................... 32-1How Attachments Work.................................................................................................... 32-3Attachments for Forms or Form Functions........................................................................ 32-5Attachments and Reports...................................................................................................32-6

Planning and Defining the Attachments Feature................................................................... 32-6Planning to Add the Attachments Feature to Your Application........................................ 32-6Setting Up the Attachments Feature for Your Form.......................................................... 32-7

Document Entities Window ................................................................................................... 32-8Document Entities Block.................................................................................................... 32-9

Document Categories Window ............................................................................................ 32-10Document Categories Block............................................................................................. 32-10Category Assignments Window...................................................................................... 32-11

Attachment Functions Window ........................................................................................... 32-12Attachment Functions Block............................................................................................ 32-13Categories Window......................................................................................................... 32-14Block Declaration Window ............................................................................................. 32-15Entity Declaration Window............................................................................................. 32-17

33 Handling DatesOverview................................................................................................................................. 33-1Year 2000 Compliance in Oracle E-Business Suite ................................................................ 33-1Dates in Oracle E-Business Suite............................................................................................ 33-2Date Coding Standards........................................................................................................... 33-5

Using Dates While Developing Application Forms........................................................... 33-6Troubleshooting...................................................................................................................... 33-8

Use the DATECHECK Script to Identify Issues................................................................. 33-8Problems Observed During Testing...................................................................................33-9Date Checklist.................................................................................................................... 33-9

34 Customization StandardsOverview of Customizing Oracle E-Business Suite............................................................... 34-1

Basic Business Needs ........................................................................................................ 34-2Definitions .........................................................................................................................34-2Determining Your Needs .................................................................................................. 34-4

Customization By Extension .................................................................................................. 34-5Defining Your Custom Application .................................................................................. 34-6Adding a Form .................................................................................................................. 34-7

xvi

Adding a Report or Concurrent Program ......................................................................... 34-7Adding a New Report Submission Form .......................................................................... 34-7Adding Online Help.......................................................................................................... 34-8Adding Menus .................................................................................................................. 34-8Adding Responsibilities .................................................................................................... 34-8Adding Message Dictionary Messages ............................................................................. 34-8Defining a Custom PRODUCT_TOP................................................................................. 34-9

Customization By Modification ............................................................................................. 34-9Modifying an Existing Form ........................................................................................... 34-11Modifying an Existing Report ......................................................................................... 34-13Modifying an Existing C Program .................................................................................. 34-15Modifying an Existing PL/SQL Stored Procedure ...........................................................34-15Modifying Existing Online Help...................................................................................... 34-15Modifying Existing Message Dictionary Messages ......................................................... 34-15Modifying Existing Menus and Responsibilities .............................................................34-16

Oracle E-Business Suite Database Customization .............................................................. 34-16Oracle E-Business Suite Upgrades and Patches................................................................... 34-18Building Online Help for Custom Applications ................................................................. 34-20

How the Help System Works .......................................................................................... 34-20Prepare Your Forms......................................................................................................... 34-21Create HTML Help Files.................................................................................................. 34-21Create a Help Navigation Tree........................................................................................ 34-22Upgrades and Patches......................................................................................................34-22

Integrating Custom Objects and Schemas............................................................................34-22Upgrading Custom Forms..................................................................................................... 34-24

35 Using the Custom LibraryCustomizing Oracle E-Business Suite with the CUSTOM Library....................................... 35-1

Writing Code for the CUSTOM Library.............................................................................35-1Events Passed to the CUSTOM Library............................................................................. 35-4When to Use the CUSTOM Library................................................................................... 35-5Coding Zoom..................................................................................................................... 35-5Coding Generic Form Events............................................................................................. 35-8Coding Product-Specific Events.......................................................................................35-10Support and Upgrading................................................................................................... 35-10

Product-Specific Events in Oracle Application Object Library........................................... 35-11WHEN-LOGON-CHANGED Event................................................................................ 35-11WHEN-RESPONSIBILITY-CHANGED Event.................................................................35-11

CUSTOM Package................................................................................................................. 35-12CUSTOM.ZOOM_AVAILABLE...................................................................................... 35-12

    xvii

CUSTOM.STYLE.............................................................................................................. 35-13CUSTOM.EVENT............................................................................................................ 35-14

Example of Implementing Zoom Using the CUSTOM Library...........................................35-15Modify the Form.............................................................................................................. 35-16Modify the CUSTOM Library.......................................................................................... 35-16

36 APPCORE Routine APIsIntroduction to APPCORE Routine APIs............................................................................... 36-1APP_COMBO: Combination Block API................................................................................. 36-2

APP_COMBO.KEY_PREV_ITEM...................................................................................... 36-2APP_DATE and FND_DATE: Date Conversion APIs ........................................................... 36-2

APP_DATE.CANONICAL_TO_DATE and FND_DATE.CANONICAL_TO_DATE........36-5APP_DATE.DISPLAYDATE_TO_DATE and FND_DATE.DISPLAYDATE_TO_DATE........................................................................................................................................... 36-6APP_DATE.DISPLAYDT_TO_DATE and FND_DATE.DISPLAYDT_TO_DATE.............36-6APP_DATE.DATE_TO_CANONICAL and FND_DATE.DATE_TO_CANONICAL........36-7APP_DATE.DATE_TO_DISPLAYDATE and FND_DATE.DATE_TO_DISPLAYDATE........................................................................................................................................... 36-8APP_DATE.DATE_TO_DISPLAYDT and FND_DATE.DATE_TO_DISPLAYDT.............36-8APP_DATE.DATE_TO_FIELD.......................................................................................... 36-9APP_DATE.FIELD_TO_DATE........................................................................................ 36-10APP_DATE.VALIDATE_CHARDATE............................................................................ 36-11APP_DATE.VALIDATE_CHARDT................................................................................. 36-12FND_DATE.STRING_TO_DATE.....................................................................................36-13FND_DATE.STRING_TO_CANONICAL........................................................................36-14

APP_EXCEPTION: Exception Processing APIs.................................................................... 36-14APP_EXCEPTION.RAISE_EXCEPTION......................................................................... 36-14APP_EXCEPTION.RETRIEVE......................................................................................... 36-14APP_EXCEPTION.GET_TYPE.........................................................................................36-15APP_EXCEPTION.GET_CODE....................................................................................... 36-15APP_EXCEPTION.GET_TEXT.........................................................................................36-15APP_EXCEPTION.RECORD_LOCK_EXCEPTION......................................................... 36-15APP_EXCEPTION.RECORD_LOCK_ERROR................................................................. 36-15APP_EXCEPTION.DISABLED........................................................................................ 36-16

APP_FIELD: Item Relationship Utilities ............................................................................. 36-16APP_FIELD.CLEAR_FIELDS...........................................................................................36-16APP_FIELD.CLEAR_DEPENDENT_FIELDS.................................................................. 36-17APP_FIELD.SET_DEPENDENT_FIELD.......................................................................... 36-17APP_FIELD.SET_EXCLUSIVE_FIELD.............................................................................36-18APP_FIELD.SET_INCLUSIVE_FIELD............................................................................. 36-19APP_FIELD.SET_REQUIRED_FIELD.............................................................................. 36-19

xviii

APP_FIND: Query-Find Utilities.......................................................................................... 36-20APP_FIND.NEW..............................................................................................................36-20APP_FIND.CLEAR.......................................................................................................... 36-21APP_FIND.CLEAR_DETAIL........................................................................................... 36-21APP_FIND.FIND............................................................................................................. 36-21APP_FIND.QUERY_RANGE........................................................................................... 36-21APP_FIND.QUERY_FIND............................................................................................... 36-22

APP_ITEM: Individual Item Utilities................................................................................... 36-22APP_ITEM.COPY_DATE.................................................................................................36-22APP_ITEM.IS_VALID...................................................................................................... 36-23APP_ITEM.SIZE_WIDGET.............................................................................................. 36-23

APP_ITEM_PROPERTY: Property Utilities......................................................................... 36-23APP_ITEM_PROPERTY.GET_PROPERTY...................................................................... 36-24APP_ITEM_PROPERTY.SET_PROPERTY....................................................................... 36-24APP_ITEM_PROPERTY.SET_VISUAL_ATTRIBUTE ..................................................... 36-25

APP_NAVIGATE: Open a Form Function............................................................................36-25APP_NAVIGATE.EXECUTE........................................................................................... 36-25

APP_RECORD: Record Utilities........................................................................................... 36-28APP_RECORD.TOUCH_RECORD.................................................................................. 36-28APP_RECORD.HIGHLIGHT........................................................................................... 36-28APP_RECORD.FOR_ALL_RECORDS............................................................................. 36-29APP_RECORD.DELETE_ROW........................................................................................ 36-29APP_RECORD.VALIDATE_RANGE.............................................................................. 36-30

APP_REGION: Region Utilities............................................................................................36-31APP_REGION.ALT_REGION..........................................................................................36-31

APP_STANDARD Package...................................................................................................36-32APP_STANDARD.APP_VALIDATE............................................................................... 36-32APP_STANDARD.EVENT.............................................................................................. 36-32APP_STANDARD.SYNCHRONIZE................................................................................ 36-32APP_STANDARD.PLATFORM.......................................................................................36-33

APP_WINDOW: Window Utilities ...................................................................................... 36-33APP_WINDOW.CLOSE_FIRST_WINDOW.................................................................... 36-33APP_WINDOW.PROGRESS............................................................................................ 36-33APP_WINDOW.SET_COORDINATION.........................................................................36-34APP_WINDOW.SET_WINDOW_POSITION.................................................................. 36-34APP_WINDOW.SET_TITLE............................................................................................ 36-35

37 FNDSQF Routine APIsIntroduction to FNDSQF Routine APIs..................................................................................37-1FND_CURRENCY: Dynamic Currency APIs......................................................................... 37-1

    xix

FND_CURRENCY.GET_FORMAT_MASK (Client or Server)........................................... 37-2Currency Examples............................................................................................................ 37-2

FND_DATE: Date Conversion APIs....................................................................................... 37-3FND_GLOBAL: WHO Column Maintenance and Database Initialization...........................37-3

FND_GLOBAL.USER_ID (Server)..................................................................................... 37-3FND_GLOBAL.APPS_INITIALIZE (Server)......................................................................37-4FND_GLOBAL.LOGIN_ID (Server).................................................................................. 37-4FND_GLOBAL.CONC_LOGIN_ID (Server)......................................................................37-5FND_GLOBAL.PROG_APPL_ID (Server)......................................................................... 37-5FND_GLOBAL.CONC_PROGRAM_ID (Server)............................................................... 37-5FND_GLOBAL.CONC_REQUEST_ID (Server)................................................................. 37-5

FND_ORG: Organization APIs .............................................................................................. 37-5FND_ORG.CHANGE_LOCAL_ORG................................................................................ 37-5FND_ORG.CHANGE_GLOBAL_ORG.............................................................................. 37-5FND_ORG.CHOOSE_ORG................................................................................................37-6

FND_STANDARD: Standard APIs ........................................................................................37-6FND_STANDARD.FORM_INFO.......................................................................................37-6FND_STANDARD.SET_WHO...........................................................................................37-6FND_STANDARD.SYSTEM_DATE.................................................................................. 37-7FND_STANDARD.USER................................................................................................... 37-7

FND_UTILITIES: Utility Routines ........................................................................................ 37-7FND_UTILITIES.OPEN_URL............................................................................................ 37-7FND_UTILITIES.PARAM_EXISTS.................................................................................... 37-8

APIs for Attachments.............................................................................................................. 37-8FND_DOCUMENTS_PKG APIs........................................................................................ 37-8FND_ATTACHED_DOCUMENTS_PKG APIs................................................................37-16FND_ATTACHED_DOCUMENTS2_PKG APIs.............................................................. 37-23

38 Naming StandardsOverview of Naming Standards ............................................................................................ 38-1Naming Standards and Definitions........................................................................................ 38-1

Database Objects................................................................................................................ 38-1Form Objects...................................................................................................................... 38-5File Standards.................................................................................................................... 38-8PL/SQL Packages, Procedures and Source Files.................................................................38-9Reserved Words............................................................................................................... 38-10

A Additional FeaturesApplication Utilities Lookups and Oracle Application Object Library Lookups...................A-1Tables........................................................................................................................................ A-5

xx

Sequences................................................................................................................................ A-11Views....................................................................................................................................... A-12Flexfields Test Form................................................................................................................A-12

B SQL Trace OptionsSQL Trace Options.................................................................................................................... B-1

C Java Code Changes for Release 12.2Upgrading Java Code for the Release 12.2 Technology Components..................................... C-1

Index

    xxi

 Send Us Your Comments

Oracle E-Business Suite Developer's Guide, Release 12.2Part No. E22961-10

Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document. Your feedback is important, and helps us to best meet your needs as a user of our products. For example:

• Are the implementation steps correct and complete? • Did you understand the context of the procedures? • Did you find any errors in the information? • Does the structure of the information help you with your tasks? • Do you need different information or graphics? If so, where, and in what format? • Are the examples correct? Do you need more examples?

If you find any errors or have any other suggestions for improvement, then please tell us your name, the name of the company who has licensed our products, the title and part number of the documentation andthe chapter, section, and page number (if available).

Note: Before sending us your comments, you might like to check that you have the latest version of the document and if any concerns are already addressed. To do this, access the new Oracle E-Business Suite Release Online Documentation CD available on My Oracle Support and www.oracle.com. It contains the most current Documentation Library plus all documents revised or released recently.

Send your comments to us using the electronic mail address: appsdoc_us@oracle.com

Please give your name, address, electronic mail address, and telephone number (optional).

If you need assistance with Oracle software, then please contact your support representative or Oracle Support Services.

If you require training or instruction in using Oracle software, then please contact your Oracle local officeand inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at www.oracle.com.

    xxiii

 Preface

Intended AudienceWelcome to Release 12.2 of the Oracle E-Business Suite Developer's Guide.

This guide is written for the application developer and assumes you have a working knowledge of the following:

• Oracle Forms Developer. If you have never used Oracle Forms Developer, we suggest you attend one or more of the relevant training classes available through Oracle University.

• PL/SQL and the Oracle database. If you have never used Oracle10g or PL/SQL, we suggest you attend one or more of the relevant training classes available through Oracle University.

• The Oracle E-Business Suite graphical user interface for Oracle Forms-based products. To learn more about the Oracle E-Business Suite graphical user interface, read the Oracle E-Business Suite User's Guide.

Note: This book typically uses UNIX nomenclature in specifying files and directories. Windows users should substitute the appropriate Windows terms where applicable.

In addition, this guide assumes you have a working knowledge of the following:

• The principles and customary practices of your business area.

• Computer desktop application usage and terminology.

If you have never used Oracle E-Business Suite, we suggest you attend one or more of the Oracle E-Business Suite training classes available through Oracle University.

See Related Information Sources on page xxv for more Oracle E-Business Suite product

xxiv

information.

Documentation AccessibilityFor information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle SupportOracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Structure1  Overview of Coding Standards2  Setting Up Your Application Framework3  Preparing for Online Patching4  Preparation of Customizations in a Release 12.2 Upgrade5  Handling Customizations in an Online Patching-Enabled Environment6  Developer Guidelines for Customizations in an Online Patching-Enabled Environment7  Database Object Development Standards for Online Patching8  XML Definition File Utilities9  Building Database Objects10  Using PL/SQL in Oracle E-Business Suite11  Setting the Properties of Container Objects12  Setting the Properties of Widget Objects13  Controlling Window, Block, and Region Behavior14  Enabling Query Behavior15  Coding Item Behavior16  Controlling the Toolbar and the Default Menu17  Menus and Function Security18  Message Dictionary19  User Profiles20  Flexfields21  Overview of Concurrent Processing22  Defining Concurrent Programs23  Coding Oracle Tools Concurrent Programs24  Coding Oracle Reports Concurrent Programs25  Coding C and Pro*C Concurrent Programs26  PL/SQL APIs for Concurrent Processing27  Standard Request Submission28  Request Sets29  Logging Framework Overview30  Logging Guidelines for Developers31  The Template Form32  Attachments

    xxv

33  Handling Dates34  Customization Standards35  Using the Custom Library36  APPCORE Routine APIs37  FNDSQF Routine APIs38  Naming StandardsA  Additional FeaturesB  SQL Trace OptionsC  Java Code Changes for Release 12.2

Related Information SourcesThis book is included in the Oracle E-Business Suite Documentation Library, which is supplied in the Release 12.2 Media Pack. If this guide refers you to other Oracle E-Business Suite documentation, use only the latest Release 12.2 versions of those guides.

Online Documentation

All Oracle E-Business Suite documentation is available online (HTML or PDF).

• Online Help - Online help patches (HTML) are available on My Oracle Support.

• PDF Documentation - See the Oracle E-Business Suite Documentation Library for current PDF documentation for your product with each release.

• Release Notes - For information about changes in this release, including new features, known issues, and other details, see the release notes for the relevant product, available on My Oracle Support.

• Oracle Electronic Technical Reference Manual - The Oracle Electronic Technical Reference Manual (eTRM) contains database diagrams and a detailed description ofdatabase tables, forms, reports, and programs for each Oracle E-Business Suite product. This information helps you convert data from your existing applications and integrate Oracle E-Business Suite data with non-Oracle applications, and write custom reports for Oracle E-Business Suite products. The Oracle eTRM is available on My Oracle Support.

Related Guides

You should have the following related books on hand. Depending on the requirements of your particular installation, you may also need additional manuals or guides.

Oracle Diagnostics Framework User's Guide

This manual contains information on implementing and administering diagnostics tests for Oracle E-Business Suite using the Oracle Diagnostics Framework.

Oracle E-Business Suite Concepts

This book is intended for all those planning to deploy Oracle E-Business Suite Release 12.2, or contemplating significant changes to a configuration. After describing the

xxvi

Oracle E-Business Suite architecture and technology stack, it focuses on strategic topics, giving a broad outline of the actions needed to achieve a particular goal, plus the installation and configuration choices that may be available.

Oracle E-Business Suite Flexfields Guide

This guide provides flexfields planning, setup, and reference information for the Oracle E-Business Suite implementation team, as well as for users responsible for the ongoing maintenance of Oracle E-Business Suite product data. This guide also provides information on creating custom reports on flexfields data.

Oracle E-Business Suite Installation Guide: Using Rapid Install

This book is intended for use by anyone who is responsible for installing or upgrading Oracle E-Business Suite. It provides instructions for running Rapid Install either to carryout a fresh installation of Oracle E-Business Suite Release 12.2, or as part of an upgrade to Release 12.2.

Oracle E-Business Suite Maintenance Guide

This guide explains how to patch an Oracle E-Business Suite system, describing the adop patching utility and providing guidelines and tips for performing typical patchingoperations. It also describes maintenance strategies and tools that can help keep a system running smoothly.

Oracle E-Business Suite Security Guide

This guide contains information on a comprehensive range of security-related topics, including access control, user management, function security, data security, and auditing. It also describes how Oracle E-Business Suite can be integrated into a single sign-on environment.

Oracle E-Business Suite Setup Guide

This guide contains information on system configuration tasks that are carried out either after installation or whenever there is a significant change to the system. The activities described include defining concurrent programs and managers, enabling Oracle Applications Manager features, and setting up printers and online help.

Oracle E-Business Suite User's Guide

This guide explains how to navigate, enter and query data, and run concurrent requestsusing the user interface (UI) of Oracle E-Business Suite. This guide also includes information on setting user profiles and customizing the UI.

Oracle E-Business Suite User Interface Standards for Forms-Based Products

This guide contains the user interface (UI) standards followed by the Oracle E-Business Suite development staff. It describes the UI for the Oracle E-Business Suite products andhow to apply this UI to the design of an application built by using Oracle Forms.

Oracle Workflow Administrator's Guide

This guide explains how to complete the setup steps necessary for any product that includes workflow-enabled processes. It also describes how to manage workflow

    xxvii

processes and business events using Oracle Applications Manager, how to monitor the progress of runtime workflow processes, and how to administer notifications sent to workflow users.

Oracle Workflow Developer's Guide

This guide explains how to define new workflow business processes and customize existing Oracle E-Business Suite-embedded workflow processes. It also describes how to define and customize business events and event subscriptions.

Oracle Workflow User's Guide

This guide describes how users can view and respond to workflow notifications and monitor the progress of their workflow processes.

Oracle Workflow API Reference

This guide describes the APIs provided for developers and administrators to access Oracle Workflow.

Oracle Workflow Client Installation Guide

This guide describes how to install the Oracle Workflow Builder and Oracle XML Gateway Message Designer client components for Oracle E-Business Suite.

Integration RepositoryThe Oracle Integration Repository is a compilation of information about the service endpoints exposed by the Oracle E-Business Suite of applications. It provides a complete catalog of Oracle E-Business Suite's business service interfaces. The tool lets users easily discover and deploy the appropriate business service interface for integration with any system, application, or business partner.

The Oracle Integration Repository is shipped as part of the E-Business Suite. As your instance is patched, the repository is automatically updated with content appropriate for the precise revisions of interfaces in your environment.