E ADF Desktop Integration Settings in the Web Application Deployment Descriptor

E.1 Configuring the ADF Desktop Integration Servlet

A Fusion web application with integrated Excel workbooks must contain entries in its deployment descriptor file (web.xml) to use the adfdiRemote servlet. The Excel workbooks that you integrate with a Fusion web application call this servlet to synchronize data with the Fusion web application. The adf-desktop-integration.jar file stores the servlet in the following directory:

MW_HOME\oracle_common\modules\oracle.adf.desktopintegration_11.1.1

where MW_HOME is the Middleware Home directory.

When you add ADF Desktop Integration to the technology scope of your project as described in Section 4.2, "Adding ADF Desktop Integration to a Fusion Web Application," ADF Desktop Integration automatically configures your deployment descriptor with the necessary entries to enable the servlet (DIRemoteServlet) on your Fusion web application. If required, then you can configure the servlet manually.

To configure the ADF Desktop Integration servlet:

1. In JDeveloper, locate and open the deployment descriptor file (web.xml) for your ADF Desktop Integration project.

   Typically, this file is located in the WEB-INF directory of your project.

2. Click the Servlets page, and then click the Add icon to create a row entry in the Servlets table. The icon is in the top-right corner of the servlets table.

   Enter the values as described in Table E-1 to enable the adfdiRemote servlet on the Fusion web application.

   Table E-1 Values to Enable adfdiRemote Servlet

   For this property...	Enter this value...
   Name	adfdiRemote
   Type	Servlet Class
   Servlet Class/JSP file	oracle.adf.desktopintegration.servlet.DIRemoteServlet

   
   

3. In Servlets page, click the Servlet Mappings tab, and then click the Add icon to create a row in the Servlet Mapping table.

   Enter the value as described in Table E-2 to add a URL pattern for the adfdiRemote servlet in the Fusion web application. The value that you enter must match the value that you specify in the integrated Excel workbook for the RemoteServletPath workbook property. Note that values are case sensitive.

   Table E-2 Values to Add A URL Pattern to adfdiRemote Servlet

   For this property...	Enter this value...
   URL Patterns	/adfdiRemoteServlet

   
   

   Figure E-1 displays the Servlets page of web.xml of Master Price List module.

   Figure E-1 Servlets Page of Deployment Descriptor

   
   

4. Click the Filters page, and verify that whether a adfBindings filter exists in the Filters table. If an entry exists, select it and proceed to the next step. If there is no such entry, then click the Add icon to create a row entry in the Filters table. The icon is available in the top-right corner of the filters table.

   Enter the values as described in Table E-3 to add the ADF binding filter to the adfdiRemote servlet.

   Table E-3 Values to Add Binding Filter to adfdiRemote Servlet

   For this property...	Enter this value...
   Name	adfBindings
   Class	oracle.adf.model.servlet.ADFBindingFilter

   
   

5. In Filters page, click the Filter Mappings tab, and then click the Add icon to create a row in the Filter Mapping table.

   Enter the values as described in Table E-4 to add the mapping filter to the adfdiRemote servlet. The filter mapping must match with the Servlet name in Step 2.

   Table E-4 Values to Add Mapping Filter to adfdiRemote Servlet

   For this property...	Enter this value...
   Mapping Type	Servlet
   Mapping	adfdiRemote

   
   

   Figure E-2 displays the Filters page of web.xml of Master Price List module.

   Figure E-2 Filters Page of Deployment Descriptor

   
   

6. Save the deployment descriptor file, and then rebuild your ADF Desktop Integration project to apply the changes you made.

E.2 Configuring the ADF Desktop Integration Excel Download Filter

ADF Desktop Integration includes an HTTP filter in the adf-desktop-integration.jar stored in the following directory:

MW_HOME\oracle_common\modules\oracle.adf.desktopintegration_11.1.1

where MW_HOME is the Middleware Home directory.

You configure an entry in the deployment descriptor file (web.xml) of your Fusion web application so that the application invokes the HTTP filter to make changes in an integrated Excel workbook before the integrated Excel workbook is downloaded by the end user from the Fusion web application. These changes ensure that the integrated Excel workbook functions correctly when the end user opens it. The HTTP filter makes the following changes:

• WebAppRoot

  Sets the value for this property to the fully qualified URL for the Fusion web application from which the end user downloads the integrated Excel workbook.

• Workbook mode

  Changes the integrated Excel workbook mode to runtime mode in case the workbook was inadvertently left in design mode or test mode.

By default, JDeveloper adds the HTTP filter to your ADF Desktop Integration project when you add ADF Desktop Integration to the technology scope of your project as described in Section 4.2, "Adding ADF Desktop Integration to a Fusion Web Application."

To configure the HTTP filter:

1. In JDeveloper, locate and open the deployment descriptor file (web.xml) for your ADF Desktop Integration project.

   Typically, this file is located in the WEB-INF directory of your project.

2. Click the Filters page, and verify that a adfBindings filter exists in the Filters table. If an entry exists, select it and proceed to the next step. If there is no such entry, then click the Add icon to create a row entry in the Filters table.

   Enter the values as described in Table E-5 to create a filter, or configure the values to modify the existing HTTP filter.

   Table E-5 Properties to Configure HTTP Filter

   For this property...	Enter this value...
   Name	adfdiExcelDownload
   Class	oracle.adf.desktopintegration.filter.DIExcelDownloadFilter
   Display Name	(Optional) In General Filter tab, enter a display name for the filter that appears in JDeveloper.
   Description	(Optional) In General Filter tab, enter a description of the filter.

   
   

3. In the Filters page, click the Filter Mappings tab, and then click the Add icon to create a row in Filter Mapping table.

   Add a filter mapping for integrated Excel workbooks that use the default file format (.xlsx) by entering values as described in Table E-6.

   Table E-6 Properties to Configure Filter Mappings

   For this property...	Enter this value...
   Mapping Type	URL Pattern
   Mapping	*.xlsx
   Dispatcher Type	No value is required for this property.

   
   

4. Add another filter mapping for integrated Excel workbooks that use the macro-enabled workbook format (.xlsm) by entering values as described in Table E-7.

   Table E-7 Properties to Configure Filter Mappings

   For this property...	Enter this value...
   Mapping Type	URL Pattern
   Mapping	*.xlsx
   Dispatcher Type	No value is required for this property.

   
   

   Figure E-3 displays the Filters page of web.xml of Master Price List module.

   Figure E-3 Filters Page of Deployment Descriptor

   
   

5. Click the Application page, expand MIME Mappings section, and click the Add icon.

   Add a MIME type for integrated Excel workbooks that use the default file format (.xlsx) by entering values as described inTable E-8.

   Table E-8 Properties to Add MIME Mappings

   For this property...	Enter this value...
   Extension	*.xlsx
   MIME Type	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

   
   

6. Add another MIME type for integrated Excel workbooks that use the macro-enabled workbook format (.xlsm) by entering values as described in Table E-9.

   Table E-9 Properties to Add MIME Mappings

   For this property...	Enter this value...
   Extension	*.xlsm
   MIME Type	application/vnd.ms-excel.sheet.macroEnabled.12

   
   

   Figure E-4 displays the Application page of web.xml of Master Price List module.

   Figure E-4 Application Page of Deployment Descriptor

   
   

7. Save the deployment descriptor file, and then rebuild your ADF Desktop Integration project to apply the changes you made.

While updating filter and filter mapping information in the web.xml file, ensure that the filter for ADF Library Web Application Support (<filter-name>ADFLibraryFilter</filter-name>) appears below the adfdiExcelDownload filter entries, so that integrated Excel workbooks can be downloaded from the Fusion web application.

E.3 Examples in a Deployment Descriptor File

The following extracts from the web.xml file of a Fusion web application with ADF Desktop Integration in its technology scope show the entries that you configure for a desktop integration project. For more information ordering of filters, see Section 4.2.2, "What Happens When You Add ADF Desktop Integration to Your JDeveloper Project."

<filter>
        <filter-name>adfBindings</filter-name>
        <filter-class>
            oracle.adf.model.servlet.ADFBindingFilter</filter-class>
        </filter>
        <filter>
            <filter-name>adfdiExcelDownload</filter-name>
            <filter-class>
                oracle.adf.desktopintegration.filter.DIExcelDownloadFilter
            </filter-class>
        </filter>
        <filter-mapping>
            <filter-name>adfBindings</filter-name>
            <servlet-name>adfdiRemote</servlet-name>
        </filter-mapping>
        <filter-mapping>
            <filter-name>adfdiExcelDownload</filter-name>
            <url-pattern>*.xlsx</url-pattern>
        </filter-mapping>
        <filter-mapping>
            <filter-name>adfdiExcelDownload</filter-name>
            <url-pattern>*.xlsm</url-pattern>
        </filter-mapping>
        <servlet>
            <servlet-name>adfdiRemote</servlet-name>
            <servlet-class>
                oracle.adf.desktopintegration.servlet.DIRemoteServlet
            </servlet-class>
        </servlet>
    <servlet-mapping>
        <servlet-name>adfdiRemote</servlet-name>
        <url-pattern>/adfdiRemoteServlet</url-pattern>
    </servlet-mapping>
    <mime-mapping>
        <extension>xlsx</extension>
        <mime-type>
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        </mime-type>
    </mime-mapping>
    <mime-mapping>
        <extension>xlsm</extension>
        <mime-type>
            application/vnd.ms-excel.sheet.macroEnabled.12
        </mime-type>
    </mime-mapping>