This section describes installation of the Excel Add-in.
The following system requirements have been identified:
Microsoft Excel 2002 (SP2) or Excel 2003 (SP1).
Windows XP (tested under Service Pack 2).
Disk space: 43MB (only 6 MB if Microsoft .NET Framework with SP1 is already installed).
RAM: 256K MB or more recommended.
The AquaLogic Data Services Platform Excel Add-in is provided with AquaLogic Data Services Platform installation as a separate installation executable. You can directly install the executable or save the executable and install it from your desktop. The Excel Add-in installs on your local machine and also is accessible from Excel as a menu item.
Preparing To Install
Prior to installing the Excel Add-in, please be sure to uninstall any previous versions of the program. Refer to the Uninstalling ALDSP Excel Add-in section for instructions on how to complete this task.
Microsoft .NET with SP1 is required for the ALDSP Excel Add-in installation. If Microsoft's .NET Framework is not installed on your system, or you have .NET 1.1 or earlier without SP1, the Excel Add-in prompts you to confirm its installation from the Microsoft Web site. Once the correct .NET install is complete, the system proceeds with the ALDSP Excel Add-in installation. (The installation of .NET could take up to 10 minutes for download and configuration.)
To install AquaLogic Data Services Platform Excel Add-in:
Locate the Excel plug-in installation file. In can be found in following directory:
where <bea_home> is the BEA installation on your system.
Double-click on the installation file:
Figure 6-1 Excel Add-in Installation
Progress through the installation program using standard Next buttons.
If you do not already have Microsoft .NET Framework 1.1 installed on your system, you will need to install it. This can be done through the Excel Add-in installation dialog.
Determine the user of the application. (Typically anyone with access to your system would be able to use the Add-in.)
Determine the location of the Add-in. By default the Add-in is installed in the following directory:
C:\Program Files\BEA\AquaLogic Data Services Platform Excel Add-in
Complete the installation, optionally launching Excel at the end of the process.
Figure 6-2 Excel Menu Post-Installation of the Excel Add-in
Accessing Excel Add-in Documentation
Once you have completed the installation, you will be able to obtain the Excel Add-in documentation:
AquaLogic Data Excel User Guide v2.pdf
This file is by default located in the following directory:
C:\Program Files\BEA\AquaLogic Data Services Platform Excel Add-in\Documentation
The documentation includes the following major topics:
Installation and uninstallation of the Excel add-in
Using the Add-in
Managing Web Services
Refreshing Web Service Data in Excel
Information on using the Add-in is also available post-installation from the Excel MyData menu option (Figure 6-2).
Generating WSDL Files for the Excel Add-in
Before you access data services through the Excel Add-in, you need to generate a Web service WSDL file. The basic steps are:
Create a Data Service control containing the functions you want to access from Excel.
Create a stateless Java Web service (.jws) from the control.
Generate a WSDL file. This file contains the necessary URL address to allow access to your data service.
Creating a WSDL File from a Data Service
Information on generating Web services, including WSDL files, from data services can be found in several locations:
Right-click on the RTLWebServices JCX (.jcx) file, selecting the Generate Test JWS File (Stateless) option, as shown in Figure 6-3.
Figure 6-3 Generating a JWS File in the RTLApp
Right-click on your newly generated JWS file, selecting the Generate WSDL File option (Figure 6-4).
Figure 6-4 Generating a WSDL File
Test and verify your JWS file before attempting to use the WSDL address in the Excel Add-in.
Obtaining a Valid WSDL URL for Use with the Excel Add-in
The URL used to access your data service must:
be based on a stateless JWS file.
be generated using the Generate WSDL File menu option, as previously described.
point directly to the generated WSDL file.
An easy way to obtain the first portion address of your generated Web service is to run your JWS file in the WebLogic Workshop Test Browser. Simply open the Web service (JWS file) in WebLogic Workshop and click the Run icon or choose Start from the Debug menu.
Figure 6-5 RTLApp ElecDBTest Web Service in Test Browser
In the above case, the URL is composed of the following elements:
Hostname. In the case of the RTLApp sample, the host name is:
Port. In the case of the RTLApp, the port is:
Path to the location of the WSDL file. In the case of the ElecWS Web service, the path is:
Then, you need to substitute the full name of your WSDL file for the rest of the address. In this example you would substitute:
Thus the full path to the WSDL in your sample that you can use in the Excel Add-in would be:
Create an EAR file for deployment. This will establish the address of your WSDL to the currently set hostname and port settings. For additional information on creating EAR files for deployment see Deploying AquaLogic Data Service Platform Applications in the Administration Guide.
Example Showing Data Service-Generated Web Service Use in Excel
Assuming that the Excel Add-in has already been installed in a local copy of Excel, the next task is to make the URL address of your WSDL available to the Excel Add in. There are several straightforward steps involved.
Access the Web services Setup option from the Excel Add-in MyData menu, as shown in Figure 6-6.
Figure 6-6 Setting Up a Web Service for the Excel Add-in
When the Web Service Definitions dialog appears click the New button.
Enter the WSDL location URL and an alias name for the WSDL (Figure 6-7). RTLWebServicesTest is used in this example. Then click OK.
Figure 6-7 Entering a WSDL Location and an Alias Name for the New Web Service
In the Web Service Definitions dialog, simply double-click on the alias name of your new service (RTLWebServicesTest) to activate the getCustomer operation wizard, as shown in (Figure 6-8).
Figure 6-8 Web Service Operation Editor in Excel Add-in
Accessing Your Data Service Through Excel
The next steps illustrate accessing a data service operation through Excel. A number of options are available; these are described in documentation referenced in
Accessing Excel Add-in Documentation on page 6-4. In this section, only a basic example is provided.
Select an operation. In the example shown in Figure 6-8, the parameterized getCustomerByCustID() operation (also the name of the underlying data service function) is selected.
Click on the Set Input tab.
Click the + symbol to the left of getCustomerByCustID.