Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction to ADF Desktop Integration

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

2 Introduction to the ADF Desktop Integration Sample Application

• 2.1 Introduction to Summit Sample Application for ADF Desktop Integration
• 2.2 Setting Up and Executing the Summit Sample Application for ADF Desktop Integration
• 2.3 Overview of the Fusion Web Application in the Summit Sample Application for ADF Desktop Integration
  • 2.3.1 Log on to the Fusion Web Application in the Summit Sample Application for ADF Desktop Integration
  • 2.3.2 Downloading Integrated Excel Workbooks
• 2.4 Overview of the Integrated Excel Workbooks in the Summit Sample Application for ADF Desktop Integration
  • 2.4.1 Log on to the Fusion Web Application from an Integrated Excel Workbook
  • 2.4.2 Downloading Data Rows
  • 2.4.3 Modify Customers and Warehouses Information in the Workbooks
  • 2.4.4 Upload Modified 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 Configuring Excel to work with ADF Desktop Integration
• 3.4 Installing ADF Desktop Integration
  • 3.4.1 How to Set Up ADF Desktop Integration
• 3.5 Removing ADF Desktop Integration
• 3.6 Upgrading ADF Desktop Integration
  • 3.6.1 How to Migrate an Integrated Excel Workbook to the Current Version of ADF Desktop Integration
• 3.7 Using an Integrated Excel Workbook with Older Versions of ADF Desktop Integration
• 3.8 Using ADF Desktop Integration on a System with Multiple Instances of JDeveloper

4 Preparing Your Integrated Excel Workbook

• 4.1 Introduction to Preparing Your Integrated Excel Workbooks
• 4.2 Adding an Integrated Excel Workbook to a Fusion Web Application
  • 4.2.1 How to Add an Integrated Excel Workbook to a Fusion Web Application
  • 4.2.2 How to Configure a New Integrated Excel Workbook
  • 4.2.3 How to Add Additional Worksheets to an Integrated Excel Workbook
  • 4.2.4 What Happens When You Deploy an ADF Desktop Integration-Enabled Fusion Web Application from JDeveloper
    • 4.2.4.1 Fusion Web Application is Deployed on Oracle WebLogic Server
    • 4.2.4.2 Web Application is Deployed on IBM WebSphere Application Server
• 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 How to Reload 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 Enabling ADF Desktop Integration Manually
  • 4.4.1 How to Manually Add ADF Desktop Integration In Fusion Web Application
  • 4.4.2 How to Enable ADF Desktop Integration in an Existing Workbook
  • 4.4.3 How to Manually Configure a New Integrated Excel Workbook
  • 4.4.4 What Happens When You Add ADF Desktop Integration to Your JDeveloper Project
  • 4.4.5 Adding ADF Library Web Application Support

5 Getting Started with the Development Tools

• 5.1 Introduction to Development Tools
• 5.2 Designer Ribbon Tab
• 5.3 ADF Desktop Integration Designer Task Pane
• 5.4 Using the Bindings Palette
• 5.5 Using the Components Palette
• 5.6 Using the Property Inspector
• 5.7 Using the Binding ID Picker
• 5.8 Using the Expression Builder
• 5.9 Using the Web Page Picker
• 5.10 Using the File System Folder Picker
• 5.11 Using the Page Definition Picker
• 5.12 Using the Collection Editors
• 5.13 Using the Cell Context Menu
• 5.14 Removing ADF Desktop Integration Components
• 5.15 Exporting and Importing Excel Workbook Integration Metadata
  • 5.15.1 How to Export Workbook Integration Metadata
  • 5.15.2 How to Import Workbook Integration Metadata
  • 5.15.3 What You May Need to Know About Exporting and Importing Excel Workbook Integration Metadata

6  Working with ADF Desktop Integration Form-Type Components

• 6.1 Introduction to 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 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: How 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
• 6.9 Using Navigation Buttons

7 Working with ADF Desktop Integration Table-Type Components

• 7.1 Introduction to ADF Desktop Integration Table-Type Components
• 7.2 Page Definition Requirements for an ADF Table Component
• 7.3 Inserting ADF Table Component into Excel Worksheet
  • 7.3.1 How to Insert ADF Table Component
  • 7.3.2 How to Add a Column in an ADF Table Component
• 7.4 Configuring Oracle ADF Component to Download Data to an ADF Table Component
  • 7.4.1 How to Configure an ADF Component to Download Data to an ADF Table Component
  • 7.4.2 What Happens at Runtime: How the ADF Table Component Downloads Data
• 7.5 Configuring a Worksheet to Download Data as Pending Insert Rows in an ADF Table Component
  • 7.5.1 What Happens at Runtime: Download Action is Invoked
  • 7.5.2 Using STATUS_INITIALIZED Rows for Pending Inserts
  • 7.5.3 What You May Need to Know About DownloadForInsert Action
• 7.6 Configuring an ADF Table Component to Update Existing Data
  • 7.6.1 How to Configure an ADF Table Component to Update Data
  • 7.6.2 What Happens at Runtime: How the ADF Table Component Updates Data
• 7.7 Configuring an ADF Table Component to Insert Data
  • 7.7.1 How to Configure an ADF Table Component to Insert Data Using a View Object's Operations
• 7.8 Configuring an ADF Component to Upload Changes from an ADF Table Component
  • 7.8.1 How to Configure an ADF Component to Upload Data from an ADF Table Component
  • 7.8.2 What Happens at Runtime: How the ADF Table Component Uploads Data
  • 7.8.3 What Happens at Runtime: How the ReadOnly EL Expression Is Evaluated During Upload
  • 7.8.4 What Happens at Runtime: Upload Failure
  • 7.8.5 How to Create a Custom Upload Dialog
  • 7.8.6 What Happens at Runtime: Custom Upload Dialog
• 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: How the ADF Table Component Deletes Rows in a Fusion Web Application
• 7.10 Batch Processing in an ADF Table Component
  • 7.10.1 How to Configure Batch Options for an ADF Table Component
  • 7.10.2 Row Flagging in an ADF Table Component
  • 7.10.3 Troubleshooting Errors While Uploading Data
• 7.11 Special Columns in the ADF Table Component
• 7.12 Configuring ADF Table Component Key Column
  • 7.12.1 How to Configure the Key Column
  • 7.12.2 How to Manually Add the Key Column At Design Time
• 7.13 Creating a List of Values in an ADF Table Component Column
  • 7.13.1 How to Create a List of Values in an ADF Table Component Column
  • 7.13.2 What Happens at Runtime: How the ADF Table Column Renders a List of Values
• 7.14 Adding a ModelDrivenColumnComponent Subcomponent to Your ADF Table Component
• 7.15 Adding a Dynamic Column to Your ADF Table Component
  • 7.15.1 How to Configure a Dynamic Column
  • 7.15.2 What Happens at Runtime: How Data Is Downloaded or Uploaded In a Dynamic Column
  • 7.15.3 How to Specify Header Labels for Dynamic Columns
  • 7.15.4 How to Specify Styles for Dynamic Columns According to Attribute Data Type
• 7.16 Creating an ADF Read-Only Table Component
  • 7.16.1 How to Insert an ADF Read-only Table Component
  • 7.16.2 How to Manually Add a Column to the ADF Read-only Table Component
• 7.17 Limiting the Number of Rows Your Table-Type Component Downloads
  • 7.17.1 How to Limit the Number of Rows a Component Downloads
  • 7.17.2 What Happens at Runtime: How the RowLimit Property Works
• 7.18 Clearing the Values of Cached Attributes in an ADF Table Component
  • 7.18.1 How to Clear the Values of Cached Attributes in an ADF Table Component
  • 7.18.2 What Happens at Runtime: How the ADF Table Component Clears Cached Values
• 7.19 Tracking Changes in an ADF Table Component
• 7.20 Evaluating EL Expression for ReadOnly Properties
  • 7.20.1 What Happens at Runtime: Evaluating EL Expression While Downloading Data
  • 7.20.2 What Happens at Runtime: Evaluating EL Expression While Uploading Data or Tracking Changes
  • 7.20.3 What You May Need to Know About Evaluating EL Expression While Uploading Data or Tracking Changes
• 7.21 Using Explicit Worksheet Action
  • 7.21.1 How to Configure Explicit Worksheet Setup Action
  • 7.21.2 What You May Need to Know About Explicit Worksheet Setup Action

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 a Method Action Binding 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.3.1 Verifying an Action Set Invokes the Correct Component Action
    • 8.2.3.2 Invoking Action Sets in a Disconnected Workbook
  • 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: How the Action Set Displays a Status Message
  • 8.2.7 What You May Need to Know About Progress Bars
  • 8.2.8 How to Provide an Alert After the Invocation of an Action Set
  • 8.2.9 What Happens at Runtime: How the Action Set Provides an Alert
  • 8.2.10 How to Configure Error Handling for an Action Set
  • 8.2.11 How to Invoke a Confirmation Action in an Action Set
  • 8.2.12 What Happens at Runtime: How the Action Set Provides a Confirmation
• 8.3 Configuring the Runtime Ribbon Tab
  • 8.3.1 How to Define a Workbook Command Button for the Runtime Ribbon Tab
  • 8.3.2 How to Configure a Worksheet Command for the Runtime Ribbon Tab
• 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 ADF Desktop Integration Runtime Task Pane
  • 8.4.3 What You May Need to Know About Displaying Pages from a Fusion Web Application
    • 8.4.3.1 Keeping an Integrated Excel Workbook and a Fusion Web Application Synchronized
    • 8.4.3.2 Sharing Data Control Frames Between Integrated Excel Worksheets and Fusion Web Application Pages
    • 8.4.3.3 Configuring a Fusion Web Application for ADF Desktop Integration Frame Sharing
• 8.5 Adding a Custom Popup Picker Dialog to an ADF Table Column
• 8.6 Creating ADF Databound Search Forms in an Integrated Excel Workbook
  • 8.6.1 How to Create a Search Form in an Integrated Excel Workbook
  • 8.6.2 How to Create a Search Form using a Web Page 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: How the Excel Worksheet Renders a Dependent List of Values
  • 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: How the ADF Table Component Column Renders a Dependent List of Values
  • 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: How the Excel Worksheet and the ADF Table Component Column Render a Dependent List of Values
• 8.9 Using EL Expression to Generate an Excel Formula
  • 8.9.1 How to Configure a Cell to Display a Hyperlink Using EL Expression
  • 8.9.2 What Happens at Runtime: How a Cell Displays a Hyperlink using an EL Expression
• 8.10 Using Calculated Cells in an Integrated Excel Workbook
  • 8.10.1 How to Calculate the Sum of a Table-Type Component Column
  • 8.10.2 What Happens at Runtime: How 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 Predefined Styles in ADF Desktop Integration
  • 9.2.2 Excel's Date Formats and Microsoft Windows' Regional and Language Options
  • 9.2.3 How to Apply a Style to an Oracle ADF Component
  • 9.2.4 What Happens at Runtime: How Style Is Applied to an ADF Component
• 9.3 Applying Styles Dynamically Using EL Expressions
  • 9.3.1 What Happens at Runtime: How 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.4 Using Labels in an Integrated Excel Workbook
  • 9.4.1 Retrieving the Values of String Keys from a Resource Bundle
  • 9.4.2 Retrieving the Values of Attribute Control Hints
  • 9.4.3 How an Integrated Excel Workbook Evaluates a Label Property
• 9.5 Using Styles to Improve the User Experience
  • 9.5.1 Using ADF Label Components to improve the User Experience
  • 9.5.2 What You May Need to Know About the Read-Only Property in an Integrated Excel Workbook
• 9.6 Branding Your Integrated Excel Workbook
  • 9.6.1 How to Brand an Integrated Excel Workbook
  • 9.6.2 What Happens at Runtime: the BrandingItems Group of Properties
• 9.7 Using Worksheet Protection
  • 9.7.1 How to Enable Worksheet Protection
  • 9.7.2 What Happens at Runtime: How the Locked Property Works
  • 9.7.3 What You May Need to Know About Worksheet Protection

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 Override Resources That Are Not Configurable
  • 10.2.3 What Happens at Runtime: Override Resources That Are Not Configurable
  • 10.2.4 What You May Need to Know About Resource Bundles
    • 10.2.4.1 Resource Bundle Types
    • 10.2.4.2 Caching of Resource Bundles in an Integrated Excel Workbook
    • 10.2.4.3 EL Expression Syntax for Resource Bundles
• 10.3 Localization in ADF Desktop Integration
  • 10.3.1 Configuring Fusion Web Application to Override Server-Side Locale Settings
    • 10.3.1.1 How to Create a User Preference Handler
    • 10.3.1.2 How to Register the User Preference Handler

11 Securing Your Integrated Excel Workbook

• 11.1 Introduction to Security In Your Integrated Excel Workbook
• 11.2 Authenticating the Excel Workbook User
  • 11.2.1 What Happens at Runtime: How the Login Method Is Invoked
  • 11.2.2 What Happens at Runtime: How the Logout Method 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 What Happens When the Metadata Tamper-Check Is Performed
• 11.4 What You May Need to Know About Securing an Integrated Excel Workbook
• 11.5 Authorizing the Excel Workbook User
  • 11.5.1 What You May Need to Know About ADF Desktop Integration-Disabled Worksheet

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.4.1 Error Reporting Using EL Expressions
  • 12.4.2 Error Reporting Using Component Actions
• 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: How Data Conflicts Are Handled

13 Testing Your Integrated Excel Workbook

• 13.1 Introduction to Testing Your Integrated Excel Workbook
• 13.2 Testing Your Fusion Web Application
• 13.3 Validating the Integrated Excel Workbook Configuration
  • 13.3.1 How to Validate the Integrated Excel Workbook Configuration
  • 13.3.2 What Happens When You Validate the Integrated Excel Workbook Configuration
  • 13.3.3 How to Fix Validation Failures
  • 13.3.4 How to Log the Integrated Excel Workbook Configuration Validation Failures at Runtime
• 13.4 Testing Your Integrated Excel Workbook
• 13.5 Running a Server Ping Test

14 Deploying Your Integrated Excel Workbook

• 14.1 Introduction to Deploying Your Integrated Excel Workbook
• 14.2 Making ADF Desktop Integration Available to End Users
• 14.3 Publishing Your Integrated Excel Workbook
  • 14.3.1 How to Publish an Integrated Excel Workbook from Excel
  • 14.3.2 How to Publish an Integrated Excel Workbook Using the Command Line Publish Tool
  • 14.3.3 What Happens When You Publish an Integrated Excel Workbook
• 14.4 Deploying a Published Workbook with Your Fusion Web Application
  • 14.4.1 What Happens at Runtime: Deploying a Published Workbook
• 14.5 Passing Parameter Values from a Fusion Web Application Page to a Workbook
  • 14.5.1 How to Configure the Fusion Web Application's Page to Pass Parameters
  • 14.5.2 How to Configure the Page Definition File for the Worksheet to Receive Parameters
  • 14.5.3 How to Configure Parameters Properties in the Integrated Excel Workbook
  • 14.5.4 What Happens at Runtime: How Parameters Are Passed from a Fusion Web Application to the 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 Restore Server Data Context Between Sessions
  • 15.2.1 How to Configure an Integrated Excel Workbook to Restore Server Data Context
  • 15.2.2 What Happens at Runtime: How the Integrated Excel Workbook Restores Server Data Context
• 15.3 Caching of Static Information in an Integrated Excel Workbook
• 15.4 Caching Lists of Values for Use in Disconnected Mode

A ADF Desktop Integration Component Properties and Actions

• A.1 Frequently Used Properties in the ADF Desktop Integration
• A.2 ADF Input Text Component Properties
• A.3 ADF Output Text Component Properties
• A.4 ADF Label Component Properties
• A.5 ADF 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 ADF Desktop Integration EL Expressions

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

C Troubleshooting an Integrated Excel Workbook

• C.1 Verifying That Your Fusion Web Application Supports ADF 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 Configure ADF Desktop Integration to Save Logs
    • C.3.2.2 About the ADF Desktop Integration Configuration File
    • C.3.2.3 How to Configure Logging Using User Environment Variables
    • C.3.2.4 What You May Need to Know About the adfdi-common Object
• C.4 Exporting Excel Workbook Configuration
• C.5 Common ADF Desktop Integration Error Messages and Problems

D ADF Desktop Integration Settings in the Web Application Deployment Descriptor

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

E String Keys in the Overridable Resources

F Java Data Types Supported By ADF Desktop Integration

G Using the ADF Desktop Integration Model API

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

H End User Actions

• H.1 Installing, Upgrading, and Removing the Runtime Edition of ADF Desktop Integration
  • H.1.1 How to Install Runtime Edition of ADF Desktop Integration
  • H.1.2 How to Remove the Runtime Edition of ADF Desktop Integration
  • H.1.3 How to Upgrade the Runtime Edition of ADF Desktop Integration On a Local System
• H.2 Importing Data from a Non-Integrated Excel Worksheet
• H.3 Removing Personal Information
• H.4 Changing an Integrated Excel Workbook at Runtime
• H.5 Limitations of an Integrated Excel Workbook at Runtime
• H.6 Using An Integrated Excel Workbook
  • H.6.1 How to Insert a Row in an ADF Table Component of an Integrated Excel Workbook
  • H.6.2 How to Sort ADF Table Data in an Integrated Excel Workbook
  • H.6.3 How to Delete a Row in ADF Table of an Integrated Excel Workbook
• H.7 Handling Time Zone Conversion