Setting Up Your Development Environment

About Setting Up Your Development Environment

Setting up the development environment involves making sure that you have the correct versions of JDeveloper and Microsoft Office installed.

After verifying that you have the required software, as described in Required Oracle ADF Modules and Third-Party Software, complete the setup of your development environment by Installing ADF Desktop Integration.

Note:

The instructions in this guide assume that you are using the Windows 10 operating system and Microsoft Excel 365. Note that the steps might be different for different editions of Windows and Excel.

Required Oracle ADF Modules and Third-Party Software

Ensure that you have the required Oracle ADF modules and third-party software installed and configured before you begin to integrate your Excel workbook with a Fusion web application.

This Oracle add-in for Microsoft Excel relies on a number of Microsoft technologies. These Microsoft technologies are subject to Microsoft's privacy policies and other Microsoft terms. By installing and using this add-in, you are agreeing to those policies and terms and this add-in's direct or indirect usage of these technologies. See also the Microsoft Privacy Statement.

Note:

Oracle is not responsible for the behavior of Microsoft components.

Software	Requirements
Oracle JDeveloper	Install the current release of JDeveloper. ADF Desktop Integration is available as a JDeveloper feature. Note: JDeveloper is only required by developers for integrated workbook development. Business users and administrators do not need JDeveloper.
Microsoft Windows	Microsoft Windows operating systems support the development and deployment of Excel workbooks that integrate with Fusion web applications. For information about supported versions of Windows, see Supported Platforms.
Microsoft Excel	The add-in supports the integration of Fusion web applications with the following types of Excel workbook: Excel Workbook The default file format for Excel workbooks is the Excel XML-based file format (`.xlsx`). Excel Macro-Enabled Workbook Workbooks in this format (`.xlsm`) use the Excel XML-based file format and can store VBA macro code. The add-in does not support the use of other Excel file formats. For information about supported versions of Excel, see Supported Platforms.
Microsoft .NET Framework	Microsoft .NET Framework provides the runtime and associated files required to run applications developed to target the Microsoft .NET Framework. Please note these requirements: ADF Desktop Integration 5.2.1 requires Microsoft .NET Framework 4.8.1. ADF Desktop Integration 5.2.0 requires a minimum version of Microsoft .NET Framework 4.5.2. Download the framework from the Microsoft Download Center. Note: Use of Microsoft .NET Framework 4.8.1 is recommended to ensure you receive updates, including security fixes, and technical support from Microsoft. See Microsoft .NET Framework for lifecycle support information.
Microsoft Visual Studio 2010 Tools for Office Runtime	The Microsoft Visual Studio 2010 Tools for Office Runtime (version 4) is required to run VSTO solutions for the Microsoft Office system. This runtime is automatically installed with Microsoft Excel in many cases. If required, you can download it from the Microsoft Download Center.
WebView2 runtime	The add-in uses WebView2 as an embedded web browser to display web pages from inside Microsoft Excel. You can download the runtime from Download Microsoft Edge WebView2. See The Embedded Browser for more information.

Consider running the Client Health Check to determine if your environment is configured correctly after you run the ADF Desktop Integration installer. See Checking Your Environment.

Installing ADF Desktop Integration

To install the ADF Desktop Integration add-in, download and run one of the two available installers.

There are two installers for the add-in: a current user installer and an all users installer. Use the current user installer to install the add-in on your local desktop for your own use. The all users installer is intended for IT administrators.

To install ADF Desktop Integration using the current user installer, see How to Install ADF Desktop Integration. For information about installing with the all users installer, see Installing and Upgrading ADF Desktop Integration.

Note that this current user installation is specific to the current Windows user profile. If you have multiple Windows user profiles on your system, and you want to use ADF Desktop Integration integrated Excel workbooks from some specific user profiles, you must log in to each user profile and install the ADF Desktop Integration add-in.

How to Install Using the Current User Installer

Install the ADF Desktop Integration add-in using the current user installer, and then create and test integrated Excel workbooks.

If any required software is missing, the installation terminates without installing the add-in. Refer to Required Oracle ADF Modules and Third-Party Software for details including information on how to check for and install required components. You can also refer to this topic for information on installing the Microsoft Edge WebView2 embedded browser. WebView2 is an additional Microsoft component and must be installed separately.

The add-in includes designer tools for developing workbooks. These tools are not included by default. If you are an application developer, make sure to install the designer tools with the add-in. If you need these tools but don’t have them, simply rerun the installer and enable the designer tools.

This installation is specific to the current Windows user profile. If multiple users on a Windows machine need the add-in, consider using the All Users installer instead. See Installing and Upgrading ADF Desktop Integration.

You do not require administrator privileges to install the ADF Desktop Integration add-in using the current user installer.

Open JDeveloper.
From the Tools menu, choose Install ADF Desktop Integration.

Note:
The Install ADF Desktop Integration menu option is available only on the Windows installation of JDeveloper.
In the ADF Desktop Integration Installer page of Oracle ADF Desktop Integration Add-In for Excel wizard, click Install.
Follow the instructions to install the add-in. If you encounter an error during the installation process, an error message with a description appears, and installation is rolled back. For more details, check the adfdi-installer-log.txt error log file in the temp directory of the user profile.
If prompted, click Yes to restart the system and complete the install of ADF Desktop Integration.
It may also be necessary to open Microsoft Excel to accept additional prompts to allow the installation to complete.

Note the following points about installation:

You can also install ADF Desktop Integration by running adfdi-installer-current-user.msi available in the following directory:
MW_HOME/oracle_common/modules/oracle.adf.desktopintegration

Before you run the installer, remember that the ADF Desktop Integration add-in installer does not enable designer features by default. You must enable the designer features in the add-in to create and edit integrated Excel workbooks.

In the ADF Desktop Integration Installer page of the wizard, click Developer Options, and then in the Developer Options page select the Enabled option, and click Install. If you do not select the Enabled option, the Oracle ADF tab shown in Figure 3-1 does not appear in Microsoft Excel.

Figure 3-1 Oracle ADF Tab in Microsoft Excel

Description of "Figure 3-1 Oracle ADF Tab in Microsoft Excel"
Designer features are automatically enabled if you install ADF Desktop Integration from JDeveloper.
You can also install ADF Desktop Integration from the command line.

If you want to install ADF Desktop Integration for business users, see Installing, Upgrading, and Removing ADF Desktop Integration.

Removing ADF Desktop Integration

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

To remove the ADF Desktop Integration add-in:

Click the Windows Start button, and then choose Control Panel.
In the Control Panel, select and open Programs and Features.
Select the Oracle ADF Desktop Integration Add-in for Excel program and click Uninstall.

Note:

If you have installed ADF Desktop Integration on multiple user profiles, you must remove it from each user profile.

Upgrading ADF Desktop Integration

To upgrade to a new version, run the ADF Desktop Integration installer from the new version. It is not necessary to uninstall the old version first.

You can run the installer from:

JDeveloper Tools menu
Welcome page of the running Fusion web application (see Verifying That Your Fusion Web Application Supports ADF Desktop Integration )
File system (see the Notes section of How to Install ADF Desktop Integration)

Note:

If you are upgrading from a previous release, you may receive a message that says that ADF Desktop Integration was installed with an incompatible installer. In this case, you must uninstall the ADF Desktop Integration add-in prior to running the installer.
When you test your integrated Excel workbooks, ADF Desktop Integration may prompt you with a dialog to install a newer add-in version available from your test server. Although this dialog contains an option to skip, you, as a developer, should never skip the installation of the add-in version that the dialog proposes. It is important to keep the version of the add-in synchronized with the ADF Desktop Integration servlet version.