2 Introduction to the ADF Desktop Integration Sample Application

This chapter provides an overview of the Summit sample application for ADF Desktop Integration. The Summit sample application for ADF Desktop Integration contains several Microsoft Excel workbooks that are integrated with the sample's Fusion web application.

This chapter includes the following sections:

2.1 About the Summit Sample Application for ADF Desktop Integration

The Summit sample application for ADF Desktop Integration is a set of sample demonstrations that illustrate the main capabilities from ADF Desktop Integration. Each of the samples contain specific features that can also be identified on the developer's guide. All of the samples use the same underlying database schema which makes it very easy for accessing the source code, and also to experience the runtime behavior in a standalone way.

2.2 Setting Up and Running the Summit Sample Application for ADF Desktop Integration

Set up the development environment as described in Setting Up Your Development Environment before you download and run the Summit sample application for ADF Desktop Integration.

Running the Summit sample application for ADF Desktop Integration requires you to:

  1. Download the application resources, as described in How to Download the Application Resources.
  2. Run the Summit sample application, as described in How to Run the Summit Sample Application for ADF Desktop Integration.

2.2.1 How to Download the Application Resources

You download the application resources from Oracle Technology Network.

To download the Summit sample application for ADF Desktop Integration:

  1. Download and install Oracle JDeveloper Release 12c. For more information, see Installing Oracle JDeveloper.

  2. Download the Summit sample application for ADF Desktop Integration ZIP file from Oracle Technology Network.

    http://www.oracle.com/pls/topic/lookup?ctx=E26099_01&id=jdevcodesamples

  3. Download and install the Summit ADF schema. For more information, see the "How to Install the Summit ADF Schema" section in Developing Fusion Web Applications with Oracle Application Development Framework.

  4. Install ADF Desktop Integration. For more information, see Installing ADF Desktop Integration.

    Note:

    If you have an old version of ADF Desktop Integration installed on your system, upgrade ADF Desktop Integration as described in Upgrading ADF Desktop Integration.

2.2.2 How to Run the Summit Sample Application for ADF Desktop Integration

To run the Summit sample application, extract the contents of the zip file and open the .JWS file in JDeveloper.

To run the Summit sample application for ADF Desktop Integration:

  1. Extract the contents the zip file to a local directory.

  2. Open the SummitADFdi.jws file in JDeveloper.

    This file is located in the Summit_ADFDI directory.

  3. In the Applications window, click and expand the Model project.

  4. Open Model > Application Sources > oracle.summitdi.model > Model.jpx file.

  5. Expand the Connection group of the General tab, and click the Add icon to create a database connection.

  6. In the Create Database Connection dialog, add the connection information shown in Table 2-1 for your environment.

    Table 2-1 Database Connection Properties for the Summit Sample Application for ADF Desktop Integration

    Property Description

    Username

    c##summit_adf

    Password

    summit_adf

    Host Name

    The host name for your database.

    For example:

    localhost

    JDBC Port

    The port for your database.

    For example:

    1521

    SID

    The SID of your database.

    For example:

    ORCL or XE

    Click Test Connection to verify the connection, and then click OK to close the dialog.

  7. Save the Model.jpx file.

  8. Select the ViewController project and click the Run button in JDeveloper's main menu.

2.3 Overview of the Fusion Web Application in the Summit Sample Application for ADF Desktop Integration

The Fusion web application in the Summit sample application for ADF Desktop Integration enables end users to download the integrated Excel workbooks.

2.3.1 About the Fusion Web Application in the Summit Sample Application for ADF Desktop Integration

When the end user runs the Summit sample application for ADF Desktop Integration in JDeveloper, the default browser opens the application home page. The end user can download various integrated Excel workbooks from the home page.

Figure 2-1 Home page of Summit Sample Application for ADF Desktop Integration

This image is described in the surrounding text

2.3.2 Downloading Integrated Excel Workbooks

The Summit sample application for ADF Desktop Integration provides various integrated Excel workbooks to meet different requirements. End users can navigate and download different workbooks from the MainPage.jsf of the application.

Table 2-2 lists the menu options and the downloaded integrated Excel workbooks.

Table 2-2 Integrated Excel Workbooks of Summit sample application for ADF Desktop Integration

Menu Option Description

Edit Customers Sample

Downloads EditCustomers.xlsx workbook.

Edit Warehouse Inventory Sample

Downloads EditWarehouseInventory.xlsx workbook.

Edit All Inventory Sample

Downloads EditAllInventory.xlsx workbook.

Search Customers Sample

Downloads CustomerSearch.xlsx workbook.

2.4 Overview of the Integrated Excel Workbooks in the Summit Sample Application for ADF Desktop Integration

The Summit sample application for ADF Desktop Integration provides the EditCustomers.xlsx, EditWarehouses.xlsx, EditCustomerSearch.xlsx, and WarehouseLocations.xlsx integrated Excel workbooks.

The EditCustomers.xlsx workbook illustrates the most commonly used ADF Desktop Integration ADF Table component features. You can download, insert, update and commit data. It also demonstrates multiple ways to choose a value from a list of choices.

The EditWarehouseInventory.xlsx workbook illustrates how to use ADF Desktop Integration form components with a detail table. You can download and update data in a master form and its detail table. This sample also demonstrates how to use workbook parameters to control the workbook initialization.

The EditAllInventory.xlsx workbook demonstrates how to create an editable table with a denormalized master-detail relationship. It also demonstrates how to use a date picker, group columns, and delete existing data records.

The EditCustomerSearch.xlsx workbook demonstrates how a custom web page can be used to perform a search prior to downloading data into an ADF Table component configured to be read-only.

Subsequent sections in this chapter provide more information about the functionality in the workbooks along with cross-references to implementation details.

2.4.1 Log on to the Fusion Web Application from an Integrated Excel Workbook

At runtime, the integrated Excel workbooks in the Summit sample application for ADF Desktop Integration render an Excel ribbon tab that allows end users to log on to the Fusion web application. Figure 2-2 shows the runtime Customers tab in the Ribbon of the EditCustomers.xlsx workbook.

Figure 2-2 Runtime Customers Tab

This image is described in the surrounding text

2.4.2 Downloading Data Rows

Some workbooks, such as EditCustomers.xlsx workbook, use an ADF Table component to download information from the Fusion web application. This component allows end users to edit rows and upload modified rows to the Fusion web application.

The following sections provide information about how to implement the download functionality:

  • Each worksheet that you integrate with a Fusion web application requires an associated page definition file.

    For example, the Customers worksheet in the EditCustomers.xlsx workbook is associated with the ExcelCustomers.xml page definition file. In JDeveloper, expand the following nodes in the Applications window to view this file:

    ViewController > Application Sources > oracle.summitdi.view > pageDefs

    For information about how to configure a page definition file, see Working with Page Definition Files for an Integrated Excel Workbook.

  • The ADF Table component Download action downloads data from the Fusion web application to the worksheet. For information about how you invoke this action, see Downloading Data to an ADF Table Component.

  • In the EditCustomers.xlsx workbook, the worksheet Startup event invokes an action set that includes the ADF Table component Download action. For information about configuring worksheet events, see How to Invoke an Action Set from a Worksheet Event.

2.4.3 Modify Customers and Warehouses Information in the Workbooks

The EditCustomers.xlsx and EditWarehouseInventory.xlsx workbooks enable end users to edit customers and warehouses information that the ADF Table component and form components downloads from the Fusion web application. Columns in the runtime ADF Table component that have an UpdateComponent property configured permit end users to modify values and upload the changes to the Fusion web application. For example, end users can modify the values that appear in the Name, Phone, and Address columns in EditCustomers.xlsx.

Other columns, such as Status and Changed, appear in the ADF Table component to provide status information about upload operations and changed columns.

The following sections provide information about how to implement this functionality:

2.4.4 Upload Modified Information to the Fusion Web Application

The integrated workbooks allow end users to upload modified data in the ADF Table component to the Fusion web application. An action set is configured for the runtime Upload ribbon command that invokes the ADF Table component's Upload action. For information about implementing this functionality, see Uploading Changes from an ADF Table Component .