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:

Section 2.1, "Introduction to Summit Sample Application for ADF Desktop Integration"
Section 2.2, "Setting Up and Running the Summit Sample Application for ADF Desktop Integration"
Section 2.3, "Overview of the Fusion Web Application in the Summit Sample Application for ADF Desktop Integration"
Section 2.4, "Overview of the Integrated Excel Workbooks in the Summit Sample Application for ADF Desktop Integration"

2.1 Introduction to 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 Chapter 3, "Setting Up Your Development Environment", before you download and run the Summit sample application for ADF Desktop Integration.

After you have set up the development environment, download the Summit sample application for ADF Desktop Integration from OTN. For more information, see the instructions at http://www.oracle.com/technetwork/developer-tools/jdev/learnmore/adf11gsamples-1969708.html.

To download the Summit sample application for ADF Desktop Integration:

Download and install Oracle JDeveloper Release 11g. For more information, see Oracle Fusion Middleware Installation Guide for Oracle JDeveloper.
Download the Summit sample application for ADF Desktop Integration ZIP file and the Summit_Schema.zip file from Oracle Technology Network.

http://www.oracle.com/technetwork/developer-tools/jdev/learnmore/adf11gsamples-1969708.html
Install ADF Desktop Integration. For more information, see Section 3.4, "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 Section 3.6, "Upgrading ADF Desktop Integration."

To run the Summit sample application for ADF Desktop Integration:

Install the Summit schema to your database.

Navigate to the location where you downloaded the Summit ADF schema archive file and unzip it.
In JDeveloper, choose File > Open, navigate to where you expanded the ZIP file for the Summit schema directory, select the Summit_Schema.jws application workspace, and click Open.
In the Application Navigator, expand the Application Resources panel.
Right-click Connections and choose New Connection and then Database.

In the Create Database Connection dialog, modify the properties shown in Table 2-1 for your environment. For help with the dialog, press F1 or click Help.

Table 2-1 Properties Required to Install a Summit Schema Application

Property	Description
Connection Name	Descriptive name for the connection. This name must be a valid Java identifier, such as `system_for_summit`.
User Name	The system user for your database. For example: `system`
Password	The password for the system user.
Driver	The JDBC driver for the database. Select a value from the dropdown menu. The default is `thin`, which is also the default value to specify for Oracle Database XE and any other Oracle database that is not using Oracle Call Interface (OCI).
Host Name	The name of the server running the Oracle database. Use an IP address or a host name that can be resolved by TCP/IP. The default value is localhost.
SID	The unique system identifier (SID) of an Oracle Database instance. The default is XE, which is also the default value to specify if your database server is running Oracle Database XE. If your server is running another Oracle database, the SID is typically ORCL.
JDBC Port	The port of your database. The default value is `1521`.

Note:

If your server resides on a remote machine, you may also need to modify the script that builds the schema. To open the script, right-click build_summit_schema.sql and choose Open.

Click Test Connection to verify that you have a working connection, then click OK to create the connection and exit the dialog.
In the Application Navigator, in the Projects panel, expand Database and then Resources.
Right-click build_summit_schema.sql and choose Run in Sql*Plus > connection name. The connection name displayed is the one you configured in Step e.
In the SQL*Plus Connection dialog, verify that the information matches the configuration you specified in Step e and click OK.
If required, in the SQL*Plus Location dialog, click Browse and locate the sqlplus.exe executable for your database.

Typically, the executable is installed in the BIN directory under $ORACLE_HOME, where $ORACLE_HOME represents the path to your Oracle database installation.
Click Open to select the sqlplus.exe executable and then OK to exit the dialog.
In the SQL*Plus window, enter the password for the system user you specified in Step e.
Once you enter the password, the Ant build script creates the Summit ADF sample application users and populates the tables in the Summit ADF schema. In the Messages - Log window, you will see a series of SQL scripts and finally Commit complete message.

Extract the contents of Summit sample application for ADF Desktop Integration ZIP file to a local directory, and open the SummitADFdi.jws file in JDeveloper.

This file is located in the Summit_ADFDI directory.
In the Application Navigator, click and expand the Model project.
Open Model > Application Sources > oracle.summitdi.model > Model.jpx file.
Expand the Connection group of the General tab, and click the Add icon to create a database connection.

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

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

Property	Description
Username	`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.

Save the Model.jpx file.
Right-click Model project and choose Rebuild Model.jpr.
Expand the ViewController project and choose Web Content > MainPage.jsf.
Right-click MainPage.jsf and choose Run.

Note:

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

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 sample application home page.

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

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 using the slider control, or from the Available Demos dropdown list.

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

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

Menu Option	Description
Editable Table Sample	Downloads `EditCusotmers.xlsx` workbook.
Navigation Form Sample	Downloads `EditWarehouses.xlsx` workbook.
Editable Table with Web Picker	Downloads `EditableCusotmerSearch.xlsx` workbook.
Form and Table Quick Location Change	Downloads `WarehouseLocations.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 enable end users to:

Download and view customer data in a tabular format
Modify and upload the information in the workbook
Upload multiple rows of data

The EditWarehouses.xlsx workbook enable end users to:

Download and view warehouse data in a navigational format
Modify and upload warehouse information in the workbook
Upload the updated information immediately when user navigates to another record.

The EditCustomerSearch.xlsx workbook enable end users to:

Download and view customer data in a tabular format
Filter customers by Country

The WarehouseLocations.xlsx workbook enable end users to:

Download and view warehouse data and their locations in a tabular format
Modify and update the region of all warehouses
Upload the updated information

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 Warehouses tab in the Ribbon of the EditWarehouses.xlsx workbook.

Figure 2-2 Runtime Warehouses Tab

2.4.2 Downloading Data Rows

Some workbooks, such as EditCustomers.xlsx workbook, use an ADF Table component to host information downloaded 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 Application Navigator to view this file:

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

For information about how to configure a page definition file, see Section 4.3, "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 Section 7.4, "Configuring Oracle ADF Component to Download 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 Section 8.2.4, "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 EditWarehouses.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:

For information about inserting an ADF Table component, see Section 7.3, "Inserting ADF Table Component into Excel Worksheet."
For information about using Excel formulas, see Section 8.10, "Using Calculated Cells in an Integrated Excel Workbook."
For information about special columns, such as Status and Changed, see Section 7.12, "Special Columns in the ADF Table Component."

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 button that invokes the ADF Table component's Upload action. For information about implementing this functionality, see Section 7.8, "Configuring an ADF Component to Upload Changes from an ADF Table Component."