Preface

Intended Audience

Welcome to Release 12.1 of the Oracle Configurator Extensions and Interface Object Developer’s Guide .

You can use Configurator Extensions to augment the functionality of your runtime Oracle Configurator beyond what is provided by Oracle Configurator Developer. You create Configurator Extension classes, which use the Configuration Interface Object (CIO) to perform various tasks, including accessing the Model, setting and getting logic states, and adding instantiable components. You can also use the CIO in your own applications, to interact with the Model.

This manual is intended primarily for software developers writing Configurator Extensions. The language required for developing Configurator Extensions is Java.

This manual assumes that you are an experienced Java programmer.

Note: Be sure to check Prerequisite Skills for Developing Configurator Extensions, which describes the Java development skills required for success with Configurator Extensions.

This manual also provides background on the CIO. This information is needed by developers of applications that have customized user interfaces that access the runtime Oracle Configurator.

See Related Information Sources for more Oracle E-Business Suite product information.

Deaf/Hard of Hearing Access to Oracle Support Services

To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Structure

1  Configurator Extension Basics

This chapter provides essential information about implementing Configurator Extensions, explains what Configurator Extensions are, and describes the different types available. It also explains the relationship of Configurator Extensions and the CIO.


2  Building Configurator Extensions

This chapter describes how to code and build Configurator Extensions, including suggestions for effective development practices and avoiding common mistakes.


3  Uses for Configurator Extensions

This chapter collects instructions on how to use Configurator Extensions for specific tasks, such as generating custom output and filtering for connectivity


4  CIO Basics

This chapter explains the basics of the Oracle Configuration Interface Object (CIO) and how to use it. For details about how to use the CIO for specific purposes, see other chapters in Part 2.


5  Working with Configurations

This chapter describes how to interact with runtime configuration objects.


6  Working with Model Entities

This chapter explains how to work with nodes of the runtime Model, such as Components and Features.


7  Using Logic Transactions

This chapter explains how to use logic transactions to safely structure a configuration session.


8  Validation, Contradictions, and Exceptions

This chapter explains how to validate configurations and handle contradictions.


9  Using Requests

This chapter describes requests, which are programmatic attempts to modify a configuration.


10  Configuration Session Change Tracking

This chapter describes the CIO’s Configuration Delta API for tracking changes that have been made to regions of your user interface during a configuration session.


11  Logging Through the CIO

This chapter describes how you can use the Oracle Applications Logging Framework with Oracle Configurator and the Oracle Configuration Interface Object to provide a convenient and uniform interface for logging their activity.


A  Reference Documentation for the CIO

This appendix explains how to access the reference documentation for the CIO, which is generated in Javadoc format.


B  Code Examples

This appendix contains code examples illustrating the use of Configurator Extensions and the CIO.


C  Java Parameter Types for Configurator Extensions

This appendix lists the Java classes that you can use for Configurator Extension method parameters when creating event bindings.


Common Glossary for Oracle Configurator

Related Information Sources

Important: There is new functionality available for the Runtime Oracle Configurator when using the Fusion Configurator Engine (FCE). The FCE is an alternative to the configuration engine described in this document. For all information about the FCE, see the Oracle Configurator Fusion Configurator Engine Guide.

For more information, see the following resources:

Integration Repository

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

Do Not Use Database Tools to Modify Oracle E-Business Suite Data

Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data Browser, database triggers, or any other tool to modify Oracle E-Business Suite data unless otherwise instructed.

Oracle provides powerful tools you can use to create, store, change, retrieve, and maintain information in an Oracle database. But if you use Oracle tools such as SQL*Plus to modify Oracle E-Business Suite data, you risk destroying the integrity of your data and you lose the ability to audit changes to your data.

Because Oracle E-Business Suite tables are interrelated, any change you make using an Oracle E-Business Suite form can update many tables at once. But when you modify Oracle E-Business Suite data using anything other than Oracle E-Business Suite, you may change a row in one table without making corresponding changes in related tables. If your tables get out of synchronization with each other, you risk retrieving erroneous information and you risk unpredictable results throughout Oracle E-Business Suite.

When you use Oracle E-Business Suite to modify your data, Oracle E-Business Suite automatically checks that your changes are valid. Oracle E-Business Suite also keeps track of who changes information. If you enter information into database tables using database tools, you may store invalid information. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes.