D Using Workbook Management Tools

This appendix describes how to use the workbook administration tool. You can use the tool to manage workbooks that you integrate with a Fusion web application.

This appendix includes the following sections:

D.1 Using the Workbook Administration Tool

Use the workbook administration tool to set values for a number of workbook properties, such as WebAppRoot, after you publish the finalized integrated Excel workbook. Use this tool if, for example, the URL of your Fusion web application changes after you publish the integrated Excel workbook.

You can also use it when you want to change workbook settings but cannot, or do not want to set values for the HTTP filter as described in Section E.2, "Configuring the ADF Desktop Integration Excel Download Filter."

The workbook administration tool is a Java-based program that can be executed on operating systems that support the version of Java used by Oracle ADF. It also requires access to the adf-desktop-integration-admin-tool.jar file, which is located in the following directory:


The other requirements for components or utilities in ADF Desktop Integration, as outlined in Chapter 3, "Setting Up Your Development Environment," do not apply to the workbook administration tool.

To change workbook settings using the workbook administration tool:

  • Open a command line console and execute the following command:

    java -cp adf-desktop-integration-admin-tool.jar oracle.adf.desktopintegration.admintool.WorkbookAdminTool <arg(s)>

where <arg(s)> is one or more of the required or optional arguments that are described in Table D-1.

Table D-1 Command-line Options for the Workbook Administration Tool

Provide a value for this argument... To... Is a value for this argument required?


Specify the directory path to the workbook to update.



Set the value for this property to the fully qualified URL for the web application to integrate your desktop application with.



Change the workbook mode to one of the following:

  • RT

    where RT specifies runtime mode.

  • DT

    where DT specifies design mode.

  • TST

    where TST specifies test mode.

For more information about workbook modes, see Section 5.1, "Introduction to Development Tools."



Specify the directory path and file name for the output file.



Specify this argument if you do not want to generate verbose output.



Print help information.


The following command creates a copy of the workbook (text.xlsx) in runtime mode (RT) for a Fusion web application (http://hostname:7101/FODADFBC) and writes it to a directory with a new file name (myresult.xlsx):

java -cp adf-desktop-integration-admin-tool.jar oracle.adf.desktopintegration.admintool.WorkbookAdminTool -workbook test.xlsx -mode RT -root http://hostname:7101/FODADFBC -out myresult.xlsx