© 2009 oracle corporation – proprietary and confidential 1

<Insert Picture Here>

Extracting maximum value from latest Oracle Desktop Integration Framework (DIF) features

Sudhir Gupta Sr Consultant - Oracle Consulting

© 2009 Oracle Corporation – Proprietary and Confidential

Agenda

• Oracle Web ADI • Desktop Integration Framework Overview

• Integrator• Interface & Validation Rules• Content• Layout & Mapping• UI Components• Define Parameter

• Demo• Q&A• Implementation Overview• Additional Resources


Oracle Web ADI Overview -Recap

• Metadata Driven Framework which provides integration of Oracle Ebusiness suite with desktop applications – Generate documents of Microsoft Excel™ , Word™,Projects™ on the desktop

• Enables download of data from database, text files to desktop document• Enables upload of data to E-business suite (PL/SQL,Interface Tables)• Configurable layouts determine the appearance of the document to be created• Incorporation of LOV’s, Validation into spreadsheets but retain the familiarity of

Spreadsheet UI• Leverages Oracle E-business security model• Supports concurrent Manager to import data from Interface tables to Base tables


Oracle Web ADI In Use

• Today EBS consist of 150 plus Desktop Integration solution out-of-box across all product families• Growing Need for developing custom Integrator


Introducing Oracle E-business suite Desktop Integration FrameworkDesign Time Framework to develop desktop Integration solutions for Oracle E-business suite applications


Desktop Integration FrameworkArchitecture

Desktop Integration Framework

CRMCRMCRMCRM

FinancialsFinancialsFinancialsFinancials

HRMSHRMSHRMSHRMS

…………

SCMSCMSCMSCM

Design Time

Run Time

Integrator Interface Component Content Business Rules

ATGATGATGATG

Metadata Repository

Integrator Services

Oracle Web ADI


Desktop Integration FrameworkFeatures

• Create desktop integrators using wizard based UI• Define Integrator to upload data through PL/SQL API or directly

to Table• Define Integrator to download data from Text file or using SQL

Query• Define UI components

• Support for UI widgets to embed them in Excel (List of values, Pop lists, Date pickers, Flex fields )

• Define Layouts & Mappings for custom integrator• Leverages E-Business Suite Security Model• Consume Integrator as part of business flow• Define layout and mappings for custom integrator


Desktop Integration FrameworkBusiness Value

• Support for custom integrator definition through Desktop Integration framework

• Extensible Desktop Integration• Tighter Integration with Oracle E-business suite• Full Integration with Oracle E-business suite security model• Upgrade-Safe• Reduced Implementation time• Enhanced Productivity• Lower Cost of Ownership• Re-Utilize ADI components such as Parameters,LOV’s etc


Desktop Integration Framework Process flow

1010

Create Interface

Create Content

Define Integrator properties

To define custom desktop integrators

Define Mappings

Create Document

Define Layout


IntegratorDescription

• Integrator:• Encapsulates all information required to move data to/from a desktop

application into Oracle E-Business Suite. May include information about open interface tables, validation, business rules, and data that can be downloaded.

• Go to responsibility “Desktop Integration Manager” and choose “Manage Integrators” function to create/edit custom Integrators.

• User can Create, Update and Delete Integrators from Manage Integrators function. Note: Oracle seeded integrators cannot be updated or deleted.

• User can define Layout and Mappings for Integrator• User can Search Integrators by Name, Internal Name,

Application, Source and Enabled status


Integrator Screenshot


IntegratorDescription

• Wizard based UI to create Integrator

• Define Integrator related properties,parameters and function based security rules

• Note – Only Enabled Integrator will be available for use in the business flow

• Security Rules – • User can define function based security rules for integrator• End users


IntegratorDescription contd..

• Integrator Parameters• Depending upon Business needs user can define set of parameters that can be used by

integrator at run-time• Upload & Server Parameters : to define upload page displayed to end user and for back-end

service while uploading data to EBS• Importer Parameters : to define rules for importing data from interface tables to base tables• Documents Parameter:to define input values to be taken from end user while creating the

document• Session Parameters : to define values to be retained with the document for the session


IntegratorScreenshot


Interfaces in IntegratorDescription

• Interface: Definition of Table or PL/SQL API (Procedure, Function) used for uploading data into Oracle E-Business Suite

• User can Create, Update, Delete Interfaces

• Interface Attributes: Describe the columns/ parameters of Interface tables/ APIs and how data for these should be validated

• Interface Attributes are automatically generated for selected Interface

• User can add custom Interface Attribute

• User can set Interface Attribute properties:• Default Value of Type – Constant, SQL Query, Environment Variable,

Lookup, Parameter, Profile Option• Validation Rules – Table, Java, Group Validation and Flex Field• Display Text and other properties which determines whether Interface

Attribute is enabled, mandatory, displayed, used to retrieve error message


Interfaces in IntegratorScreenshot


Interfaces in IntegratorValidation• Table Validation

• Validate field against values in a column of table based on condition (during Upload)

• Retrieve List of Values by attaching Component (in Excel document)

• Java Validation• Provide List of Values for a field in document

• Validate field against complex business rules by extending java classes

• BneBaseSQL – SQL Java class contains all of the SQL queries required for LOV and upload validation

• BneUploadValidator- Validator Java class that contains all the business logic for Java validation

• BneAbstractListOfValues – Component Java class that contains all the business logic and setup information for generating list of values for Java page document (if used for Java Validated LOV)


Interfaces in IntegratorValidation Cont’d..• Group Validation

• Used to validate different interdependent fields as group or to validate a set of fields as a group at once

• Require user to indentify a parent field and multiple dependent fields

• Flexfield Validation• Key Flex field and Desc Flex field Validation and LOV retrieval

• Identify KFF Segments and Parent Key flex field.Associate KFF Structure code

• Identify DFF Context & Segments and Parent Desc flex field.Associate DFF Structure code

• Other data integrity validation during upload – data types,column width,not nulls, etc

• Pop-list (For offline users) and calendar are other validation provided in the document


Interfaces in IntegratorValidation Screenshot


Contents in IntegratorDescription

• Contents: • Definition of the data that can be downloaded from Text File, or SQL Query

into document

• Define Multiple Content for Integrator: • While creating document end-user can select a content to extract data• Seeded text content is available for integrator (cannot be deleted)

• Content Attributes: • Represent the column/ field that exists in Text File or SQL Content• Automatically generated.

• Content Parameters: • Represent any input values required for execution of SQL Query• While creating document, depending upon selected Content, end-user will be

prompted for these inputs


Contents in IntegratorScreenshots


Layouts & Mappings of IntegratorOverview - Recap

• Layout: • Describe the Interface Attributes/ columns that will be displayed in

desktop application document, and where they will be displayed (Context-Header/ Header/ Line)

• Use style-sheet to define format

• Define default values for columns (Constant, Environment Variable, Lookup, SQL)

• It is mandatory to define at least one Layout for an Interface

• Define custom look and feel & properties for the Desktop Document

• Mapping• Link the Content Attributes (that will be downloaded into document)

and Interface Attributes (into which the data will be uploaded)

• For Reporting Only Contents, you need not define Mapping. For rest of the Contents, it is mandatory to define Mapping.


Layouts & Mappings of IntegratorScreenshots


UI ComponentsDescription

• Component: Describes UI object that is used for validation of a field in document

• Manage Components function in Desktop Integration Manager responsibility

• User can create Component – Date Picker, Flex Field, List of Values based on Java or Table

• User can search Components by Name, Code and Application


UI ComponentsScreenshots


Define ParameterDescription

• UI to define different types of Integrator Parameters• Parameter List: Set of logically related Parameters• Parameter Definition: Describe the display options (text, style,

type), default values, validation types of the parameter• Parameter Attributes: Name-Value pairs that store additional

information. Used at run-time to implement complex business logic.

• User can create Parameter in a Parameter List, and edit its definition

• User can duplicate and test Parameter List


Define ParameterScreenshot


Desktop Integration FrameworkConsume Integrator

• Consume Integrator definition from OA Page,Forms,Self Service Menu/Function,Create document function in the Desktop Integration responsibility

• Use Oracle Web ADI’s Create Document wizard• It prompts end-user for Integrator,Viewer,Layout,Content,Mapping

and parameters(if any, based on selected integrator & content)

• Review page with all the selected values

• Define Document Creation shortcuts and directly generate document (without any web ADI prompts)


Desktop Integration FrameworkProcess flow

4242

1.Login as operations and choose responsibility “Desktop Integration Manager”.

2.By going to this responsibility you can create custom integrators.

Create Interface

Create Content

Define Integrator properties

To define custom desktop integrators

Define Mappings

Create Document

Define Layout


Desktop Integration Framework

DemoDemo


Question and Answers

Thank You


FAQs and Tips• 1.Desktop Integration framework is available above Release 12.1.2 onwards.• 2.Custom Table should be created in BNE schema.• 3.Public Synonym against this custom table must be created in APPS schema.• 4.Custom Table must be registered in BNE schema.• 5.While choosing the custom table, choose application “Web Applications Desktop

Integrator”• 6.While creating custom integrator(used for uploading data to database) use “HR Upload

Parameter List” as “Upload Parameter” in the “Integrator parameters” section• 7.And add function “Desktop Integration - Create Document” for any new integrator.• 8.For custom integrator with Text Content, assign parameter list "Web ADI: Download "Text

File" Parameters“.• 9.To clear BNE cache after any changes in custom integrator, pls use following URL• http://hostname/OA_HTML/BneAdminServlet and click on first “clear” link(and use browser

back button to go to application)• 10.while creating parameter names, pls assign application if it is specific to appln and name

it as unique as possible(or check name before creating new)


Additional Resources

• Document by Metalink: Oracle® E-Business Suite Desktop Integration Framework Developer's Guide/ Release 12.1 / Part No. E15877-01 / December 2009

• Above developer guide is available in http://support.oracle.com/

• Contact Email – [email protected]

46

© 2009 oracle corporation – proprietary and confidential 1

Documents

oracle corporation proprietary

desktop integration

desktop applications

desktop document

custom integrator slide

desktop integrators

ebusiness suite plsql

integrator properties