6Excel Add-Ins

This chapter contains the following:

Oracle ADF Desktop Integration Add-In for Excel

Set Up Desktop Integration for Excel

You can create or edit records and upload them to the application using integrated Excel workbooks. To use these workbooks, you must install an Excel add-in.

Note: Every release of Oracle Applications Cloud is likely to have a new version of the Oracle ADF Desktop Integration add-in. When prompted, install the latest version of the add-in. For more information, see Add-In Upgrade Policy for ADF Desktop Integration (2242879.1) on My Oracle Support at https://support.oracle.com.

Install the Desktop Integration Add-In

To install the Oracle ADF 11g Desktop Integration Add-In for Excel, you must have the appropriate Excel and Windows version. Refer to the Excel and Windows version listed in the Supported Platforms for ADF Desktop Integration (2242428.1) on My Oracle Support at https://support.oracle.com. Also, make sure that you have the Employee (ORA_PER_EMPLOYEE_ABSTRACT) role to access the add-in installer.

  1. Sign in to your computer with your account. For example, you can't have someone else sign in as an administrator and make the installation available for everyone using your computer.

  2. Close Excel.

  3. Click Navigator > Tools > Download Desktop Integration to download the installer file.

  4. Run the adfdi-excel-addin-installer.exe installer just like you would run any program that you install on your computer.

  5. Run Excel once to complete the installation.

  6. Optionally install these software from the Microsoft website.

    • Microsoft .NET Framework 4.5.2

    • Microsoft Visual Studio 2010 Tools for Office Runtime (VSTO Runtime)

    The add-in installer does check if you have these software already, and would download and install them if needed. However, if you run into issues installing them as part of installing the Excel add-in, you can manually install them first.

Note: You can also install the add-in for all users at a time. For more information, see How to install the ADF Desktop Integration Add-in for Excel (2681794.1) on My Oracle Support at https://support.oracle.com.

Guidelines for Using Desktop Integrated Excel Workbooks

Where available, you can download a desktop-integrated Microsoft Excel workbook and use it to create or edit records. Your edits in the workbook don't affect the application until you upload the records back into the application.

What You Must Not Do

To ensure that you successfully upload your changes to the application, avoid doing these tasks:

  • Rename text from the integrated workbook, such as the worksheet or the tab names.

  • Add columns.

  • Delete any part of the template, such as columns.

  • Hide required columns and status columns or headers.

Caution: Don't close Excel using the Windows Task Manager and clicking the End task button because that might disable the add-in.


Some column headers in the integrated workbook might include [..]. This means that you can double-click within any cell in the column to open a dialog box, where you can select a value to insert into that cell.


You can use Status Viewer to see the status of the entire integrated worksheet and the status of any row in a worksheet. To use the status viewer, click Status Viewer on the Excel ribbon. You can see the status of the entire integrated worksheet by default. To see the status of a row, click any table row in a worksheet. You can use the information that appears on the Status Viewer to review and correct errors at the same time.


Some integrated workbooks have searches. To search within the workbook, you must first sign in to the application. When you click the Search button, the application prompts you to sign in if you haven't already done so.

Refreshes After Upload

If your changes aren't reflected after you upload the records back into the application, you can try out these options:

  • Refresh the table

  • Use a filter or search on the table to see your changes

Troubleshoot Desktop Integration for Excel

If you run into any issues with the integration, use the Client Health Check tool first to find out what integration issues you might have and how to resolve them. If the health check tool doesn't resolve your issue, you can uninstall and reinstall Oracle ADF Desktop Integration add-in.

Use the Client Health Check Tool

  1. Download the latest version of the health check tool from How to use ADF Desktop Integration Client Health Check Tool (2010222.1) on My Oracle Support at https://support.oracle.com. If you're unable to find this tool, ask your help desk.

  2. Run ClientHealthCheck.exe just like you would run any other program on your computer, and review the result for each checked item.

  3. Select any item that has a problem, and read the help text.

  4. Click Fix Problems to fix some of the problems. Otherwise, follow the instructions in the help text.

  5. If you need more assistance, click Save Report As to prepare information for your help desk.

  6. Review the report and remove any sensitive information.

  7. For more assistance, contact your help desk and provide your report.

For more information, see Information Center: Troubleshooting Oracle ADF Desktop Integration (2012600.2) on My Oracle Support at https://support.oracle.com.

Uninstall the Desktop Add-In

Use the Microsoft Windows Control Panel to remove the ADF Desktop Integration add-in. After removing the add-in, you can no longer use the integrated Excel workbooks on this system unless you reinstall the ADF Desktop Integration add-in.

  1. Open the Control Panel and go to Programs and Features.

  2. Select Oracle ADF Desktop Integration Add-In for Excel from the list of programs.

  3. Click Uninstall from the toolbar at the top of the program list.

  4. When prompted, click Yes to remove Oracle ADF Desktop Integration add-in.

Note: If you have installed Oracle ADF Desktop Integration add-in on multiple user profiles, you must remove it from each user profile.

Oracle Visual Builder Add-In for Excel

Use Oracle Visual Builder Add-in for Excel to integrate Microsoft Excel spreadsheets with REST services to retrieve, analyze, and edit business data from the REST service. You can download your data to an Excel spreadsheet, work with it, and upload your changes back to the REST service. After you install the add-in, a new ribbon tab (Oracle Visual Builder) appears in Microsoft Excel. You can use the buttons in this ribbon tab to configure a worksheet to integrate with a REST service and download the data to a data table that you create in the worksheet. Once you create the data table and populate it with data, you can review, modify, and create data before uploading changes to the REST service. After you integrate the Excel worksheet with the REST service, you can optionally publish the Excel workbook that contains the integrated worksheet.