Oracle® Fusion Middleware Desktop Integration Developer's Guide for Oracle Application Development Framework 11g Release 1 (11.1.1) E10139-01 |
|
![]() Previous |
![]() Next |
This chapter describes how you set up your development environment so that you can integrate an Excel workbook with a Fusion web application.
This chapter includes the following sections:
Section 3.1, "Introduction to Setting Up Your Development Environment"
Section 3.2, "Required Oracle ADF Modules and Third-Party Software"
Section 3.3, "Enabling Microsoft .NET Programmability Support"
Section 3.4, "Allowing Excel to Run an Integrated Excel Workbook"
Section 3.5, "Setting Up the Oracle ADF Desktop Integration Client Framework"
Section 3.6, "Removing the Oracle ADF Desktop Integration Client Framework"
Section 3.8, "Localizing the Setup of the Oracle ADF Desktop Integration Client Framework"
Setting up your development environment involves making sure that you have the correct versions of JDeveloper, Microsoft Office, and Microsoft Internet Explorer installed. You must also enable support for Microsoft .NET programmability, if it is not already enabled. Once you verify that you have the required software and enabled Microsoft .NET programmability, complete the setup of your development environment by:
Allowing Excel to run an integrated Excel workbook
Setting up the Oracle ADF Desktop Integration client framework
The chapter concludes by describing how you can remove the Oracle ADF Desktop Integration client framework and use the Oracle ADF Desktop Integration module on a machine where you have multiple instances of JDeveloper. These latter sections provide information that is useful if you want to move the Oracle ADF Desktop Integration client framework to a directory that is independent of your JDeveloper installation.
Before you begin to integrate your desktop application with a Fusion web application, make sure that you have the required Oracle ADF modules and third-party software installed and configured:
JDeveloper
Install the current release of JDeveloper. The Oracle ADF Desktop Integration module is located in the adfdi
directory under JDEV_HOME\jdeveloper
, where JDEV_HOME
is the directory into which you installed JDeveloper. The following subdirectory of adfdi
:
bin\excel\client
contains a setup tool (setup.exe
) that installs the Oracle ADF Desktop Integration client framework on the machine where you run this tool. Section 3.5, "Setting Up the Oracle ADF Desktop Integration Client Framework" describes how to use this tool.
Microsoft Windows
Microsoft Windows XP and Vista are the only operating systems that support the development and deployment of Excel workbooks that integrate with Fusion web applications.
Microsoft Office Excel 2007
The Oracle ADF Desktop Integration module supports the integration of Fusion web applications with the following types of Excel workbook:
Excel Workbook
The default file format for Excel 2007 workbooks is the Excel 2007 XML-based file format (.xlsx
).
Excel Macro-Enabled Workbook
Workbooks in this format (.xlsm
) use the Excel 2007 XML-based file format and can store VBA macro code.
The Oracle ADF Desktop Integration module does not support the use of other Excel file formats.
Web browser
Parts of the Oracle ADF Desktop Integration module use a browser control that is hosted in a Microsoft .NET Framework web browser control. Internet Explorer 7 is the only web browser that supports this feature.
Application server
For information about the application servers that you can use to deploy an application developed using the Oracle ADF Desktop Integration module, see the certification information website at:
Microsoft Office Excel 2007 must have Microsoft .NET programmability support enabled before you can set up the Oracle ADF Desktop Integration module and start development of an Excel workbook that integrates with a Fusion web application. If you enabled Microsoft .NET programmability support during installation of Microsoft Office Excel 2007, no further action is required.
To enable Microsoft .NET programmability support:
Click the Windows Start button, click Settings > Control Panel.
In the Control Panel, select and open Add or Remove Programs.
Select the entry in the Add or Remove Programs dialog box for Microsoft Office 2007 and click Change.
Follow the instructions on the wizard that appears to enable Microsoft .NET programmability support for Microsoft Office Excel.
You must configure security settings for the Excel application so that you can successfully run an integrated Excel workbook in design mode, test mode and when published post-development. To do this, you select the checkbox for Trust access to the VBA project object model in the following procedure. Carry out this procedure once.
To allow Excel to run an integrated Excel workbook:
Open Excel.
Click the Microsoft Office button and then click Excel Options.
Click the Trust Center tab and then click Trust Center Settings.
Click the Macro Settings tab and then click the Trust access to the VBA project object model checkbox.
Click OK.
For more information about securing an Excel workbook that is integrated with a Fusion web application, see Chapter 11, "Securing Your Integrated Excel Workbook".
The Oracle ADF Desktop Integration module includes a setup tool (setup.exe
) that verifies if software in the following list is installed on the machine where you run the setup tool. If one or more of these pieces of software is not installed, the setup tool installs it in the order specified.
Windows Installer 3.1
Microsoft .NET Framework
The Microsoft .NET Framework 3.5 Service Pack 1 provides the runtime and associated files required to run applications developed to target the Microsoft .NET Framework.
Note: Installation of Microsoft .NET Framework may require you to restart the machine where you install it. After you restart, the setup tool automatically recommences to finalize installation. |
Microsoft Visual Studio Tools for Microsoft Office
The Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) Service Pack 1 (x86) is required to run VSTO solutions for the 2007 Microsoft Office system.
Oracle ADF Desktop Integration client framework
This appears as Oracle ADF 11g Desktop Integration in the Microsoft Windows Add or Remove Programs dialog box.
The following folder stores the setup.exe
tool:
JDEV_HOME\jdeveloper\adfdi\bin\excel\client
where JDEV_HOME
is the folder into which you installed JDeveloper.
Although you do not require administrator privileges to execute the setup.exe
tool, administrator privileges may be required to execute the installers for the software that setup.exe
attempts to download and install. You should also make sure that the proxy settings for Internet Explorer are configured to allow access to *.microsoft.com
because the setup.exe
tool attempts to automatically download missing prerequisite software from Microsoft's web site.
If you use multiple instances of JDeveloper or if you have an existing instance of the Oracle ADF Desktop Integration client framework on the machine where you plan to invoke the setup.exe
tool, review the information in Section 3.7, "Using the Oracle ADF Desktop Integration Module on a Machine with Multiple Instances of JDeveloper" before you carry out the following procedure.
By default, the setup.exe
tool executes in English. You can change the language that appears when the setup.exe
tool executes by following the instructions in Section 3.8, "Localizing the Setup of the Oracle ADF Desktop Integration Client Framework".
To set up the Oracle ADF Desktop Integration client framework:
Execute the setup.exe
file located in the following folder:
JDEV_HOME\jdeveloper\adfdi\bin\excel\client
Follow the instructions that appear in the dialog boxes launched by setup.exe
to successfully install the required components.
Click Yes to reboot the machine and complete the setup of the Oracle ADF Desktop Integration module.
You use the Microsoft Windows Control Panel to remove the Oracle ADF Desktop Integration client framework from the machine where you set it up. After you remove the Oracle ADF Desktop Integration client framework, you can no longer use integrated Excel workbooks on this machine unless you reinstall the framework.
To remove the Oracle ADF Desktop Integration client framework:
Click the Windows Start button and then click Settings > Control Panel.
In the Control Panel, select and open Add or Remove Programs.
In the Add or Remove Programs dialog box, select Oracle ADF 11g Desktop Integration and then click Remove.
You can have only one active installation of the Oracle ADF Desktop Integration module on a given machine. By default, the Oracle ADF Desktop Integration module is extracted to the following location:
JDEV_HOME\jdeveloper\adfdi
where JDEV_HOME
is the directory into which you installed JDeveloper. If you decide to move to another version of JDeveloper in a different directory, you must remove the old version of the Oracle ADF Desktop Integration module, as described in Section 3.6, "Removing the Oracle ADF Desktop Integration Client Framework". You must then set up the Oracle ADF Desktop Integration module provided with the new version of JDeveloper that you are moving to, as described in Section 3.5, "Setting Up the Oracle ADF Desktop Integration Client Framework".
Alternatively, set up the Oracle ADF Desktop Integration module in a directory that is independent of your JDeveloper installation. This approach means that you do not have to remove the Oracle ADF Desktop Integration module before moving to a newer version.
To set up the Oracle ADF Desktop Integration module in an independent directory:
After you install JDeveloper, copy the adfdi
directory to a directory independent of the JDeveloper installation directory. For example, you may copy the adfdi
directory to the following location:
D:\adfdiclient\adfdi
When you move to a newer version of JDeveloper, copy the contents of the following directory:
JDEV_HOME\jdeveloper\adfdi\bin\excel
to:
D:\adfdiclient\adfdi\bin\excel
where JDEV_HOME
is the directory into which you installed the new version of JDeveloper.
Execute the setup.exe
file located in the following folder:
D:\adfdiclient\adfdi\bin\excel\client
Follow the instructions that appear in the dialog boxes launched by setup.exe
to set up the new version of the Oracle ADF Desktop Integration module.
Click Yes to reboot the machine and complete the setup of the Oracle ADF Desktop Integration module.
Follow the instructions in this section to localize the setup of the Oracle ADF Desktop Integration client framework. By default, the setup tool described in Section 3.5, "Setting Up the Oracle ADF Desktop Integration Client Framework" executes in English. You download and install a language pack from the Microsoft Download Centre for the language that you want to appear when the setup tool executes.
This section assumes that no instance of the Oracle ADF Desktop Integration client framework is present on your machine and that your machine uses a non-English version of the operating system. If the Oracle ADF Desktop Integration client framework is present, remove it as described in Section 3.6, "Removing the Oracle ADF Desktop Integration Client Framework".
For information about supported operating systems, see Section 3.2, "Required Oracle ADF Modules and Third-Party Software".
To localize the setup of the Oracle ADF Desktop Integration client framework:
Download the appropriate language pack (for example, French) for Microsoft Visual Studio Tools for the Microsoft Office from the Microsoft Download Centre at:
Install the language pack that you downloaded in Step 1.
Set up the Oracle ADF Desktop Integration client framework as described in Section 3.5, "Setting Up the Oracle ADF Desktop Integration Client Framework".
The installers invoked by the setup.exe
tool appear in the language of the language pack you installed.