Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction to Oracle ADF Desktop Integration

• 1.1 About the Oracle ADF Desktop Integration Module
• 1.2 About Oracle ADF Desktop Integration with Microsoft Excel
  • 1.2.1 Overview of Creating an Integrated Excel Workbook
  • 1.2.2 The Advantages of Integrating Excel with a Fusion Web Application

2 Introduction to the Oracle ADF Desktop Integration Sample Application

• 2.1 Introduction to the Master Price List Module
• 2.2 Setting Up and Executing the Master Price List Module
• 2.3 Overview of the Integrated Excel Workbooks in the Master Price List Module
  • 2.3.1 Log on to the Fusion Web Application from an Integrated Excel Workbook
  • 2.3.2 Download Rows of Data About Product Pricing
  • 2.3.3 Simple Search for Products in the Workbooks
  • 2.3.4 Advanced Search for Products in the Edit Price List Workbook
  • 2.3.5 Modify Product Pricing Information in the Edit Price List Workbook
  • 2.3.6 Upload Modified Product Information to the Fusion Web Application

3 Setting Up Your Development Environment

• 3.1 Introduction to Setting Up Your Development Environment
• 3.2 Required Oracle ADF Modules and Third-Party Software
• 3.3 Enabling Microsoft .NET Programmability Support
• 3.4 Allowing Excel to Run an Integrated Excel Workbook
• 3.5 Setting Up the Oracle ADF Desktop Integration Client Framework
• 3.6 Upgrading the Oracle ADF Desktop Integration Client Framework
• 3.7 Removing the Oracle ADF Desktop Integration Client Framework
• 3.8 Using the Oracle ADF Desktop Integration Module on a System with Multiple Instances of JDeveloper
  • 3.8.1 What Happens When an Integrated Workbook is Opened in a New Version of Oracle ADF Desktop Integration Module
• 3.9 Localizing the Setup of the Oracle ADF Desktop Integration Client Framework

4 Preparing Your Integrated Excel Workbook

• 4.1 Introduction to Preparing Your Integrated Excel Workbooks
• 4.2 Adding Oracle ADF Desktop Integration to a Fusion Web Application
  • 4.2.1 How to Add Desktop Integration to Your JDeveloper Project
  • 4.2.2 What Happens When You Add Desktop Integration to Your JDeveloper Project
• 4.3 Working with Page Definition Files for an Integrated Excel Workbook
  • 4.3.1 How to Create a Page Definition File for an Integrated Excel Workbook
  • 4.3.2 What Happens When You Create a Page Definition File
  • 4.3.3 Reloading a Page Definition File in an Excel Workbook
  • 4.3.4 What You May Need to Know About Page Definition Files in an Integrated Excel Workbook
• 4.4 Preparing Your Workbook
  • 4.4.1 How to Run the Conversion Utility
  • 4.4.2 How to Open an Excel Workbook for the First Time
  • 4.4.3 How to Add Additional Worksheets to an Integrated Excel Workbook

5 Getting Started with the Development Tools

• 5.1 Introduction to the Development Tools
• 5.2 Using the Bindings Palette
• 5.3 Using the Components Palette
• 5.4 Using the Property Inspector
• 5.5 Using the Binding ID Picker
• 5.6 Using the Expression Builder
• 5.7 Using the Web Page Picker
• 5.8 Using the File System Folder Picker
• 5.9 Using the Page Definition Picker
• 5.10 Using the Collection Editors

6 Working with Oracle ADF Desktop Integration Form-type Components

• 6.1 Introduction to Oracle ADF Desktop Integration Form-type Components
• 6.2 Inserting an ADF Button Component
• 6.3 Inserting an ADF Label Component
• 6.4 Inserting an ADF Input Text Component
• 6.5 Inserting an ADF Output Text Component
• 6.6 Inserting an ADF Desktop Integration List of Values Component
• 6.7 Displaying Output from a Managed Bean in an ADF Component
  • 6.7.1 How to Display Output from a Managed Bean
  • 6.7.2 What Happens at Runtime When an ADF Component Displays Output from a Managed Bean
• 6.8 Displaying Concatenated or Calculated Data in Components
  • 6.8.1 How to Configure a Component to Display Calculated Data

7 Working with Oracle ADF Desktop Integration Table-type Components

• 7.1 Introduction to Oracle ADF Desktop Integration Table-type Components
• 7.2 Page Definition Requirements for an ADF Table Component
• 7.3 Inserting an ADF Table Component into an Excel Worksheet
  • 7.3.1 How to Add a Column in an ADF Table Component
• 7.4 Configuring an ADF Table Component to Update Existing Data
  • 7.4.1 How to Configure an ADF Table Component to Update Data
  • 7.4.2 What Happens at Runtime When an ADF Table Component Updates Data
• 7.5 Configuring an ADF Table Component to Insert Data
  • 7.5.1 How to Configure an ADF Table Component to Insert Data Using a View Object's Operations
• 7.6 Configuring Oracle ADF Component to Download Data to an ADF Table Component
  • 7.6.1 How to Configure an Oracle ADF Component to Download Data to an ADF Table Component
  • 7.6.2 What Happens at Runtime When an ADF Table Component Downloads Data
• 7.7 Configuring a Worksheet to Download Pre-Insert Data to an ADF Table Component
  • 7.7.1 How to Configure a Worksheet to Download Pre-Insert Data to an ADF Table Component
  • 7.7.2 What Happens at Runtime When an ADF Table Component Downloads Pre-Insert Data
• 7.8 Configuring an Oracle ADF Component to Upload Changes from an ADF Table Component
  • 7.8.1 How to Configure an Oracle ADF Component to Upload Data from an ADF Table Component
  • 7.8.2 What Happens at Runtime When an ADF Table Component Uploads Data
  • 7.8.3 What Happens at Runtime When an Upload Fails
  • 7.8.4 How to Create a Custom Upload Dialog
  • 7.8.5 What Happens at Runtime When a Custom Upload Dialog Appears
• 7.9 Configuring an ADF Table Component to Delete Rows in the Fusion Web Application
  • 7.9.1 How to Configure an ADF Table Component to Delete Rows in the Fusion Web Application
  • 7.9.2 What Happens at Runtime When an ADF Table Component Deletes Rows in a Fusion Web Application
• 7.10 Batch Processing in an ADF Table Component
  • 7.10.1 Configuring Batch Options for an ADF Table Component
  • 7.10.2 Row Flagging in an ADF Table Component
• 7.11 Special Columns in the ADF Table Component
• 7.12 Creating a List of Values in an ADF Table Component Column
  • 7.12.1 How to Create a List of Values in an ADF Table Component Column
  • 7.12.2 What Happens at Runtime When a Column Renders a List of Values
• 7.13 Adding a ModelDrivenColumnComponent Subcomponent to Your ADF Table Component
• 7.14 Adding a Dynamic Column to Your ADF Table Component
  • 7.14.1 How to Configure a Dynamic Column
  • 7.14.2 What Happens at Runtime When Data Is Downloaded or Uploaded
  • 7.14.3 How to Specify Header Labels for Dynamic Columns
  • 7.14.4 How to Specify Styles for Dynamic Columns According to Attribute Data Type
• 7.15 Creating an ADF Read-Only Table Component
  • 7.15.1 How to Insert an ADF Read-only Table Component
  • 7.15.2 How to Manually Add a Column to the ADF Read-only Table Component
• 7.16 Limiting the Number of Rows Your Table-Type Component Downloads
  • 7.16.1 How to Limit the Number of Rows a Component Downloads
  • 7.16.2 What Happens at Runtime When You Limit the Number of Rows a Component Downloads
• 7.17 Clearing the Values of Cached Attributes in an ADF Table Component
  • 7.17.1 How to Clear the Values of Cached Attributes in an ADF Table Component
  • 7.17.2 What Happens at Runtime When the ADF Table Component Clears Cached Values
• 7.18 Tracking Changes in an ADF Table Component

8 Adding Interactivity to Your Integrated Excel Workbook

• 8.1 Introduction to Adding Interactivity to an Integrated Excel Workbook
• 8.2 Using Action Sets
  • 8.2.1 How to Invoke an ADFm Action in an Action Set
  • 8.2.2 How to Invoke Component Actions in an Action Set
  • 8.2.3 What You May Need to Know About an Action Set Invoking a Component Action
  • 8.2.4 How to Invoke an Action Set from a Worksheet Event
  • 8.2.5 How to Display a Status Message While an Action Set Executes
  • 8.2.6 What Happens at Runtime When an Action Set Displays a Status Message
  • 8.2.7 How to Provide an Alert After the Invocation of an Action Set
  • 8.2.8 What Happens at Runtime When an Action Set Provides an Alert
  • 8.2.9 How to Configure Error Handling for an Action Set
  • 8.2.10 How to Invoke a Confirmation Action in an Action Set
  • 8.2.11 What Happens at Runtime When an Action Set Provides a Confirmation
• 8.3 Creating Menu Items
  • 8.3.1 How to Configure a Workbook Menu Item
  • 8.3.2 How to Configure a Worksheet Menu Item
• 8.4 Displaying Web Pages from a Fusion Web Application
  • 8.4.1 How to Display a Web Page in a Popup Dialog
  • 8.4.2 How to Display a Web Page in Excel's Document Actions
  • 8.4.3 What You May Need to Know About Displaying Pages from a Fusion Web Application
• 8.5 Inserting Values in an ADF Table Component from a Web Page Pick Dialog
• 8.6 Creating ADF Databound Search Forms in an Integrated Excel Workbook
  • 8.6.1 How to Create a Simple Search Form in an Integrated Excel Workbook
  • 8.6.2 How to Create an Advanced Search Form in an Integrated Excel Workbook
• 8.7 Adding a Form to an Integrated Excel Workbook
• 8.8 Creating Dependent Lists of Values in an Integrated Excel Workbook
  • 8.8.1 How to Create a Dependent List of Values in an Excel Worksheet
  • 8.8.2 What Happens at Runtime When a Dependent List of Values Renders in an Excel Worksheet
  • 8.8.3 How to Create a Dependent List of Values in an ADF Table Component's Columns
  • 8.8.4 What Happens at Runtime When a Dependent List of Values Renders in an ADF Table Component's Columns
  • 8.8.5 Creating a Dependent List of Values in an Excel Worksheet and an ADF Table Component Column
  • 8.8.6 What Happens at Runtime When a Dependent List of Values Renders in an Excel Worksheet and an ADF Table Component Column
• 8.9 Configuring a Cell to Display a Dynamically Generated Hyperlink
  • 8.9.1 How to Configure a Cell to Display a Dynamically Generated Hyperlink
  • 8.9.2 What Happens at Runtime When a Cell Displays Dynamically Generated Hyperlink
• 8.10 Using Calculated Cells in an Integrated Excel Workbook
  • 8.10.1 How to Create a Column That Displays Values Generated by an Excel Formula
  • 8.10.2 What Happens at Runtime When a Column Displays Values Generated by an Excel Formula
  • 8.10.3 How to Calculate the Sum of a Table-Type Component Column
  • 8.10.4 What Happens at Runtime When Excel Calculates the Sum of a Table-Type Component Column
• 8.11 Using Macros in an Integrated Excel Workbook

9 Configuring the Appearance of an Integrated Excel Workbook

• 9.1 Introduction to Configuring the Appearance of an Integrated Excel Workbook
• 9.2 Working with Styles
  • 9.2.1 How to Apply a Style to an Oracle ADF Component
  • 9.2.2 What Happens at Runtime When a Style Is Applied to an Oracle ADF Component
• 9.3 Applying Styles Dynamically Using EL Expressions
  • 9.3.1 What Happens at Runtime When an EL Expression Is Evaluated
  • 9.3.2 How to Write an EL Expression That Applies a Style at Runtime
  • 9.3.3 What You May Need to Know About EL Expressions That Apply Styles
  • 9.3.4 How to Add a Hyperlink in an Integrated Excel Workbook
• 9.4 Using Labels in an Integrated Excel Workbook
• 9.5 Using Styles to Make Integrated Excel Workbooks Usable
• 9.6 Branding Your Integrated Excel Workbook
  • 9.6.1 How to Brand an Integrated Excel Workbook
  • 9.6.2 What Happens at Runtime to the Branding Items in an Integrated Excel Workbook
• 9.7 Changing an Integrated Excel Workbook at Runtime

10 Internationalizing Your Integrated Excel Workbook

• 10.1 Introduction to Internationalizing Your Integrated Excel Workbook
• 10.2 Using Resource Bundles in an Integrated Excel Workbook
  • 10.2.1 How to Register a Resource Bundle in an Integrated Excel Workbook
  • 10.2.2 How to Replace String Key Values from the Reserved Resource Bundle
  • 10.2.3 How to Override the Reserved Resource Bundle
  • 10.2.4 What Happens at Runtime When You Override the Reserved Resource Bundle
  • 10.2.5 What You May Need to Know About Resource Bundles
• 10.3 Localization in Oracle ADF Desktop Integration

11 Securing Your Integrated Excel Workbook

• 11.1 Introduction to Securing Your Integrated Excel Workbook
• 11.2 Authenticating the Excel Workbook User
  • 11.2.1 How a Fusion Web Application Determines If an Excel Workbook Has a Web Session ID
  • 11.2.2 What Happens at Runtime When the Login Mechanism Is Invoked
  • 11.2.3 What Happens at Runtime When the Logout Mechanism Is Invoked
• 11.3 Checking the Integrity of an Integrated Excel Workbook's Metadata
  • 11.3.1 How to Reset the Workbook ID
  • 11.3.2 How to Disable the Metadata Tamper-Check in the Fusion Web Application
  • 11.3.3 How to Allow Missing Entries in the Oracle ADF Desktop Integration Client Registry
  • 11.3.4 What Happens When the Metadata Tamper-Check is Performed
• 11.4 What You May Need to Know About Securing an Integrated Excel Workbook

12 Adding Validation to an Integrated Excel Workbook

• 12.1 Introduction to Adding Validation to an Integrated Excel Workbook
• 12.2 Providing Server-Side Validation for an Integrated Excel Workbook
• 12.3 Providing Client-Side Validation for an Integrated Excel Workbook
• 12.4 Error Reporting in an Integrated Excel Workbook
• 12.5 Providing a Row-by-Row Status on an ADF Table Component
• 12.6 Adding Detail to Error Messages in an Integrated Excel Workbook
• 12.7 Handling Data Conflicts When Uploading Data from a Workbook
  • 12.7.1 How to Configure a Workbook to Handle Data Conflicts When Uploading Data
  • 12.7.2 What Happens at Runtime When You Configure a Workbook to Handle Data Conflicts

13 Testing Your Integrated Excel Workbook

• 13.1 Introduction to Testing Your Integrated Excel Workbook
• 13.2 Testing Your Fusion Web Application
• 13.3 Testing Your Integrated Excel Workbook

14 Deploying Your Integrated Excel Workbook

• 14.1 Introduction to Deploying Your Integrated Excel Workbook
• 14.2 Making the Oracle ADF Desktop Integration Client Framework Available to End Users
• 14.3 Configuring Security Settings for Excel
• 14.4 Publishing Your Integrated Excel Workbook
  • 14.4.1 How to Publish an Integrated Excel Workbook
  • 14.4.2 What Happens When You Publish an Integrated Excel Workbook
• 14.5 Deploying a Published Workbook with Your Fusion Web Application
• 14.6 Passing Parameter Values from a Fusion Web Application Page to a Workbook
  • 14.6.1 How to Configure the Fusion Web Application's Page to Pass Parameters
  • 14.6.2 How to Configure the Page Definition File for the Worksheet to Receive Parameters
  • 14.6.3 How to Configure Properties in the Integrated Excel Workbook to Receive Parameters
  • 14.6.4 What Happens at Runtime When a Fusion Web Application Page Passes Parameters to an Integrated Excel Workbook

15 Using an Integrated Excel Workbook Across Multiple Web Sessions and in Disconnected Mode

• 15.1 Introduction to Disconnected Workbooks
• 15.2 Deferring Login for an Integrated Excel Workbook
• 15.3 Restore Server Data Context Between Sessions
  • 15.3.1 How to Configure an Integrated Excel Workbook to Restore Server Data Context
  • 15.3.2 What Happens at Runtime When an Integrated Excel Workbook Restores Server Data Context
• 15.4 Caching Lists of Values for Use in Disconnected Mode

A Oracle ADF Desktop Integration Component Properties and Actions

• A.1 Frequently Used Properties in the Oracle ADF Desktop Integration Module
• A.2 ADF Input Text Component Properties
• A.3 ADF Output Text Component Properties
• A.4 ADF Label Component Properties
• A.5 ADF Desktop Integration List of Values Component Properties
• A.6 TreeNodeList Subcomponent Properties
• A.7 ModelDrivenColumnComponent Subcomponent Properties
• A.8 ADF Button Component Properties
• A.9 ADF Table Component Properties and Actions
  • A.9.1 ADF Table Component Properties
  • A.9.2 ADF Table Component Column Properties
  • A.9.3 ADF Table Component Actions
• A.10 ADF Read-only Table Component Properties and Actions
• A.11 Action Set Properties
  • A.11.1 Confirmation Action Properties
  • A.11.2 Dialog Action Properties
• A.12 Workbook Actions and Properties
• A.13 Worksheet Actions and Properties

B Oracle ADF Desktop Integration EL Expressions

• B.1 Guidelines for Creating EL Expressions
• B.2 EL Syntax for Oracle ADF Desktop Integration Components
• B.3 Attribute Control Hints in the Oracle ADF Desktop Integration Module

C Troubleshooting an Integrated Excel Workbook

• C.1 Verifying That Your Fusion Web Application Supports Desktop Integration
• C.2 Verifying End-User Authentication for Integrated Excel Workbooks
• C.3 Generating Log Files for an Integrated Excel Workbook
  • C.3.1 About Server-Side Logging
  • C.3.2 About Client-Side Logging
    • C.3.2.1 How to Generate Log Files using a Configuration File
    • C.3.2.2 How to Configure Logging Using User Environment Variables
    • C.3.2.3 What You May Need to Know About adfdi-common Object
• C.4 Exporting Excel Workbook Metadata
• C.5 Common Desktop Integration Problems

D Using Workbook Management Tools

• D.1 Using the Workbook Conversion Utility
  • D.1.1 Configuring JDeveloper To Run Workbook Conversion Utility
• D.2 Using the Workbook Administration Tool

E Desktop Integration Settings in the Web Application Deployment Descriptor

• E.1 Configuring the Oracle ADF Desktop Integration Module Servlet
• E.2 Configuring the ADF Desktop Integration Excel Download Filter
• E.3 Examples in a Deployment Descriptor File

F String Keys in the Reserved Resource Bundle

G Java Data Types Supported By Oracle ADF Desktop Integration

H Using ADF Desktop Integration Model API

• H.1 About Temporary Row Object
• H.2 Introduction to ADF Desktop Integration Model API
  • H.2.1 How to Add ADF Desktop Integration Model API Library to Your JDeveloper Project
• H.3 ADF Desktop Integration Model API Classes and Methods
  • H.3.1 The oracle.adf.desktopintegration.model.ModelHelper Class
    • H.3.1.1 The getAdfdiTempChildRow Method
    • H.3.1.2 The getAdfdiTempRowForView Method
    • H.3.1.3 The getChildViewDef Method

I End User Actions

• I.1 Importing Data From a Non-Integrated Excel Worksheet
• I.2 Removing Personal Information
• I.3 Limitations of Integrated Excel Workbook at Runtime

Index