14 Deploying Your Integrated Excel Workbook

14.3.1 How to Publish an Integrated Excel Workbook from Excel

You publish a workbook by clicking a button on the Oracle ADF tab and specifying values in the dialogs that appear, or by using the command-line publish tool. You can use the command line publish tool to publish a workbook from your Fusion web application.

To publish a workbook from Excel:

1. Open the integrated Excel workbook.

2. Ensure that the ApplicationHomeFolder and WebPagesFolder properties in the Edit Workbook Properties dialog are correct. If these properties are not set, ADF Desktop Integration prompts you to set them when you publish the integrated Excel workbook.

   For more information, see Section 4.4.3, "How to Configure a New Integrated Excel Workbook."

3. In the Oracle ADF tab, click the Publish button.

4. Specify the directory and file name for the published workbook in the Publish Workbook dialog that appears. The directory and file name that you specify for the published workbook must be different from the directory and file name for the design time workbook.

5. Click Save to save changes.

14.3.2 How to Publish an Integrated Excel Workbook Using the Command Line Publish Tool

The publish tool is run from the command line, and is available in the MW_HOME\jdeveloper\adfdi\bin\excel\tools\publish directory as publish-workbook.exe. Before you run the publish tool, open the source integrated Excel workbook and ensure that the ApplicationHomeFolder and WebPagesFolder properties in the Edit Workbook Properties dialog are correct.

Now, run the publish tool using the following syntax:

publish-workbook -workbook (-w) <source-workbook-path> -out (-o) <destination-workbook-path>

where source-workbook-path is the path of sthe ource workbook, and destination-workbook-path is the path where the published workbook is saved. Note that the destination workbook cannot have the same name as the source, even if the directory locations are different.

For example:

publish-workbook -workbook D:\Application1\Project1\ViewController\src\oracle\foddemo\masterpricelist\excel\workbook-src.xlsx -out D:\Application1\Project1\ViewController\public_html\excel\published\workbook.xlsx

After publishing the integrated Excel workbook successfully, the publish tool displays a success message. If there is any error while publishing the workbook, the publish tool aborts the process and the error messages are displayed on the command line console.

If you are using the command line publish tool, note that by default the publish tool logs messages to the command line console at information level.

Using the Publish Tool with ANT

You can create ANT scripts to run the publish tool from JDeveloper when you build your Fusion web application. You can use either of the following methods to run the utility using ANT:

• Generate an ANT build script for the project and add a target to run the workbook command line publish tool

• Generate or create a separate ANT build script for running the workbook command line publish tool

A sample ANT build script (publish-workbook.xml) to run the publish tool is available in the MW_HOME\jdeveloper\adfdi\bin\excel\samples directory. The sample ANT script demonstrates the invocation of the command-line workbook publishing tool.

14.3.3 What Happens When You Publish an Integrated Excel Workbook

When you click the Publish button in design mode, ADF Desktop Integration performs the following actions:

• Removes binding expressions that are visible in the worksheet while the workbook is in design mode.

• Changes the workbook mode to runtime mode.

• Clears the ApplicationHomeFolder, WebAppRoot, and WebPagesFolder properties from the workbook settings of the published workbook.

• Creates the published workbook with the file name you specified in the directory that you specified.

• Updates the client registry. For more information, see Section 11.3, "Checking the Integrity of an Integrated Excel Workbook's Metadata."

14.5.1 How to Configure the Fusion Web Application's Page to Pass Parameters

You insert an <af:goLink> tag and specify property values for it that reference the integrated Excel workbook the end user downloads and the values to download. You also specify the commands on the page that, when invoked, require the Fusion web application to refresh the values referenced by the <af:goLink> tag and its property values.

To configure the page in the Fusion web application:

1. In JDeveloper, insert the af:goLink tag into the page from which the end user downloads the integrated Excel workbook.

2. In the Structure window, right-click the af:goLink node and choose Go to Properties.

3. Expand the Common section and set values for the properties, as described in Table 14-1.

   Table 14-1 Properties for af:goLink Tag

   Property	Value
   Text	Write the text that appears to end users at runtime. For example, write text such as the following to appear at runtime: Download to Excel
   Destination	Invoke the expression builder to write an EL expression that specifies the integrated Excel workbook and the values to download as a URL argument: For example, write an EL expression such as the following: "/excel/workbook.xlsx?productName=#{bindings.productName.attributeValue}" Note that the runtime URL-encoded value of the EL expression to the right of ? must be less than 2048 bytes. If the runtime value exceeds 2048 bytes, the integrated Excel workbook downloads the URL arguments in the first 2048 bytes. Subsequent URL arguments do not get downloaded to the integrated Excel workbook. Instead, the Fusion web application writes log entries for these URL arguments identifying them as having not been downloaded. For example, the runtime URL-encoded value of productName=#{bindings.productName.attributeValue} must be less than 2048 bytes. Also note that if the URL contains more than 256 characters, an exception is raised when the end user downloads and opens the integrated Excel workbook without saving it. To resolve this problem, you must limit your URL length to 256 characters, or instruct the end user to save the workbook before opening it.

   
   

4. Optionally, expand the Behavior section and specify component IDs for the partialTriggers property that, when invoked, update the values of the af:goLink tag and its Destination property.

   For example, if you have navigation buttons with the IDs NextButton, PreviousButton, FirstButton, and LastButton, specify them as follows:

   :NextButton :PreviousButton :FirstButton :LastButton

5. Save the page.

   The following example shows the entries that JDeveloper generates in a JSF page using the examples in this procedure:

   <af:goLink text="Download to Excel"
   destination="/excel/workbook.xlsx?productName=#{bindings.productName.attributeValue}"
   partialTriggers=":NextButton :PreviousButton :FirstButton :LastButton"/>
   

14.5.2 How to Configure the Page Definition File for the Worksheet to Receive Parameters

You configure the page definition file associated with the worksheet in the integrated Excel workbook as follows:

• Add one or more parameter elements that initialize the worksheet with the values specified by the workbook Parameters property that you configure in Section 14.5.3, "How to Configure Parameters Properties in the Integrated Excel Workbook."

  The following example shows a parameter element in a page definition file that is associated with a worksheet in an integrated Excel workbook:

  <parameters>
      <parameter id="ProductNameParam" />
  </parameters>
  

• Add an invokeAction and a method action binding so that the page definition file associated with the worksheet initializes correctly.

  The following example shows the initializeProductTable invokeAction invoking the filterByProductName method action binding. The invokeAction is refreshed only when a value for ProductNameParam is supplied.

  <executables>
      <invokeAction Binds="filterByProductName" id="initializeProductTable"
                    Refresh="deferred"
                    RefreshCondition="${bindings.ProductNameParam != null}"/>
  ...
  </executables>
  

  The method action binding invokes a view object method (filterByProductName). The view object method takes a single String argument (ProductNameArg) that references the value of ProductNameParam.

  <bindings>
      <methodAction id="filterByProductName" RequiresUpdateModel="true"
                    Action="invokeMethod" MethodName="filterByProductName"
                    IsViewObjectMethod="true" DataControl="AppModuleDataControl"
                    InstanceName="AppModuleDataControl.ProductVO1">
        <NamedData NDName="ProductNameArg" NDValue="${bindings.ProductNameParam}"
                    NDType="java.lang.String"/>
      </methodAction>
  . . .
  </bindings>
  

For more information about configuring a page definition file, see Section 4.3, "Working with Page Definition Files for an Integrated Excel Workbook."

14.5.3 How to Configure Parameters Properties in the Integrated Excel Workbook

You configure the workbook Parameters property and the worksheet Parameters property so that the integrated Excel workbook that the end user downloads from the Fusion web application receives parameter values included in the query string of the workbook download URL.

To configure the workbook Parameters property:

1. Open the integrated Excel workbook.

2. Click Workbook Properties in the Oracle ADF tab.

3. Click the ellipsis button (...) beside the input field for Parameters to invoke WorkbookParameter Collection Editor.

4. Click Add to add a new workbook initialization parameter and configure its properties as follows:

   • (Optional) In the Annotation field, enter a description of the workbook initialization parameter.

   • In the Parameter field, specify the name of the URL argument that you configured for the af:goLink tag's Destination property as described in Section 14.5.1, "How to Configure the Fusion Web Application's Page to Pass Parameters."

5. Repeat Step 4 as necessary to add other workbook initialization parameters.

6. Click OK.

   For more information about the workbook Parameters property, see Table A-18.

To configure the worksheet Parameters property:

1. Open the integrated Excel workbook.

2. Click Worksheet Properties in the Oracle ADF tab.

3. Click the ellipsis button (...) beside the input field for Parameters to invoke the WorksheetParameter Collection Editor.

4. Click Add to add a new worksheet parameter and configure it as in Figure 14-2:

   • (Optional) In the Annotation field, enter a description of the worksheet parameter.

   • In the Parameter field, specify a parameter element that you added to the page definition file associated with the worksheet, as described in Section 14.5.2, "How to Configure the Page Definition File for the Worksheet to Receive Parameters."

   • In the Value field, write an EL expression that references the value of the Parameter property you specified for the workbook initialization parameter (workbook Parameters array). Use the following syntax when writing the EL expression:

     #{workbook.params.productName}

     where productName references the value of the Parameter property you specified for the workbook initialization parameter.

   Figure 14-2 Worksheet Parameters

   
   

5. Repeat Step 4 as necessary to add other workbook initialization parameters.

6. Click OK.

   For more information about the worksheet Parameters property, see Table A-19.

By default, the workbook parameters are not sent every time the workbook connects to the server to request metadata, the end user logs out, or the session expires. If required, you can configure the workbook to send the initialization parameters by configuring the SendParameters property.

To configure the worksheet SendParameters property:

1. Open the integrated Excel workbook.

2. Click Worksheet Properties in the Oracle ADF tab.

3. In the property inspector, set the value of SendParameters as shown in the following table and Figure 14-2:

   Set this property to...	This value...
   SendParameters	True to send workbook parameters when the workbook connects to the server to request metadata or data. When set to True, parameters are sent everytime when the metadata is requested and the first time when data is requested, during each user session. False is the default value. For more information, see Section 15.2, "Restore Server Data Context Between Sessions."

   
   

4. Click OK.

14.5.4 What Happens at Runtime When a Fusion Web Application Page Passes Parameters to an Integrated Excel Workbook

When the end user downloads the integrated Excel workbook from the Fusion web application, the af:goLink tag is evaluated and the current product name is captured and included on the URL. The adfdiExcelDownload filter embeds the names and values of all the parameters from the URL into the downloaded integrated Excel workbook.

After downloading the workbook, when the end user opens it for the first time, the active worksheet of the integrated Excel workbook is initialized. The initialization process includes fetching metadata from the web application. As part of retrieving the worksheet metadata, the stored workbook parameters (if any) are sent to the ADF Desktop Integration remote servlet and are available for application logic such as <invokeAction> executables. Specifically, the parameters are set into BindingContainer DCParameters before the binding container is refreshed. The action set in the worksheet Startup event is also executed during initialization. After initialization, the initialization status for each worksheet is recorded when the integrated Excel workbook is saved to disk.

After the integrated Excel workbook has been saved, closed, and reopened , the first-time initialization is skipped for any worksheets that were previously initialized. If workbook parameters were captured when the integrated Excel workbook was first downloaded, and those parameters are required to set up server context, then the Worksheet.ServerContext.SendParameters property should be set to True. When the SendParameters property is True, workbook parameters are sent on every request for metadata, and also on the first request for data in each user session.

To reset the initialization state for all worksheets in the workbook, invoke the ClearAllData action. For more information about the ClearAllData action, see Table A-17.