0% found this document useful (0 votes)

11 views90 pages

Administrators Guide For Oracle Application Develpment Framework

The Oracle Fusion Middleware Administrator's Guide for Oracle Application Development Framework provides comprehensive instructions for administrators on deploying, monitoring, and configuring ADF applications. It includes details on ADF architecture, deployment processes, performance monitoring, and configuration settings. The guide is intended for system administrators and is part of Oracle's documentation suite for ADF applications.

Uploaded by

Marlon Figueroa

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

11 views90 pages

Administrators Guide For Oracle Application Develpment Framework

Uploaded by

Marlon Figueroa

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 90

Oracle® Fusion Middleware

Administrator's Guide for Oracle Application Development

Framework
11g Release 2 (11.1.2.3.0)
E16179-04

August 2012
Documentation for Oracle Application Development
Framework (Oracle ADF) administrators that describes how
to deploy, monitor, and configure ADF applications.
Oracle Fusion Middleware Administrator's Guide for Oracle Application Development Framework 11g
Release 2 (11.1.2.3.0)
E16179-04

Primary Authors: Peter Jew (Lead), Liza Rekadze

Contributing Author: Odile Sullivan-Tarazi, Himanshu Marathe, Cammy Moore

Contributors: Lynn Munsinger, Duncan Mills, Dipankar Bajpai, Harry Hsu, Ray Maslinski

This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it
on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data
delivered to U.S. Government customers are "commercial computer software" or "commercial technical data"
pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As
such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and
license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of
the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software
License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications, including
applications that may create a risk of personal injury. If you use this software or hardware in dangerous
applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other
measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages
caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks
are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,
Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced
Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle
Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your
access to or use of third-party content, products, or services.
Contents

Preface ................................................................................................................................................................ vii

Audience...................................................................................................................................................... vii
Documentation Accessibility .................................................................................................................... vii
Related Documents .................................................................................................................................... vii
Conventions ............................................................................................................................................... viii

What's New in This Guide in Release 11.1.2.3.0 ........................................................................ ix

Part I Understanding Oracle ADF

1 Introduction to Oracle ADF Administration

1.1 Introducing Oracle ADF ............................................................................................................ 1-1
1.2 Oracle ADF Architecture ........................................................................................................... 1-1
1.2.1 ADF Business Components................................................................................................ 1-2
1.2.2 ADF Model ........................................................................................................................... 1-2
1.2.3 ADF Controller..................................................................................................................... 1-2
1.2.4 ADF Faces Rich Client......................................................................................................... 1-2
1.3 Administering Oracle ADF Applications................................................................................ 1-3

Part II Administering ADF Applications

2 Deploying ADF Applications

2.1 Introduction to Deploying ADF Applications........................................................................ 2-1
2.2 Preparing the Standalone Application Server for Deployment ........................................... 2-2
2.2.1 How to Install the ADF Runtime to the Application Server Installation .................... 2-4
2.2.1.1 Installing the ADF Runtime into an Existing WebLogic Server Installation Using
the Oracle Fusion Middleware Application Developer Installer 2-4
2.2.1.2 Installing the ADF Runtime into an Existing WebSphere Application Server
Installation Using the Oracle Fusion Middleware Application Developer Installer
2-5
2.2.2 How to Create and Extend Oracle WebLogic Server Domains .................................... 2-5
2.2.2.1 Creating an Oracle WebLogic Server Domain for Oracle ADF ............................. 2-5
2.2.2.2 Extending the Oracle WebLogic Server Domain for Oracle ADF ......................... 2-6
2.2.2.3 Setting Up Remote WebLogic Managed Servers for Oracle ADF ......................... 2-6
2.2.3 How to Create a JDBC Data Source for Oracle WebLogic Server ................................ 2-8

iii
2.2.4 How to Create a JDBC Data Source for IBM WebSphere Application Server ............ 2-9
2.3 Deploying Using Oracle Enterprise Manager Fusion Middleware Control ...................... 2-9
2.4 Deploying Using Scripting Commands................................................................................... 2-9
2.5 Deploying Using Scripts and Ant.......................................................................................... 2-10
2.6 Deploying Using the Application Server Administration Tool ........................................ 2-10

3 Monitoring and Configuring ADF Applications

3.1 Introduction to ADF Application Monitoring and Configuration ...................................... 3-1
3.2 Monitoring Performance Using Fusion Middleware Control.............................................. 3-2
3.2.1 How to View Application Module Performance ............................................................ 3-2
3.2.2 How to view Application Module Pool Performance.................................................... 3-3
3.2.3 How to View ADF Task Flow Performance .................................................................... 3-4
3.3 Configuring Application Properties Using Fusion Middleware Control........................... 3-5
3.3.1 How to Modify ADF Business Components Parameters .............................................. 3-5
3.3.2 How to Modify Connection Configurations................................................................. 3-14
3.4 Configuring Application Properties Using the MBean Browser ...................................... 3-21
3.4.1 How to Modify ADF Application Configuration Using MBean ............................... 3-21
3.4.2 How to Modify ADF Connections Using MBean ........................................................ 3-22
3.4.3 How to Modify ADF Business Components Configuration Using MBeans............ 3-24
3.4.4 How to Modify MDS Configuration Using MBean..................................................... 3-24
3.4.5 How to Modify Active Data Service Configuration Using MBean ........................... 3-25
3.5 How to Edit Credentials Deployed with the Application ................................................. 3-27
3.6 Diagnosing Problems using the Diagnostic Framework ................................................... 3-27
3.7 Viewing Application Metric Information with DMS SPY ................................................. 3-28
3.8 Configuring WebSphere Application Server ....................................................................... 3-28
3.8.1 How to Configure WebSphere to Allow Reuse of Query Result Sets....................... 3-28

4 WLST Command Reference for ADF Applications

4.1 Overview of Custom WSLT Commands for Oracle ADF..................................................... 4-1
4.2 ADF-Specific WLST Commands............................................................................................... 4-1
4.2.1 adf_createFileUrlConnection ............................................................................................. 4-2
4.2.1.1 Description .................................................................................................................... 4-2
4.2.1.2 Syntax ............................................................................................................................. 4-2
4.2.1.3 Example.......................................................................................................................... 4-2
4.2.2 adf_createHttpUrlConnection ........................................................................................... 4-2
4.2.2.1 Description .................................................................................................................... 4-2
4.2.2.2 Syntax ............................................................................................................................. 4-3
4.2.2.3 Example.......................................................................................................................... 4-3
4.2.3 adf_setURLConnectionAttributes ..................................................................................... 4-3
4.2.3.1 Description .................................................................................................................... 4-3
4.2.3.2 Syntax ............................................................................................................................. 4-3
4.2.3.3 Example.......................................................................................................................... 4-3
4.2.4 adf_listUrlConnection ......................................................................................................... 4-3
4.2.4.1 Description .................................................................................................................... 4-3
4.2.4.2 Syntax ............................................................................................................................. 4-4
4.2.4.3 Example.......................................................................................................................... 4-4
4.2.5 getADFMArchiveConfig .................................................................................................... 4-4

iv
4.2.5.1 Description .................................................................................................................... 4-4
4.2.5.2 Syntax ............................................................................................................................. 4-4
4.2.5.3 Example.......................................................................................................................... 4-5
4.2.6 exportJarVersions ................................................................................................................ 4-6
4.2.6.1 Description .................................................................................................................... 4-6
4.2.6.2 Syntax ............................................................................................................................. 4-6
4.2.6.3 Example.......................................................................................................................... 4-6
4.2.7 exportApplicationJarVersions ........................................................................................... 4-6
4.2.7.1 Description .................................................................................................................... 4-6
4.2.7.2 Syntax ............................................................................................................................. 4-6
4.2.7.3 Example.......................................................................................................................... 4-7
4.2.8 exportApplicationSelectedJarVersions ............................................................................. 4-7
4.2.8.1 Description .................................................................................................................... 4-7
4.2.8.2 Syntax ............................................................................................................................. 4-7
4.2.8.3 Example.......................................................................................................................... 4-7

Part III Appendices

A ADF Runtime Libraries

A.1 Using JDeveloper to Find the ADF Runtime Library ........................................................... A-1
A.2 adf.oracle.domain.webapp.war Library ................................................................................. A-1
A.3 adf.oracle.domain.ear Library.................................................................................................. A-4
A.4 System Classpath ....................................................................................................................... A-6
A.5 adf.desktopintegration.war Library ........................................................................................ A-9

B wsadmin Command Reference for ADF Applications

B.1 Overview of Custom wsadmin Commands for Oracle ADF .............................................. B-1
B.2 ADF-Specific WebSphere Commands .................................................................................... B-1
B.2.1 createFileUrlConnection .................................................................................................... B-2
B.2.1.1 Description ................................................................................................................... B-2
B.2.1.2 Syntax ............................................................................................................................ B-2
B.2.1.3 Example......................................................................................................................... B-2
B.2.2 createHttpUrlConnection .................................................................................................. B-2
B.2.2.1 Description ................................................................................................................... B-2
B.2.2.2 Syntax ............................................................................................................................ B-2
B.2.2.3 Example......................................................................................................................... B-2
B.2.3 setURLConnectionAttributes............................................................................................ B-2
B.2.3.1 Description ................................................................................................................... B-3
B.2.3.2 Syntax ............................................................................................................................ B-3
B.2.3.3 Example......................................................................................................................... B-3
B.2.4 listUrlConnection................................................................................................................ B-3
B.2.4.1 Description ................................................................................................................... B-3
B.2.4.2 Syntax ............................................................................................................................ B-3
B.2.4.3 Example......................................................................................................................... B-3
B.2.5 getADFMArchiveConfig ................................................................................................... B-3
B.2.5.1 Description ................................................................................................................... B-3

v
B.2.5.2 Syntax ............................................................................................................................ B-4
B.2.5.3 Example......................................................................................................................... B-5

C Configuring GlassFish Server

C.1 About Configuring GlassFish .................................................................................................. C-1
C.2 Obtaining GlassFish Server and Oracle ADF Runtime ........................................................ C-1
C.2.1 How to Obtain GlassFish Server ...................................................................................... C-2
C.2.2 How to Obtain Oracle ADF Runtime .............................................................................. C-2
C.3 Configuring GlassFish with ADF Runtime Libraries ........................................................... C-2
C.3.1 How to Install ADF Share Libraries Manually............................................................... C-2
C.4 Additional Configuration Tasks .............................................................................................. C-3
C.4.1 GlassFish Administration Console................................................................................... C-4
C.4.2 How to Create a Datasource for GlassFish ..................................................................... C-4
C.4.3 How to Configure the JVM Cache.................................................................................... C-4
C.5 Deploying an ADF Application to GlassFish ........................................................................ C-5

vi
Preface

Welcome to Administrator's Guide for Oracle Application Development Framework.

Audience
This document is intended for system administrators who need to deploy, manage,
monitor, and configure Oracle ADF applications using the Oracle Application
Development Framework (Oracle ADF).

Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For
information, visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are
hearing impaired.

Related Documents
For more information, see the following documents:
Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development
Framework
Oracle Fusion Middleware Administrator's Guide
Oracle Fusion Middleware Web User Interface Developer's Guide for Oracle Application
Development Framework
Oracle Fusion Middleware Desktop Integration Developer's Guide for Oracle Application
Development Framework
Oracle Fusion Middleware Security Guide
Oracle Fusion Middleware WebLogic Scripting Tool Command Reference
Oracle Fusion Middleware High Availability Guide
Oracle Fusion Middleware Third-Party Application Server Guide

vii
Oracle JDeveloper 11g Online Help
Oracle JDeveloper 11g Release Notes, included with your JDeveloper 11g installation, and
on Oracle Technology Network
Oracle Fusion Middleware Java API Reference for Oracle ADF Model
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller
Oracle Fusion Middleware Java API Reference for Oracle ADF Lifecycle
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
Oracle Fusion Middleware JavaScript API Reference for Oracle ADF Faces
Oracle Fusion Middleware Java API Reference for Oracle ADF Data Visualization
Components
Oracle Fusion Middleware Java API Reference for Oracle ADF Share
Oracle Fusion Middleware Java API Reference for Oracle ADF Business Components Browser
Oracle Fusion Middleware Java API Reference for Oracle Generic Domains
Oracle Fusion Middleware interMedia Domains Java API Reference for Oracle ADF Business
Components
Oracle Fusion Middleware Java API Reference for Oracle Metadata Service (MDS)

Conventions
The following text conventions are used in this document:

Convention Meaning
boldface Boldface type indicates graphical user interface elements associated
with an action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for
which you supply particular values.
monospace Monospace type indicates commands within a paragraph, URLs, code
in examples, text that appears on the screen, or text that you enter.

viii
What's New in This Guide in Release
11.1.2.3.0

For Release 11.1.2.3.0, this guide has been updated in several ways. The following
table lists the sections that have been added or changed.
For changes made to Oracle JDeveloper and Oracle Application Development
Framework (Oracle ADF) for this release, see the What’s New page on the Oracle
Technology Network at
http://www.oracle.com/technetwork/developer-tools/jdev/documenta
tion/index.html.

Sections Change Description

Chapter 4, "WLST Command Reference for ADF
Applications"
Section 4.2.6, "exportJarVersions" Added new command.for
exporting JARs versions
information to a CSV file.
Section 4.2.7, "exportApplicationJarVersions" Added new command.for
exporting runtime JARs
versions information for an
application to a CSV file.
Section 4.2.8, "exportApplicationSelectedJarVersions" Added new command.for
exporting selected JARs
versions information (using
the versions.xml file) to a
CSV file.
Appendix C, "Configuring GlassFish Server"
Appendix C, "Configuring GlassFish Server" Added new appendix with
instructions to configure
GlassFish Server to run ADF
applications.

ix
x
Part I
Part I Understanding Oracle ADF

Part I contains the following chapters:

■ Chapter 1, "Introduction to Oracle ADF Administration"
1
Introduction to Oracle ADF Administration
1

This chapter describes the administrative tasks you can perform and the tools you can
use to deploy, manage, monitor, and configure applications developed for the Oracle
Application Development Framework (Oracle ADF).
This chapter includes the following sections:
■ Section 1.1, "Introducing Oracle ADF"
■ Section 1.2, "Oracle ADF Architecture"
■ Section 1.3, "Administering Oracle ADF Applications"

1.1 Introducing Oracle ADF

The Oracle Application Development Framework (Oracle ADF) builds on Java
Platform, Enterprise Edition (Java EE) standards and open-source technologies to
provide a complete framework for implementing service-oriented applications. You
can use this framework to provide enterprise solutions across different platforms. You
can build applications that search, display, create, modify, and validate data for web,
web services, desktop, or mobile interfaces.
You use Oracle JDeveloper 11g with Oracle ADF to develop applications with an
environment that supports the full development lifecycle of design, test, and
deployment. For more information about ADF development, see Oracle Fusion
Middleware Fusion Developer's Guide for Oracle Application Development Framework.
After you have developed and tested your ADF application in test environments, you
can deploy your application to production environments using the tools described in
this book. You can monitor the performance of applications as they are running. You
can also manage and configure properties and attributes.

1.2 Oracle ADF Architecture

Oracle ADF supports the industry-standard model-view-controller architecture to
achieve separation of business logic, navigation, and user interface. The MVC
architecture provides:
■ A model layer that represents the data values
■ A view layer that contains the UI components
■ A controller layer that handles input and navigation
■ A business service layer that encapsulates business logic
The Fusion web application technology stack components are:

Introduction to Oracle ADF Administration 1-1

Oracle ADF Architecture

■ ADF Model, for accessing declarative data binding metadata

■ ADF Business Components, for building business services
■ ADF Faces rich client, for AJAX-enabled UI components for web applications built
with JavaServer Faces (JSF)
■ ADF Controller, for input processing, navigation, and reusable task flows

1.2.1 ADF Business Components

ADF Business Components are application objects you can use to implement
service-oriented Java EE applications. You implement ADF Business Components for
clients to query, insert, update, and delete business data. You can apply business rules
to the Business Components to enforce proper usage. The key components of ADF
Business Components are the entity object, the view object, and the application
module.
An entity object represents a row in a database table. It uses data manipulation
language (DML) operations to modify data. Entity objects are used with others to
reflect relationships in the database schema.
A view object represents a SQL query. You use the SQL Language to query the database
to obtain the results. You can also link a view object with other entity objects to create
master-detail hierarchies.
An application module is the transactional component that allows UI components to
access data. It presents a data model and methods to perform certain tasks.

1.2.2 ADF Model

ADF Model implements a service abstraction called data control. Data control uses
metadata interfaces to abstract business services. This metadata is used to describe
data collections, properties, methods, and types. In JDeveloper, data controls appear in
the Data Controls panel. When you drag and drop attributes, collections, and methods
onto a page, JDeveloper automatically creates the bindings from the page to the
associated services.

1.2.3 ADF Controller

ADF Controller provides a navigation and state management model that works with
JSF. You can create navigational flows called task flows that encapsulate a specific task
sequence.

1.2.4 ADF Faces Rich Client

ADF Faces provides over 100 rich components that can be used out of the box to create
web applications. ADF Faces components provide built-in AJAX functionality to allow
requests to be sent to the server without fully rendering the page. JSF provides
server-side control to reduce the dependency on JavaScript. The components support
skinning, internationalization, and accessibility options.
ADF Faces has a large set of components, including tables, trees, dialogs, accordions,
and a variety of layout components. It also includes ADF Data Visualization
components, which are Flash- and SVG-enabled, for displaying graphs, charts, and
gauges.

1-2 Administrator's Guide for Oracle Application Development Framework

Administering Oracle ADF Applications

1.3 Administering Oracle ADF Applications

You can perform a variety of administration tasks on ADF applications. You can
deploy ADF applications using Enterprise Manager Fusion Middleware Control,
WLST commands, the ojdeploy command, scripts, or the WebLogic Administration
Console.
After the ADF application has been deployed, you can configure application
properties using Enterprise Manager Fusion Middleware Control. You can also
configure some properties using the MBean Browser to change values in the ADF
MBeans. For example, you can use Enterprise Manager Fusion Middleware Control to
change the URL connection or WebService connection endpoints or seed the
production credentials.
When you run the application, you can monitor performance data on the application
modules, application module pooling, and task flows.

Introduction to Oracle ADF Administration 1-3

Administering Oracle ADF Applications

1-4 Administrator's Guide for Oracle Application Development Framework

Part II
Part II Administering ADF Applications

Part II contains the following chapters:

■ Chapter 2, "Deploying ADF Applications"
■ Chapter 3, "Monitoring and Configuring ADF Applications"
■ Chapter 4, "WLST Command Reference for ADF Applications"
2
Deploying ADF Applications
2

This chapter describes how to deploy Oracle ADF applications packaged as an EAR
file to a target application server. It also describes how to use scripts and Ant to
automate the deployment process. This chapter focuses on deploying ADF
applications for production and later stage testing. For information about deploying
ADF applications for development, see the Oracle Fusion Middleware Developer's Guide
for Oracle Application Development Framework.
For deploying to third-party application servers, such as IBM WebSphere Application
Server, see the Oracle Fusion Middleware Third-Party Application Server Guide.
This chapter includes the following sections:
■ Section 2.1, "Introduction to Deploying ADF Applications"
■ Section 2.2, "Preparing the Standalone Application Server for Deployment"
■ Section 2.3, "Deploying Using Oracle Enterprise Manager Fusion Middleware
Control"
■ Section 2.4, "Deploying Using Scripting Commands"
■ Section 2.5, "Deploying Using Scripts and Ant"
■ Section 2.6, "Deploying Using the Application Server Administration Tool"

2.1 Introduction to Deploying ADF Applications

Deployment is the process of packaging application files and artifacts and transferring
them to a target application server to be run. During application development using
JDeveloper, developers can test the application using the Integrated WebLogic Server
that is built into the JDeveloper installation, or they can use JDeveloper to directly
deploy to a standalone application server.
After the application has been developed, administrators can deploy the application to
production application servers. The tools that the administrators use for
production-level deployment are:
■ Oracle Enterprise Manager Fusion Middleware Control
■ WebLogic Scripting Tool (WLST) commands or WebSphere Application Server
(wsadmin) commands
■ Command scripts and Ant scripts
■ Oracle WebLogic Administration Console or WebSphere Administrative Console
This chapter describes the tools and methods that administrators use to deploy ADF
applications. For information about deploying ADF applications for development and

Deploying ADF Applications 2-1

Preparing the Standalone Application Server for Deployment

testing purposes using JDeveloper, see the Oracle Fusion Middleware Developer's Guide
for Oracle Application Development Framework.
If your application uses customization, you may need to set up the MDS repository in
the application server. For more information about MDS, see the Oracle Fusion
Middleware Administrator's Guide.

Note: Developers, Test, and QA personnel may also use these tools
and the methods in this chapter to deploy ADF applications to staging
application servers.

2.2 Preparing the Standalone Application Server for Deployment

To run ADF applications, you must install the standalone application server with the
ADF runtime. You can include the ADF runtime during a new application server
installation or you can install the ADF runtime into an existing application server
installation.
Figure 2–1 shows the flow diagram for preparing a standalone application server for
deployment. Note the following definitions used in the diagram:
■ OWSM: Oracle Web Services Manager
■ JRF: Java Required Files
■ RCU: Repository Creation Utility
■ MDS: Metadata Store

2-2 Administrator's Guide for Oracle Application Development Framework

Preparing the Standalone Application Server for Deployment

Figure 2–1 Preparing the Application Server Flow Diagram

For WebLogic Server, the following points apply:

■ After WebLogic Server has the ADF runtime installed, you can create a new
WebLogic Server domain or you can extend an existing WebLogic Server domain
for Oracle ADF.
■ If the Managed Servers are on a different host than the Administration Server, you
must perform additional configuration tasks for the Managed Servers to enable
them to host ADF applications.
■ An ADF application will use either a JDBC data source or a JDBC URL to access its
data. You can configure WebLogic Server with the data source using the Oracle
WebLogic Server Administration Console.
For WebSphere Application Server, the following points apply:

Deploying ADF Applications 2-3

Preparing the Standalone Application Server for Deployment

■ After WebSphere Application Server has the ADF runtime installed, you can
create a new WebSphere cell or you can extend an existing WebSphere cell for
ADF.
■ If the servers are on a different node than the Deployment Manager, you must
perform additional configuration tasks for the servers to enable them to host ADF
applications.
■ An ADF application will use either a JDBC data source or a JDBC URL to access its
data. You can configure WebSphere Application Server with the data source using
the WebSphere Administrative Console.

2.2.1 How to Install the ADF Runtime to the Application Server Installation
The application server requires the ADF runtime to run ADF applications.
Installing the ADF runtime is not required if you are using JDeveloper to run
applications in Integrated WebLogic Server.
For WebLogic Server, you can install the ADF runtime using the following installers:
■ Oracle Fusion Middleware 11g Application Developer Installer: Installs the ADF
runtime and Oracle Enterprise Manager. You should use the Oracle Fusion
Middleware 11g Application Developer Installer if you want to use Oracle
Enterprise Manager to manage standalone ADF applications (without Oracle SOA
Suite or Oracle WebCenter components). You must have already installed Oracle
WebLogic Server before you can use this installer.

Note: The Oracle 11g Installer for JDeveloper can also be used to
install the ADF runtime to the application server installation.
However, it does not include all the components that are typically
needed for production and full test environments. Therefore, this
installer should not be used for anything other than for development
purposes.

For WebSphere Application Server, you can install the ADF runtime using the
following installer:
■ Oracle Fusion Middleware 11g Application Developer Installer: Installs the ADF
runtime and Oracle Enterprise Manager. You must have already installed
WebSphere Application Server before you can use this installer. For more
information, see the Oracle Fusion Middleware Third-Party Application Server Guide.

2.2.1.1 Installing the ADF Runtime into an Existing WebLogic Server Installation
Using the Oracle Fusion Middleware Application Developer Installer
You can use the Oracle Fusion Middleware 11g Application Developer Installer to
install the ADF runtime and Enterprise Manager.
Install Oracle WebLogic Server. You must also have obtained the Oracle Fusion
Middleware 11g Application Developer Installer.
Use the instructions in the Oracle Fusion Middleware Installation Planning Guide to obtain
the software, start the installer, and to complete the installation.
In the installer you will perform several tasks including:
■ Adding any software updates
■ Selecting the WebLogic Server directory for installation

2-4 Administrator's Guide for Oracle Application Development Framework

Preparing the Standalone Application Server for Deployment

■ Verifying installation information

After you have installed the ADF runtime, follow the instructions in Section 2.2.2,
"How to Create and Extend Oracle WebLogic Server Domains," to use the Oracle
Fusion Middleware Configuration Wizard to create or extend the Oracle WebLogic
Server domain.

2.2.1.2 Installing the ADF Runtime into an Existing WebSphere Application Server
Installation Using the Oracle Fusion Middleware Application Developer Installer
You can use the Oracle Fusion Middleware 11g Application Developer Installer to
install the ADF runtime and Enterprise Manager.
Before you begin, you must already have a WebSphere Application Server installation.
Use the instructions in the Oracle Fusion Middleware Installation Planning Guide to obtain
the software and to start the installer.
In the installer you will perform several tasks including:
■ Adding any software updates
■ Selecting the WebSphere directory for installation
■ Verifying installation information
After you have installed the ADF runtime, configure the cells and perform other tasks
as described in the Oracle Fusion Middleware Third-Party Application Server Guide and
the Oracle Fusion Middleware Configuration Guide for WebSphere.

2.2.2 How to Create and Extend Oracle WebLogic Server Domains

You need to create and configure the Oracle WebLogic Server domain to accept ADF
applications. If you do not already have a domain, you need to create one. If you
already have a domain, you must extend the domain before it can run ADF
applications.
If you are using Managed Servers to run your applications, you may need to configure
your Managed Server. For more information about configuring a Managed Server on
Oracle WebLogic Server, see Oracle Fusion Middleware Creating Domains Using the
Configuration Wizard.
If you are setting up Managed Servers for ADF where the Managed Servers are on the
same host as the Administration Server, follow the instructions described in this
section.
If you are setting up to deploy to Managed Servers that are on a different host than the
Administration Server, perform the additional steps described in Section 2.2.2.3,
"Setting Up Remote WebLogic Managed Servers for Oracle ADF."

2.2.2.1 Creating an Oracle WebLogic Server Domain for Oracle ADF

You must create an Oracle WebLogic Server domain if it does not already exist.

To create a new Oracle WebLogic Server domain:

Deploying ADF Applications 2-5

Preparing the Standalone Application Server for Deployment

3. In the Select Domain Source page, select Generate a domain configured

automatically to support the following products.
The option Basic WebLogic Server Domain (Required) is already selected.
Select Oracle JRF. If you are using Oracle Web Services, select Oracle WSM Policy
Manager and click Next.

2.2.2.2 Extending the Oracle WebLogic Server Domain for Oracle ADF

Before you begin:

You must already have an existing Oracle WebLogic Server domain with the ADF
runtime installed.

To extend an Oracle WebLogic Server domain for ADF:

1. Start the Oracle Fusion Middleware Configuration wizard as described in the
"Configuring Application Developer" chapter of the Oracle Fusion Installation Guide
for Application Developer.
Follow the directions as described in that guide but consider the following steps.
2. In the Welcome page, select Extend an existing WebLogic domain and click Next.
3. In the Select a WebLogic Domain Directory page, select the location of the domain
you want to configure for Oracle ADF, and click Next.
4. In the Select Extension Source page, select Extend my domain automatically to
support the following added products.
The option Basic WebLogic Server Domain (Required) is already selected.
Select Oracle JRF. If you are using Oracle Web Services, select Oracle WSM Policy
Manager and click Next.
This configures the rest of the runtime .jar files using the manifest file.

Note: Your application's EAR file must have a

weblogic-application.xml file containing a reference to the
adf.oracle.domain shared library.

You can now start Oracle WebLogic Server by running the command-line script
ORACLE_HOME\user_projects\domains\domain_
name\bin\startWebLogic.cmd, and you can stop the server using the
stopWebLogic.cmd script in the same directory. For Linux platforms, use
\bin\startWebLogic.sh and stopWebLogic.sh respectively.
Access the Oracle WebLogic Server Administration Console using the URL
http://localhost:7001/console.

2.2.2.3 Setting Up Remote WebLogic Managed Servers for Oracle ADF

If the WebLogic Managed Servers are on a different host than the Administration
Server, you need to perform additional steps.
You will need to set up Managed Servers for Oracle ADF on the host with the
Administration Server, pack the JRF template, copy it to the remote host, and unpack
the template.

2-6 Administrator's Guide for Oracle Application Development Framework

Preparing the Standalone Application Server for Deployment

To set up remote Managed Servers for Oracle ADF:

1. Use the Oracle Installer for JDeveloper to install Oracle WebLogic Server
installations on both the local and remote hosts, if not already installed. If you are
not installing JDeveloper Studio, you need to select the Application Development
Framework Runtime option in the installer. The local host is the host with the
Administration Server.
Or, if there are existing Weblogic Server installations, use the Oracle Installer for
JDeveloper to install the ADF runtime into the WebLogic Server installations on
both hosts by selecting the Application Development Framework Runtime
option. For more information on installation, see Section 2.2.1, "How to Install the
ADF Runtime to the Application Server Installation."
2. Run the Oracle Fusion Middleware Configuration Wizard to create a new Oracle
WebLogic Server domain. In the wizard, select the Oracle JRF option, as described
in Section 2.2.2.1, "Creating an Oracle WebLogic Server Domain for Oracle ADF."
3. On the local host, run the Oracle Fusion Middleware Configuration Wizard to
create Managed Servers.
4. On the local host, start the Administration Server and the Managed Server.
For example,
cd ORACLE_HOME/user_projects/domain/base_domain/bin
./startWeblogic.sh
./startManagedWebLogic.sh ManagedServer_1 http://localhost:7001

5. On the local host, pack the Managed Server configuration information into a JAR
and then copy the JAR to the remote host. This JAR contains the JRF template
information.
For example,
cd ORACLE_HOME/oracle_home/common/bin

./pack.sh -managed=true -domain=../../../user_projects/domains/base_domain

-template=../../../base_domain_managed.jar -template_name=
"Base Managed Server Domain"

cp ../../../base_domain_managed.jar remote_machine_ORACLE_HOME/

6. On the remote host, unpack the Managed Server configuration JAR.

For example,
cd ORACLE_HOME/oracle_common/common/bin
./unpack.sh -domain=../../../user_projects/domains/base_domain
-template=../../../base_domain_managed.jar

If the Managed Server was created after the domain was, you must delete the
entire domain configuration directory of the Managed Server before running
unpack.
7. On the remote host, start the Node Manager.
For example,
cd ORACLE_HOME/wlserver_10.3/server/bin
./startNodeManager.sh

Deploying ADF Applications 2-7

Preparing the Standalone Application Server for Deployment

8. On the remote host, if the Managed Server was not created with the JRF template
applied, run the applyJRF WLST command to extend the Managed Server with
the JRF template.
Also, if the Managed Server was created after the domain was, you must delete
the entire domain configuration directory of the Managed Server before running
applyJRF.
9. On the both hosts, start the Managed Servers.
For example,
cd ORACLE_HOME/user_projects/domains/base_domain/bin
./startManagedWebLogic.sh ManagedServer_2 http://<adminServerHost>:7001

2.2.3 How to Create a JDBC Data Source for Oracle WebLogic Server
Use the Oracle WebLogic Server Administration Console to set up a JDBC data source
in the WebLogic Server instance for your applications.

To configure Oracle WebLogic Server for a JDBC data source:

1. Start Oracle WebLogic Server (if not already started) by choosing Oracle Fusion
Middleware > User Projects > Domain > Start Admin Server for WebLogic
Server Domain from the Windows Start menu.
For Linux, log in as the root user and navigate to:
<ORACLE_HOME>/user_projects/domains/MYSOADomain/bin

Run the following command:

./startWebLogic.sh

Or, from the Application Server Navigator, right-click an Oracle WebLogic Server
instance and choose Launch Admin Console.
2. Start the Oracle WebLogic Server Administration Console by choosing Oracle
Fusion Middleware > User Projects > Domain > Admin Server Console from the
Windows Start menu.
3. Log in to the Oracle WebLogic Server Administration Console.
4. In the WebLogic Server Administration Console page, select JDBC > Data
Sources.
5. Click New.
6. In the JDBC Data Source Properties page:
■ In the Name field, enter the name of the JDBC data source.
■ In the JNDI field, enter the name of the connection in the form
jdbc/connection DS.
■ For the Database Type, select Oracle.
■ For the Database Driver, select Oracle Driver (thin), and click Next.
7. In the Transactions Options page, accept the default options and click Next.
8. In the Connection Properties page:
■ For Database Name, enter the Oracle SID. For example, orcl.

2-8 Administrator's Guide for Oracle Application Development Framework

Deploying Using Scripting Commands

■ For Host Name, enter the machine name of the database.

■ Enter the port number used to access the database.
■ Enter the user name and password for the database and click Next.
9. In the Test Database Connection page, click Test Configuration to test the
connection.
10. In the Select Targets page, select the server for which the JDBC data source is to be
deployed.
11. Click Finish.
Once the data source has been created in Oracle WebLogic Server, it can be used by an
application module.

2.2.4 How to Create a JDBC Data Source for IBM WebSphere Application Server
To configure a JDBC data source for WebSphere Application Server, see the Oracle
Fusion Middleware Third-Party Application Server Guide.

2.3 Deploying Using Oracle Enterprise Manager Fusion Middleware

Control
You can use Oracle Enterprise Manager Fusion Middleware Control to deploy the
EAR file created in JDeveloper. Fusion Middleware Control is a Web browser-based,
graphical user interface that you can use to monitor and administer a farm. For more
information about deploying using Fusion Middleware Control, see the Oracle Fusion
Middleware Administrator's Guide.

2.4 Deploying Using Scripting Commands

Applications or modules can be deployed from JDeveloper without starting the
JDeveloper IDE. You can run WLST commands (for WebLogic) or wsadmin
commands (for WebSphere Application Server) from the command line or sequence
them in scripts to run as a batch.
Before deploying from the command line, there must be deployment profiles for the
application (EAR) or project (JAR or WAR). JDeveloper creates these deployment
profiles automatically for certain types of applications, but before using commands for
deployment, it is important to verify that the deployment profile(s) exist. To verify
that the profiles exist, choose the Deployment node from either the Application
Properties or Project Properties dialogs in JDeveloper. For more information about
deployment profiles, see the Oracle Fusion Middleware Developer's Guide for Oracle
Application Development Framework.
JDeveloper can also be used to deploy an application's EAR, WAR, or JAR files. The
same scripts that are used for deployment via a command line are also used to deploy
via JDeveloper, but JDeveloper creates the syntax and provides a user interface for the
deployment.
There are specific WLST commands (WebLogic) for working with ADF applications.
For a list of these commands, see Chapter 4, "WLST Command Reference for ADF
Applications."
For more information about using WLST scripts, see the Oracle Fusion Middleware
WebLogic Scripting Tool Command Reference.

Deploying ADF Applications 2-9

Deploying Using Scripts and Ant

There are specific wsadmin commands (WebSphere Application Server) for working
with ADF applications. For a list of these commands, see Appendix B, "wsadmin
Command Reference for ADF Applications."

2.5 Deploying Using Scripts and Ant

You can deploy the application using commands and scripts. You create a script to
deploy the application using the ojdeploy command and use the ojaudit
command to audit projects, workspaces, or source files of the application. You can also
set up the script to run automatically, for instance, whenever a developer checks in
new changes.
ojdeploy scripts and Ant scripts can be used together or separately:
1. Create an ojdeploy script to compile, package, and deploy the application.
2. Create an ojdeploy script to compile and package the application. Then use an
Ant script (such as WLDeploy) to deploy the application.
3. Create an Ant script to compile, package, and deploy the application. The Ant
does not need to use ojdeploy.
For more information about the ojdeploy and ojaudit commands, see the
JDeveloper online help.
You can deploy to most application servers from JDeveloper, or use tools provided by
the application server vendor. You may also use Ant to package and deploy
applications. The build.xml file, which contains the deployment commands for Ant,
may vary depending on the target application server.
For deployment to other application servers, see the application server’s
documentation. If your application server does not provide specific Ant tasks, you
may be able to use generic Ant tasks. For example, the generic ear task creates an
EAR file for you.
For information about Ant, see http://ant.apache.org.

2.6 Deploying Using the Application Server Administration Tool

For WebLogic, you can use the Oracle WebLogic Server Administration Console to
deploy the EAR file created in JDeveloper. For more information, see Oracle Fusion
Middleware Deploying Applications to Oracle WebLogic Server.
For WebSphere Application Server, you can use the IBM WebSphere Administrative
Console to deploy the EAR file created in JDeveloper. For more information, go to the
WebSphere Application Server Information Center at:
http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/index.jsp?
topic=/com.ibm.websphere.home.doc/welcome.html.

2-10 Administrator's Guide for Oracle Application Development Framework

3
3Monitoring and Configuring ADF
Applications

This chapter describes how to monitor ADF application performance. It also describes
how to configure an ADF application’s properties after it has been deployed to Oracle
WebLogic Server using Fusion Middleware Control. It also describes configuration
tasks required for applications deployed to IBM WebSphere Application Server.
This chapter includes the following sections:
■ Section 3.1, "Introduction to ADF Application Monitoring and Configuration"
■ Section 3.2, "Monitoring Performance Using Fusion Middleware Control"
■ Section 3.3, "Configuring Application Properties Using Fusion Middleware
Control"
■ Section 3.4, "Configuring Application Properties Using the MBean Browser"
■ Section 3.5, "How to Edit Credentials Deployed with the Application"
■ Section 3.6, "Diagnosing Problems using the Diagnostic Framework"
■ Section 3.7, "Viewing Application Metric Information with DMS SPY"
■ Section 3.8, "Configuring WebSphere Application Server"

3.1 Introduction to ADF Application Monitoring and Configuration

After you have deployed an ADF application to Oracle WebLogic Server, you can
monitor the application performance and configure application properties on the
server. You can use Enterprise Manager Fusion Middleware Control to perform these
tasks.
Enterprise Manager Fusion Middleware Control offers a user interface for the
performance tasks. Some configuration tasks can be performed either from a user
interface or by configuring an MBean, as listed in Table 3–1.

Monitoring and Configuring ADF Applications 3-1

Monitoring Performance Using Fusion Middleware Control

Table 3–1 Configuration Tasks Using Fusion Middleware Control

Fusion Middleware Control MBean
Configuration tasks Fusion Middleware Control UI Browser
ADF Business Components Section 3.3.1, "How to Modify ADF Section 3.4.3, "How to Modify ADF
Business Components Parameters" Business Components Configuration
Using MBeans"
ADF connections Section 3.3.2, "How to Modify Section 3.4.2, "How to Modify ADF
Connection Configurations" Connections Using MBean"
ADF application configuration Section 3.4.1, "How to Modify ADF
Application Configuration Using
MBean"
Metadata Services (MDS) Section 3.4.4, "How to Modify MDS
Configuration Using MBean"
Active Data Service (ADS) Section 3.4.5, "How to Modify Active
Data Service Configuration Using
MBean"

By default, the post-deployment changes made using MBeans are stored in MDS with
a layer name of adfshare and a layer value of adfshare. You can provide a specific
layer name by specifying the adfAppUId property in the application’s
adf-config.xml.
Example 3–1 shows the adf-properties-child code in adf-config.xml.

Example 3–1 MDS Layers in the adf-config.xml File

<adf:adf-properties-child xmlns="http://xmlns.oracle.com/adf/config/properties">
<adf-property name="adfAppUID" value="DeptApp.myApp"/>
</adf:adf-properties-child>

If you are moving data between MDS repositories (for example, from a test to a
production system), use the MDS exportMetadata and importMetadata
commands as described in the chapter on managing the Oracle metadata repository in
the Oracle Fusion Middleware Administrator's Guide and in the chapter on Metadata
Services custom WLST commands in the Oracle Fusion Middleware WebLogic Scripting
Tool Command Reference.

3.2 Monitoring Performance Using Fusion Middleware Control

You can monitor the performance of Oracle ADF applications using the Enterprise
Manager Fusion Middleware Control.
You can:
■ View application module performance
■ View application module pool performance
■ View task flow performance

3.2.1 How to View Application Module Performance

You can view performance information about application modules. Application
module components can be used to support a unit of work which spans multiple
browser pages.

3-2 Administrator's Guide for Oracle Application Development Framework

Monitoring Performance Using Fusion Middleware Control

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.

To view ADF application module performance:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

3.2.2 How to view Application Module Pool Performance

An application module pool is a collection of instances of a single application module
type which are shared by multiple application clients. One application module pool is
created for each root application module used by an ADF web application (ADF
Business Components, ADF Controller, or ADF Faces) in each Java virtual machine
where a root application module of that type is used by the ADF Controller layer.

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.

To view application module pooling performance:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

3. Expand the Farm_domain node.
4. Expand the Application Deployments node and click a J2EE application
deployment, for example, StoreFrontModule (AdminServer).
After you select an application, the Application Deployment page displays.
5. Click Application Deployment and select ADF > ADF Performance from the
dropdown menu.
The ADF Performance page displays. It contains subtabs for viewing performance
information about active Application Module Pools and Task Flows.
6. Click the Application Module Pools tab.
7. In the Module column, select an application module to display its details in the
Application Module Pools table.
No Data Available displays in the Module column if an application has never
run.
8. Click a module to display additional informations about the module, for example,
Lifetime, State Management, Pool Use, and Application Module Pools Page.

Monitoring and Configuring ADF Applications 3-3

Monitoring Performance Using Fusion Middleware Control

Use the Application Module Pools page to display active application module
pools, a collection of application module instances of the same type. The
Application Module Pools page:
■ Displays size and performance information about pool connections
■ Specifies settings that affect how application module pools behave
■ Specifies credential information for the application module pools

Element Description
Module Displays the active application module pool name, for example,
model.BugTest5PM.
Click a module to display additional information about it, for example,
Lifetime, State Management, Pool Use, Application Module Pools page.

Requests Displays the number of requests that were made for the application during
the selected time interval.
Average Displays the average time (in milliseconds) required to complete a request
Creation Time for the application module pool.
(ms)
Maximum Displays the longest time (in milliseconds) required to complete any of the
Creation Time requests for the application module pool.
(ms)
Free Instances Displays the number of available instances of the application module pool.

3.2.3 How to View ADF Task Flow Performance

You can view performance information about task flows. Task flows provide a
modular and transactional approach to navigation and application control. Task flows
mostly contain pages that will be viewed, but they also can contain activities that call
methods on managed beans, evaluate an EL expression, or call another task flow, all
without invoking a particular page.

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.

To view task flow performance:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

3-4 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

By default, Task Flow Performance charts on the tab display data for the
preceding 15 minutes. To set a different interval, click the time at the top of the
page or move the slider to another interval, for example, from 08:00 AM to 08:30
AM.
7. Click TF Charts.
■ Request Processing Time displays the average request processing time for all
ADF task flows that execute during the selected interval.
■ Active Task Flows displays the number of active instances of each ADF task
flow during the selected interval.

3.3 Configuring Application Properties Using Fusion Middleware Control

You can use Enterprise Manager Fusion Middleware Control to configure ADF
application configuration parameters. These configuration parameters are stored in
ADF MBeans. Fusion Middleware Control provides a user interface to configure the
ADF Business Components and ADF Connections MBeans. You can also use the
System MBean Browser to directly access the underlying MBeans and configure their
values. For more information about accessing the underlying MBeans, see Section 3.4,
"Configuring Application Properties Using the MBean Browser."
Fusion Middleware Control provides a user interface for you to:
■ Configure ADF Business Component parameters
■ Configure connection parameters

3.3.1 How to Modify ADF Business Components Parameters

You control the runtime behavior of an application module pool by setting
appropriate configuration parameters. Fusion Middleware Control provides a UI to
configure ADF Business Components, as described in this section. You can also
configure the ADF Business Components MBeans directly using the generic MBean
Browser, as described in Section 3.4.3, "How to Modify ADF Business Components
Configuration Using MBeans."

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.

To modify business components parameters:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

Monitoring and Configuring ADF Applications 3-5

Configuring Application Properties Using Fusion Middleware Control

If the application module uses data sources, you can configure the data sources by
clicking Edit Datasource from the Core tab.
The ADF Business Components configurations page is arranged with the following
sections or tabs:
■ Application Modules section
■ Pooling and Scalability tab - Application Pool Properties
■ Pooling and Scalability tab - Connection Pool Properties
■ Core tab
■ Database Properties tab
■ Security Properties tab

Application Modules Section

In the Application Modules section, select the application module you want to
configure.

Element Description
Application Displays the active application module name. Click the module name to
Modules display the applications in the module.

Pooling and Scalability Tab - Application Pool Properties

In the Pooling and Scalability tab, select the application pool properties you want to
configure.

Element Description
AmpoolDoampooling Select to enable application module pooling by default.
Whenever you deploy your application in a production
environment the default setting of
jbo.ampool.doampooling is true and is the way
you will run your application. But, as long as you run
your application in a test environment, setting the
property to false can play an important role in your
testing. When this property is false, there is effectively
no application pool.
AmpoolWritecookietoclient Select to write the SessionCookie value to the client
browser.

3-6 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Element Description
AmpoolMaxavailablesize Enter the maximum number of available application
modules that should be referenced by an application
pool. This is the ideal maximum number of available
application module instances in the pool when not under
abnormal load.
When the pool monitor wakes up to do resource cleanup,
it will try to remove available application module
instances to bring the total number of available instances
down to this ideal maximum. Instances that have been
not been used for a period longer than the idle instance
timeout will always get cleaned up at this time, and then
additional available instances will be removed, if
necessary to bring the number of available instances
down to this size.
The default maximum available size is 25 instances.
Configure this value to leave the maximum number of
available instances desired after a resource cleanup. A
lower value generally results in more application module
instances being removed from the pool on a cleanup.
AmpoolSessioncookiefactoryclass Enter a custom session cookie factory implementation.
This class creates the session cookies that allow clients to
retrieve application modules in stateful mode
AmpoolMaxinactiveage Enter the maximum amount of time (in milliseconds)
that an application module may remain inactive before it
is removed from the pool.
The default is 600000 milliseconds of idle time (which is
600 seconds, or ten minutes). A lower value results in
more application module instances being marked as
candidates for removal at the next resource cleanup. A
higher value results in fewer application module
instances being marked as candidates for removal at the
next resource cleanup.
AmpoolMinavailablesize Enter the minimum number of available application
modules that should be referenced by an application
pool. This is the minimum number of available
application module instances that the pool monitor
should leave in the pool during a resource cleanup
operation.
Set to 0 (zero) if you want the pool to shrink to contain
no instances when all instances have been idle for longer
than the idle timeout after a resource cleanup.
The default is 5 instances.
Doconnectionpooling Select if the application pool should release the
application module connection upon checkin. This forces
the application module pool to release the JDBC
connection used each time the application module is
released to the pool.
Recyclethreshold Enter the maximum number of application module
instances in the pool that attempt to preserve session
affinity for the next request made by the session. This
session used them last before releasing them to the pool
in managed-state mode.
AmpoolConnectionstrategyclass Enter a custom connection strategy implementation, for
example
oracle.jbo.common.ampool.DefaultConnection
Strategy. This is the class that implements the
connection strategy.

Monitoring and Configuring ADF Applications 3-7

Configuring Application Properties Using Fusion Middleware Control

Element Description
Maxpoolcookieage Enter the maximum browser cookie age for pooled
application module sessions. This is the maximum age of
the browser cookies used to help clients retrieve stateful
application modules. If these cookies do not time out, the
value is -1. It is recommended that the maximum cookie
age be always set less than or equal to the session cookie
age. It is set that way by default (both are -1). If you
change the maximum cookie age, then you must also
change the session cookie age to the same value.
AmpoolInitpoolsize Enter an initial number of application module instances
to be created in a pool. This is the number of application
module instances to created when the pool is initialized.
The default is 0 (zero) instances. A general guideline is to
configure this value to 10% more than the anticipated
number of concurrent application module instances
required to service all users.
Creating application module instances during
initialization takes the CPU processing costs of creating
application module instances during the initialization
instead of on-demand when additional application
module instances are required.
AmpoolDynamicjdbccredentials Select if an application pool may support multiple JDBC
users. This property enables additional pooling lifecycle
events to allow developer-written code to change the
database credentials (username/password) each time a
new user session begins to use the application module.
This feature is enabled by default (true); however this
setting is a necessary but not sufficient condition to
implement the feature. The complete implementation
requires additional developer-written code.
AmpoolIsuseexclusive Select if application module use is exclusive.
AmpoolResetnontransactionalstat Select if the nontransactional application module state
e should be reset upon an unmanaged checkin. This forces
the application module to reset any nontransactional
state like view object runtime settings, JDBC prepared
statements, bind variable values, and so on. when the
application module is released to the pool in unmanaged,
or "stateless" mode.
This feature is enabled by default (true). Disabling this
feature can improve performance; however, since it does
not clear bind variable values, your application needs to
ensure that it systemically sets bind variable values
correctly. If your application does not do so, and this
feature is disabled, then it is possible for one user to see
data with another user’s bind variable values.
AmpoolMaxpoolsize Enter the maximum number of application module
instances that the pool can allocate. The pool will never
create more application module instances than this limit
imposes.
The default is 5000 instances. A general guideline is to
configure this value to 20% more than the initial pool size
to allow for some additional growth. If the value is set
too low, then some users may see an error when they
tries to access the application if no application module
instances are available.

3-8 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Element Description
AmpoolTimetolive Enter the connection pool time to live for connection
instances. This is the number of milliseconds after which
an application module instance in the pool is considered
as a candidate for removal during the next resource
cleanup, regardless of whether it would bring the
number of instances in the pool below
minavailablesize.
The default is 3600000 milliseconds of total time to live
(which is 3600 seconds, or one hour). The default value is
sufficient for most applications.
AmpoolMonitorsleepinterval Enter the length of time (in milliseconds) between pool
resource cleanups.
Dofailover Select if failover should occur upon checkin to the
application module pool. This feature enables eager
passivation of pending transaction state each time an
application module is released to the pool in managed
state mode. Web applications should set enable failover
(true) to allow any other application module to activate
the state at any time. This feature is disabled by default
(false).
Best Practice: When enabling application module state
passivation, a failure can occur when Oracle WebLogic
Server is configured to forcibly release connection back
into the pool. A failure of this type produces a
SQLException (Connection has already been closed) that
is saved to the server log. The exception is not reported
through the user interface. To ensure that state
passivation occurs and users' changes are saved, set an
appropriate value for the
weblogic-application.xml deployment descriptor
parameter
inactive-connection-timeout-seconds on the
<connection-check-params> pool-params element.
Setting the deployment descriptor parameter to several
minutes, in most cases, should avoid forcing the inactive
connection timeout and the resulting passivation failure.
Adjust the setting as needed for your environment.
poolClassName Enter the custom application pool implementation class.
Show Connection Pool Properties Expand to display fields containing current advanced
connection pool properties, or enter new values in the
fields.
Hide Connection Pool Properties Click to hide all Connection Pool Properties fields.

Pooling and Scalability Tab - Connection Pool Properties

In the Pooling and Scalability tab, select the connection pool properties you want to
configure.

Element Description
Initpoolsize Enter the initial size of a JDBC connection pool. This is
the number of JDBC connection instances created
when the pool is initialized.
The default is an initial size of 0 instances.

Monitoring and Configuring ADF Applications 3-9

Configuring Application Properties Using Fusion Middleware Control

Element Description
Maxpoolsize Enter the maximum size of a JDBC connection pool.
This is the maximum number of JDBC connection
instances that the pool can allocate. The pool will
never create more JDBC connections than this allows.
The default is 5000 instances.
Poolmaxinactiveage Enter the maximum amount of time (in milliseconds)
that a connection may remain inactive before it is
removed from the pool. This is the number of
milliseconds after which to consider an inactive
application module instance in the pool as a candidate
for removal during the next resource cleanup.
The default is 600000 milliseconds of idle time (which
is 600 seconds, or ten minutes). A lower value results
in more application module instances being marked as
candidates for removal at the next resource cleanup. A
higher value results in fewer application module
instances being marked as candidates for removal at
the next resource cleanup.
Poolmaxavailablesize Enter the maximum number of available connections
that should be referenced by a connection pool. This is
the ideal maximum number of JDBC connection
instances in the pool when not under abnormal load.
When the pool monitor wakes up to do resource
cleanup, it will try to remove available JDBC
connection instances to bring the total number of
available instances down to this ideal maximum.
Instances that have been not been used for a period
longer than the idle instance timeout will always get
cleaned up at this time, and then additional available
instances will be removed, if necessary, to bring the
number of available instances down to this size.
The default is an ideal maximum of 25 instances
(when not under load).
Poolrequesttimeout Enter the time (in milliseconds) that a request should
wait for a JDBC connection to be released to the
connection pool.
Poolminavailablesize Enter the minimum number of available connections
that should be referenced by a connection pool. This is
the minimum number of available JDBC connection
instances that the pool monitor should leave in the
pool during a resource cleanup operation.
Set to zero (0) if you want the pool to shrink to contain
no instances when instances have been idle for longer
than the idle time-out.
The default is to not let the minimum available size
drop below 5 instances.
Poolmonitorsleepinterval Enter the time (in milliseconds) that the connection
pool monitor should sleep between pool checks. This
is the length of time in milliseconds between pool
resource cleanup.
While the number of application module instances in
the pool will never exceed the maximum pool size,
available instances which are candidates for getting
removed from the pool do not get "cleaned up" until
the next time the application module pool monitor
wakes up to do its job.

3-10 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Element Description
ConnectionPoolManager Enter the implementation of the connection pool
manager which will be used.
Pooltimetolive Enter the application pool time to live (in
milliseconds) for application module instances.

Core Tab
Use the core tab to view or edit core properties for the application module.

Element Description
DefaultLanguage Enter the default business components session
language, which is part of the locale.
Passivationstore Enter the type of store, file, or database file that
should be used for application module passivation.
database is the default choice. While it may be a
little slower than passivating to file, it is by far the
most reliable choice.
file may offer faster performance because access to
the file is faster then access to the database.
Default Country Enter the default business components session
country, which is part of the Locale.
AssocConsistent Select if entity row set associations have been kept
consistent.
XmlValidation Select to determine the validation mode for the XML
parser. If selected, the XML parser uses strict XML
validation.
DatabaseConfig Database Configuration.
Name Enter the name of the application module.
OracleSchema Enter the name of the schema in which the business
components runtime libraries are deployed.
Show Advanced Properties Expand to display fields containing current advanced
core properties, or enter new values in the fields.
PersMaxRowsPerNode Enter the maximum size of a node for view row
spillover.
PassivationTrackInsert If selected when an application module is activated, it
will be updated to include rows inserted into the
database while it was passive.
ApplicationPath For EJB deployment, enter the JNDI path to the
business components.
ViewlinkConsistent If selected, the view object row sets retrieved through
view link accessors will include rows that have been
added, even if these changes have not been posted to
the database.
ConnectionMode Deprecated property, formerly used for deployment
to VisiBroker. VisiBroker deployment is no longer
supported.
Maxpassivationstacksize Enter the maximum size of the passivation stack
(default is 10)

Monitoring and Configuring ADF Applications 3-11

Configuring Application Properties Using Fusion Middleware Control

Element Description
TxnHandleafterpostexc Select to cause ADF Business Components to take a
transaction snapshot before beginning a commit
operation. If an exception is thrown after changes
have been posted to the database, ADF Business
Components will use this snapshot to roll back the
in-memory state of your application module to the
point before commit operation began.
SnapshotstoreUndo Enter the target for undo snapshots
{transient|persistent}
Project Enter the name of the project containing extended
business components to be substituted for base ones,
if Factory-Substitution-List is not empty.
Tmpdir Enter the directory for temporary Oracle ADF
Business Components files.
DeployPlatform The deployment platform: select LOCAL, EJB_IAS
(for an EJB deployed to Oracle Application Server), or
WLS (for an EJB deployed to Oracle WebLogic
Server).
PersMaxActiveNodes Enter the maximum number of nodes that will be
cached in memory for view row spillover.
Saveforlater Select Save snapshots for the lifetime of the
transaction.
ViewCriteriaAdapter Enter a custom class that will be used by view objects
to convert between view criteria and view object SQL.
Connectfailover Select business components transparent JDBC
connection failover
Hide Advanced Properties Click to hide all Connection Pool Properties fields.

Database Properties Tab

If you are using a JDBC URL for your connection information so that the ADF
database connection pool is used, then the configuration parameters listed here can be
used to tune the behavior of the database connection pool.

Element Description
MaxCursors Enter the maximum number of cursors to be used by
the session. This is the maximum number of cursors the
business components may have open. The framework
will clean up free JDBC statements as the number of
cursors approaches this number.
Sql92DbTimeQuery Enter the database system time SQL query string.
SQLBuilder Enter the SQLBuilder implementation (Oracle, OLite,
DB2, or SQL92 for other SQL92-compliant databases).
Sql92LockTrailer Enter the SQL statement trailer clause for locking.
JdbcTrace Select to trace all JDBC activity with lines flagged by +
PropertyConstants.JDBC_MARKER +
oracleDefineColumnLength Enter the column length for all JDBC CHAR or
VARCHAR2 columns. Use as_bytes to make column
precision specifications in bytes. Use as_chars to
make column precision specifications in characters.
This is important for larger character sets, such as
Unicode.

3-12 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Element Description
Sql92JdbcDriverClass Enter the name of the class implementing JDBC Driver,
for example, sun.jdbc.odbc.JdbcOdbcDriver.
TypeMapEntries Enter the type map implementation. This specifies a
custom type map between Java types and SQL types.
ControlTableName Enter the persistent collection control table name.
FetchMode Enter the control fetch behavior of View Objects (+
PropertyConstants.ENV_FETCH_AS_NEEDED +
"|" + PropertyConstants.ENV_FETCH_ALL + ).
AS.NEEDED causes view objects to fetch rows only
when they are requested. ALL causes them to fetch the
entire results of their queries.
LockingMode Enter the default locking mode for an application
module. This prevents the application module pool
from creating a pending transaction state on the
database with row-level locks each time the application
module is released to the pool.
Fusion web applications should set the locking mode to
optimistic to avoid creating the row-level locks.
JdbcBytesConversion Indicate whether to use JDBC default bytes conversion
or to perform such conversion in the framework.
Show Advanced Properties Expand to display fields containing current advanced
database properties, or enter new values in the fields.
TxnSeqInc Select persistent transaction sequence increment.
UsePersColl Select enable view row spillover to help manage large
rowsets.
TxnSeqName Enter persistent transaction sequence name.
Hide Advanced Properties Click to hide all advanced property fields.

Security Properties Tab

Use the Security Properties tab to configure application module security information.

Element Description
SecurityContext Enter the JAAS context. This element specifies a
particular JAAS implementation.
The default is JAZN.
Show Advanced Properties Expand to display fields containing current advanced
security properties, or enter new values in the fields.
UserPrincipal Enter the authenticated user principal name.
SecurityConfig Enter the complete path and file name of JAZN
configuration, for example,
k:\j2ee\home\config\jazn.xml.
If this property value is null or length 0, runtime will
assume that jazn.xml is in the same path as
jazn.jar and append /config/jazn.xml before it
accesses login module or gets the JAZN context for
getting permission manager.
javaNamingSecurityCredentials For EJB deployment, enter the password for the
application server connection.

Monitoring and Configuring ADF Applications 3-13

Configuring Application Properties Using Fusion Middleware Control

Element Description
AppModuleJndiName For EJB deployment, enter the JNDI name used to look
up the application module factory.
SecurityLoginmodule Enter a custom login module for authentication, for
example,
oracle.security.jazn.realm.RealmLoginModu
le.
The default is the JAZN login module.
ServerUseNullDbTransaction Use 9.0.2 compatible
oracle.jbo.server.NullDbtransactionImpl
when not connected to the database.
SecurityEnforce Enter one of the following values:
None - No authentication.
Test - Requires authentication. If using the tester or
ADF Swing, a dialog will prompt for login. If
authentication fails, the application module is still
instantiated.
Must - Like Test, but if authentication fails, the
application module will not be instantiated. Instead,
you will get an exception.
Auth - Like Must, but in addition, if you have used the
Entity Wizard Authorization editor to define entity or
attribute permissions, the permissions will be checked.
For example if the permission on Dept.Deptno was
granted update_while_new to role users, then the
users role can set the Deptno value only when the
row is new. Otherwise, it is not editable.
Note that even if there are permissions granted via the
wizard, they will not be enforced unless
jbo.security.enforce is set to Auth.
javaNamingSecurityPrincipal For EJB deployment, enter the password for the
application server connection.
Hide Advanced Properties Click to hide all advanced property fields.

3.3.2 How to Modify Connection Configurations

A connection configuration contains information that a client application uses to
identify the ADF application module's deployment scenario. You use Oracle
Enterprise Manager Fusion Middleware Control to:
■ Register and manage back-end services such as mail, discussion forums servers,
and so on
■ Register and manage external applications that users need access to while working
with applications
■ Register and manage any portlet producers that the application uses or that users
may need access to
Fusion Middleware Control provides a UI to configure ADF connections, as described
in this section. You can also configure the ADF connections MBean directly using the
generic MBean Browser, as described in Section 3.4.2, "How to Modify ADF
Connections Using MBean."

3-14 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.
You must have MDS configured in your application before you can modify the ADF
application and connection configurations. ADF connection attributes are persisted to
MDS.
If you deployed an application to several nodes within a cluster, any ADF connection
changes to a single node will be propagated to all the other nodes. MDS will store a
single set of connection information for all versions of an application.

To modify connection configurations:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

3. Expand the Farm_domain node.
4. Expand the Application Deployments node and click a J2EE application
deployment, for example, StoreFrontModule (AdminServer).
After you select an application, the Application Deployment page displays.
5. Click Application Deployment and select ADF > Configure ADF Connections
from the dropdown menu.
6. In the Connection Type drop-down list, choose the type of connection you want
to configure:
■ ADF BC Service
■ Discussions and Announcements
■ File System
■ Mail Server
■ Secure Enterprise Search
■ URL
■ Web Service
You cannot create an Essbase connection, however, you can edit an existing
Essbase connection that was deployed with the application.
7. In the Connection Name field, enter a unique name for the connection
configuration.
8. Click Create Connection.
The Connection Configuration page updates with a section where you can specify
options for the connection type you chose.
The following connection types are supported:
■ ADF Business Components Service connection
■ Essbase connection
■ Discussions and Announcements connection
■ File system connection
■ Mail server connection
■ Secure enterprise search connection

Monitoring and Configuring ADF Applications 3-15

Configuring Application Properties Using Fusion Middleware Control

■ URL connection
■ Web Service connection

ADF Business Components Service Connection

Use the ADF Business Components Service connection page to create a new ADF
Business Components Service connection or to modify existing connection details.

Element Description
serviceEndpointProvider Enter the provider of the service endpoint.
Valid types are ADFBC, Fabric, SOAP.
serviceConnectionName Enter the service connection name.
jndiName Enter the JNDI name of the EJB that
implements the service interface. Applicable
when the endpoint is ADF BC.
jndiFactoryInitial Enter the class name of initial context factory
for JNDI lookup. Applicable when the
endpoint is ADF BC.
jndiProviderURL Enter configuration information for the JNDI
lookup. Applicable when endpoint is ADF BC.
jndiSecurityPrincipal Enter the identity of the principal (e.g. user)
for the JNDI lookup. Applicable when the
endpoint is ADF BC.
jndiSecurityCredentials Enter the principal's credentials for JNDI
lookup. Applicable when the endpoint is ADF
BC.
fabricAddress Enter the service name of the SOA composite.
Applicable when the endpoint is Fabric.
serviceInterfaceName Enter the class name of the service endpoint
interface.
serviceSchemaName Enter the name of the service schema file.
serviceSchemaLocation Enter the relative path of the service schema
file.

Essbase Connection
You cannot create an Essbase connection; however, you can edit an existing Essbase
connection that was deployed with the application.

Element Description
Host Enter the host that this connection represents.
Port Displays the default port that this connection uses to connect to
Essbase. Clear the Default option to enter a port other than the default.
Username Enter the user name authorized to connect to Essbase during design
time. This user name is replaced at runtime with the user name
specified by the application.
Password Enter the password of the user. An asterisk (*) is displayed for each
character you enter in this field.

3-16 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Discussions and Announcements Connection

Use the Discussion Forum Connection pages to connect to a new discussions server
connection or to modify existing connection details. Forum Connections configuration
includes configurations for name, connection details, and advanced.

Discussions and Announcements Connection - Name

Element Description
Name Enter a unique name for the connection.

Discussions and Announcements Connection - Connection Details

Element Description
Server URL Enter the URL of the discussion server hosting the discussion forums.
For example: http://discuss-server.com:8888/owc_discussions
Administrator Enter the user name of the discussion server administrator.
User Name
Administrative privileges are required for this connection so that operations
can be performed on behalf of WebCenter users.
Connection .Enter the connection timeout in seconds. The default is -1.
Timeout (in
Seconds)
Connection Indicate whether or not the discussion server connection is secure.
Secured

Discussions and Announcements Connection - Advanced Configuration

Element Description
Cache Size (in Specify the amount of space reserved for the cache (in MB).
MB)
The default is 0.
ache Expiration Specify a suitable expiration period for the cache.
Time (in
This is the maximum length of time (in minutes) that cached content is
Minutes)
valid.
The default is 0.
Connection Specify a suitable timeout for the connection.
Timeout (in
This is the length of time (in seconds) that the WebCenter application waits
Seconds)
for a response from the discussion server before issuing a connection
timeout message.
The default is 60 seconds.

File System Connection

Use the Add/New Content Repository Connection pages to connect to a new content
repository or to modify existing connection details.

Note: All configuration changes are stored in the MDS repository.

Monitoring and Configuring ADF Applications 3-17

Configuring Application Properties Using Fusion Middleware Control

File System Connection Details - File System

Element Description
Root Path Enter the full path to a folder on a local file system in which your
content is placed. For example: C:/MyContent
Caution: File system content must not be used in production or
enterprise application deployments. This feature is provided for
development purposes only.

Mail Server Connection

Use the Mail Server connection pages to configure LDAP and advanced mail server
configurations

Element Description
IMAP Host Enter the host name of the machine where the IMAP service (Internet
Message Access Protocol) is running.
IMAP Port Enter the port on which the IMAP service listens.
IMAP Secured Indicate whether a secured connection (SSL) is required for incoming mail
over IMAP.
SMTP Host Enter the host name of the machine on which the SMTP service (Simple Mail
Transfer Protocol) is running.
SMTP Port Enter the port on which the SMTP service listens.
SMTP Secured Indicate whether a secured connection (SSL) is required for outgoing mail
over SMTP.
Associated Associate the mail server with an external application. External application
External credential information is used to authenticate users against the IMAP server.
Application

Mail Server Connection - LDAP Configuration

Element Description
LDAP Domain Enter the LDAP domain.
LDAP Host Enter the host name of the LDAP (Lightweight Directory Access Protocol)
server.
LDAP Port Enter the port on which the LDAP service listens.
LDAP Secured Indicate whether a secured connection (SSL) is required for the LDAP
connection.
LDAP Enter the user name of the LDAP server administrator.
Administrator
User Name
LDAP Enter the password for the LDAP server administrator.
Administrator
Password
LDAP Base Enter the base-distinguished name for the LDAP schema.
DN
LDAP Default Enter the LDAP default user.
User

3-18 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using Fusion Middleware Control

Mail Server Connection - Advanced Configuration

Element Description
Connection Specify a suitable timeout for the connection.
Timeout (in
This is the length of time (in seconds) that the WebCenter application waits
Seconds)
for a response from the mail server before issuing a connection timeout
message. The default is 60 seconds.
Cache Specify a suitable expiration period for the cache.
Expiration
This is the maximum length of time (in minutes) that cached content is
Time (in
valid. The default value (-1) means that the cache never expires.
Minutes)

Secure Enterprise Search Connection

Use the Secure Enterprise Search Connection pages to connect the WebCenter
application to a new Oracle Secure Enterprise Search server or to modify existing
connection details.
Secure Enterprise Search Connection Provider configuration includes configurations
for name, connection details, and advanced configurations.

Secure Enterprise Search Connection - Name

Element Description
Connection Enter a unique name for the connection.
Name
Active Select to use this connection for search-related services in the WebCenter
Connection application.
You can register multiple search connections through Oracle Enterprise
Manager Fusion Middleware Control, but only one connection is active at a
time.

Secure Enterprise Search Connection - Connection Details

Element Description
SOAP URL Enter the Web Service URL that Oracle Secure Enterprise Search exposes to
enable search requests.
Use the format:
http://<host>:<port>/search/query/OracleSearch
For example: http://myHost:7777/search/query/OracleSearch
Application Enter the name of a valid user.
User Name
You can specify the name of any user in the identity store. The user must be
present in both the Oracle Identity Management server configured for your
WebCenter application and the Oracle Identity Management server
configured for Oracle SES.
The WebCenter application must authenticate itself as a trusted application
to Oracle Secure Enterprise Search so that it may perform searches on behalf
of WebCenter users.
Application Enter the appropriate user password.
Password

Monitoring and Configuring ADF Applications 3-19

Configuring Application Properties Using Fusion Middleware Control

Secure Enterprise Search Connection - Advanced Configuration

Element Description
Oracle Secure Enter the Secure Enterprise Search data group in which to search.
Enterprise
Search Data
Group
Execution Enter the search execution timeout in milliseconds.
Timeout
Executor Enter the search executor preparation timeout in milliseconds.
Preparation
Timeout
Number of Enter the number of saved searches displayed.
Saved Searches
Simple Search Enter the number of results displayed from a simple search, for each service.
Result Rows
Search Result Enter the number of search results displayed for each service.
Rows
Global Search Enter the number of search results displayed (on the toolbar) for each service.
Result Rows

URL Connection
Use the URL Connection pages to configure URL connections.

Element Description
URL Enter the URL of the desired data stream, but omit any URL
parameters.
Username Enter the username require to enter the web site.
Password Enter the password required to enter the web site.
AuthenticationRealm Defines the Realm as in HTTP authentication. Defined by the
server hosting the protected resources.
Proxy Defines the proxy to be used for connecting to HTTP/HTTPS
resources. Specifies the host/port and any authentication
details needed to authenticate against the proxy itself.
ProxyUseDefault Uses the default proxy at the system level instead of the
connection level at both DT or RT, or wherever the connection
instance is active. At design time, the default proxy will be the
JDeveloper IDE proxy settings, at runtime, it will be the one
configured for WLS.
ConnectionClassName Indicates the type of challenge authentication. The two
supported modes are Basic and Digest authentication (HTTP
basic & digest).
ChallengeAuthenticationTyp The class name of the connection that gets loaded into the
e reference to be used by the factory to construct the connection
instance.

Web Service Connection

Use the Web Service Connection page to configure a connection using the WebService
MDDS model based on the service WSDL to call and invoke the WebService.

3-20 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using the MBean Browser

Use the Configure Web Service dropdown list to configure the Web Service Client,
including attaching and detaching policy. After you have finished the configuration in
the web services page, you can use the breadcrumbs to navigate back to the ADF
Connections page.

Element Description
Model Enter the WebService MDDS model elements generated based on the
service WSDL.
WsdlUrl Enter the WebService service WSDL URL.
DefaultServiceName Enter the default service Name of the service WSDL.

3.4 Configuring Application Properties Using the MBean Browser

You can use the Enterprise Manager Fusion Middleware Control MBean Browser to
access and modify the values in ADF MBeans deployed with the ADF application into
Oracle WebLogic Server.
You can view and modify:
■ ADFcConfiguration MBean
■ ADF Connections MBean
■ ADF Business Components BC4J MBeans
■ MDS Configuration MBean
■ Active Data Service (ADS) MBean

3.4.1 How to Modify ADF Application Configuration Using MBean

You can modify ADF application configurations MBeans using the MBean Browser.

Before you begin:

You must have MDS configured in your application before you can modify the ADF
application and connection configurations. ADF application attributes are persisted to
MDS.
If you deployed an application to several nodes within a cluster, any ADF application
configuration changes to a single node via an MBean will be propagated to all the
other nodes. MDS will store a single set of ADF application configuration information
for all versions of an application.

To modify ADF application configuration using MBean Browser:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

Monitoring and Configuring ADF Applications 3-21

Configuring Application Properties Using the MBean Browser

6. In the left pane of the System MBean Browser, expand the parent ADF MBean
ADFConfig and then the ADFConfig folder to expose the child ADF MBeans.
You may see the child ADF MBeans ADFcConfiguration and MDSAppConfig.
7. In the left pane, select the ADFcConfiguration MBean, and in the right pane,
select the attribute you want to view or modify.
Figure 3–1 shows an ADF Configuration MBean in the Fusion Middleware Control
MBean Browser.

Figure 3–1 ADF Configuration MBean

8. Change the attribute value and click Apply.

9. In the left pane, select the parent ADF MBean ADFConfig.
10. In the right pane, click the Operations tab and click save.
The new values you have edited are written to MDS after you click save from the
parent MBean.

3.4.2 How to Modify ADF Connections Using MBean

You can modify ADF connection configurations MBean using the MBean Browser.
You can also modify ADF connections using the Fusion Middleware UI described in
Section 3.3.2, "How to Modify Connection Configurations."

Before you begin:

You must have MDS configured in your application before you can modify the ADF
application and connection configurations. ADF application attributes are persisted to
MDS.

3-22 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using the MBean Browser

If you deployed an application to several nodes within a cluster, any ADF connection
changes to a single node via an MBean will be propagated to all the other nodes. MDS
will store a single set of ADF application configuration information for all versions of
an application.

To modify ADF application configuration using MBean Browser:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

Figure 3–2 ADF Connections MBean

8. Change the attribute value and click Apply.

Monitoring and Configuring ADF Applications 3-23

Configuring Application Properties Using the MBean Browser

9. In the right pane, click the Operations tab and click save.
The new values you have edited are written to MDS after you click save.

3.4.3 How to Modify ADF Business Components Configuration Using MBeans

You can modify ADF Business Components configurations MBeans using the MBean
Browser. ADF Business Component configuration information are stored in MBeans
that are specific for each application. Unlike ADF connections and ADF application
configuration information which you can configure once for all versions of the same
application, you will need to configure ADF Business Components for each version of
the application.
You can also modify ADF Business Components configuration information using the
Fusion Middleware UI described in Section 3.3.1, "How to Modify ADF Business
Components Parameters."

Before you begin:

You must have MDS configured in your application before you can modify the ADF
application and connection configurations. ADF application attributes are persisted to
MDS.
If you deployed an application to several nodes within a cluster, any ADF Business
Components changes to a single node via MBeans will be propagated to all the other
nodes. MDS will store a single set of ADF application configuration information for all
versions of an application.

To modify ADF application configuration using MBean Browser:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

3.4.4 How to Modify MDS Configuration Using MBean

You can use the MBean Browser to perform advanced configuration of MDS
parameters. For more information about configuring MDS using MBeans, see the
Oracle Fusion Middleware Administrator's Guide.

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.

3-24 Administrator's Guide for Oracle Application Development Framework

Configuring Application Properties Using the MBean Browser

To modify MDS configuration using MBean Browser:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

Figure 3–3 MDS MBean

8. Change the value and click Apply.

3.4.5 How to Modify Active Data Service Configuration Using MBean

You can use Active Data Service (ADS) framework to control the runtime behavior of
an Oracle ADF application and qualifying ADF Faces components so that whenever
data changes on the server, the ADF Model layer notifies the component and the
component rerenders the changed data.

Monitoring and Configuring ADF Applications 3-25

Configuring Application Properties Using the MBean Browser

Before you begin:

You must already have deployed an Oracle ADF application and have Enterprise
Manager Fusion Middleware Control available to access the application.
Note that the ADF Faces components of your application must be configured to use
ADS. Additionally, if your application services do not support ADS, then your
application must define a service proxy so that the components can display the data as
it updates in the source. For details about ADS, see Chapter 45, "Using the Active Data
Service" in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application
Development Framework.

To modify ADF application configuration using MBean Browser:

1. Log in to an Oracle Fusion Middleware farm using Fusion Middleware Control.

2. Click the Farm tab.

3. Expand the Farm_domain node.
4. Expand the Application Deployments node and click a J2EE application
deployment, for example, application1 (AdminServer).
After you select an application, the Application Deployment page displays.
5. Click Application Deployment and select ADF > Configure ADF (adf-config)
from the dropdown menu.
6. In the left pane of the System MBean Browser, expand the parent ADF MBean
ADFConfig and then the ADFConfig folder to expose the child ADF MBeans.
You may see the child ADF MBeans ActiveDataConfiguration and
MDSAppConfig.
7. In the left pane, select the ActiveDataConfiguration MBean, and in the right pane,
select the attribute you want to view or modify.

Attribute Description
Transport The method by which data will be delivered to the client.
Value values are:
■ streaming (default)
■ polling
■ long-polling
For more information, see the "What You May Need to Know
About Transport Modes" section of the Oracle Fusion
Middleware Fusion Developer's Guide for Oracle Application
Development Framework.
LatencyThreshold Latency threshold in milliseconds. Active data messages with
network delays greater than this threshold will be treated as
being "late".
KeepAliveInterval Frequency in milliseconds for sending keep-alive messages
when no events are generated.
PollingInterval Frequency in milliseconds of the poll request; only used when
clients are set to use polling
MaxReconnectAttemptTime Maximum period of time in milliseconds a client will keep
attempting to reconnect to server upon getting disconnected
ReconnectWaitTime Time interval in milliseconds to wait between reconnect
attempts.

3-26 Administrator's Guide for Oracle Application Development Framework

Diagnosing Problems using the Diagnostic Framework

Figure 3–4 shows an ActiveDataConfiguration MBean in the Fusion Middleware

Control MBean Browser.

Figure 3–4 ADF Active Data Configuration MBean

8. Change the attribute value and click Apply.

3.5 How to Edit Credentials Deployed with the Application

You can use Enterprise Manager Fusion Middleware Control to edit credentials that
were deployed with an ADF application to the credential store. You can also create
new credentials and delete existing credentials.
For ADF applications, the following considerations apply:
■ The Map name is typically the adfAppUId property defined in the application’s
adf-config.xml file.
■ The Key name is typically in the format anonymous#connection, where
connection is the connection name.
■ The Credential Type is Generic and it is modeled as a hash map of key-value
pairs.
For more information, see the "Managing Credentials with Fusion Middleware
Control" section of the Oracle Fusion Middleware Application Security Guide.

3.6 Diagnosing Problems using the Diagnostic Framework

Oracle Fusion Middleware provides a Diagnostic Framework to help you detect,
diagnose, and resolve problems with your application

Monitoring and Configuring ADF Applications 3-27

Viewing Application Metric Information with DMS SPY

When a critical error occurs, the Diagnostic Framework immediately captures

diagnostic data and associates the data and error with an incident number. Using this
number, you can retrieve the data for analysis from the Automatic Diagnostic
Repository (ADR).
Oracle ADF provides an ADFConfig dump which will execute when an INCIDENT_
ERROR message is logged. You can also add code to invoke the dump in the
application exception handlers. Example 3–2 show a sample code you can add to your
exception handler to invoke the ADFConfig dump.

Example 3–2 Sample Code for Invoking ADFConfig Diagnostic Dump in Exception
Handler
IllegalArgumentException e = new IllegalArgumentException("test exception");
LoggerFactory.getFrameworkLogger().log(ODLLevel.INCIDENT_ERROR,
"Test error message", e);

For more information about the Diagnostic Framework, see the chapter on diagnosing
problems in the Oracle Fusion Middleware Administrator's Guide.
If you are using the Diagnostic Framework on an IBM WebSphere application server,
you need to perform additional tasks. For more information, see the Oracle Fusion
Middleware Third-Party Application Server Guide.

3.7 Viewing Application Metric Information with DMS SPY

You can use the DMS Spy servlet to view application metric information in a web
browser.
For more information, see the "Monitoring Oracle Fusion Middleware" section in the
Oracle® Fusion Middleware Performance and Tuning Guide

3.8 Configuring WebSphere Application Server

You use the WebSphere Application Server administrative console to configure
WebSphere Application Server. For more information, go to the WebSphere
Application Server Information Center at:
http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/index.jsp?
topic=/com.ibm.websphere.home.doc/welcome.html.

3.8.1 How to Configure WebSphere to Allow Reuse of Query Result Sets

WebSphere Application Server closes shared database connections between
application generated requests. You need to set two properties in WebSphere to allow
reuse of result sets.
Use the WebSphere Application Server administrative console to set the
non-transactional datasource and
DisableMultiThreadedServletConnectionMgmt properties.

To set properties in WebSphere to reuse results sets:

1. Start WebSphere Application Server administrative console.

2. Navigate to Data sources > DB2 Universal JDBC Driver XA DataSource >
WebSphere Application Server data source properties and set Non-transactional
data source to enabled.
3. Save the configuration.

3-28 Administrator's Guide for Oracle Application Development Framework

Configuring WebSphere Application Server

4. Navigate to Application servers > server_name > Web Container > Custom
Properties and set DisableMultiThreadedServletConnectionMgmt to true.
5. Save the configuration.
6. Restart WebSphere Application Server.
Setting these two properties will enable your deployed application to reuse result sets
across requests.

Monitoring and Configuring ADF Applications 3-29

Configuring WebSphere Application Server

3-30 Administrator's Guide for Oracle Application Development Framework

4
WLST Command Reference for ADF
4

Applications

This chapter describes the WLST commands you can use to deploy, manage, and
configure Oracle ADF applications to Oracle WebLogic Server.
For wsadmin commands reference for the IBM WebSphere Application Server, see
Appendix B, "wsadmin Command Reference for ADF Applications."
This chapter includes the following sections:
■ Section 4.1, "Overview of Custom WSLT Commands for Oracle ADF"
■ Section 4.2, "ADF-Specific WLST Commands"

4.1 Overview of Custom WSLT Commands for Oracle ADF

Use the ADF-based URL Connections WLST commands to navigate the hierarchy of
configuration or runtime beans and control the prompt display. Use the
getADFMArchiveConfig commands to manage the ADFMArchiveConfig object.
To use the custom WLST commands for Oracle ADF, you must invoke the WLST
script from the Oracle Common home. For more information about other WLST
commands, such as custom Metadata Services (MDS) commands, see the Oracle Fusion
Middleware WebLogic Scripting Tool Command Reference.

4.2 ADF-Specific WLST Commands

Use the commands in Table 4–1 for ADF applications.

Table 4–1 Browse Commands for WLST Configuration

Use with
Use this command... To... WLST...
adf_createFileUrlConnection Create a new ADF file Online or
connection. Offline
adf_createHttpUrlConnection Create a new ADF URL Online or
connection. Offline
adf_setURLConnectionAttributes Set or edit the attributes of a Online or
newly created or existing ADF Offline
connection.
adf_listUrlConnection List a new URL connection. Online or
Offline

WLST Command Reference for ADF Applications 4-1

ADF-Specific WLST Commands

Table 4–1 (Cont.) Browse Commands for WLST Configuration

Use with
Use this command... To... WLST...
getADFMArchiveConfig Returns a handle to the Online or
ADFMArchiveConfig object Offline
for the specified archive.
exportJarVersions Export CSV format of JARs Offline
versions from current
ORACLE_HOME at a specified
location..
exportApplicationJarVersions Export CSV format of JARs Online
versions of a specified
application at a specified
location.
exportApplicationSelectedJarVersions Export CSV format of JARs Online
versions from current
ORACLE_HOME at a specified
location in coordination
with the Versions.xml
file.

4.2.1 adf_createFileUrlConnection
Use with WLST: Online or Offline.

4.2.1.1 Description
Use this command to creates a new connection based on the
oracle.adf.model.connection.url.FileURLConnection connection class.

4.2.1.2 Syntax
adf_createFileURLConnection(appName, name, URL)

Argument Definition
appName Application name for which the connection will be created.
name The name of the new connection.
URL The URL associated with this connection.

4.2.1.3 Example
adf_createFileURLConnection('myapp','tempDir','/scratch/tmp')

4.2.2 adf_createHttpUrlConnection
Use with WLST: Online or Offline.

4.2.2.1 Description
Use this command to create a new connection based on the
oracle.adf.model.connection.url.HttpURLConnection connection type
class.

4-2 Administrator's Guide for Oracle Application Development Framework

ADF-Specific WLST Commands

4.2.2.2 Syntax
adf_createHttpURLConnection (appName, name, [URL], [authenticationType], [realm],
[user], [password])

Argument Definition
appName Application name for which the connection will be created.
name The name of the new connection.
url (Optional) The URL associated with this connection.
authenticationType (Optional) The default is basic.
realm (Optional) If this connection deals with authentication,
then this should be set. The default is basic.
user (Optional)
password (Optional)

4.2.2.3 Example
adf_createHttpURLConnection('myapp','cnn','http://www.cnn.com')

4.2.3 adf_setURLConnectionAttributes
Use with WLST: Online or Offline.

4.2.3.1 Description
Use this command to set or edit the attributes of a newly created or existing ADF
connection.

4.2.3.2 Syntax
adf_setURLConnectionAttributes(appname, connectionname, attributes)

Argument Definition
appname Application name.
connectionname The name of the connection.
attributes The array containing attributes to set in key/value pairs.

4.2.3.3 Example
adf_setURLConnectionAttributes
('myapp','cnn',’ChallengeAuthenticationType:digest’,
’AuthenticationRealm:XMLRealm’

4.2.4 adf_listUrlConnection
Use with WLST: Online or Offline.

4.2.4.1 Description
Use this command to list the connections of the application.

WLST Command Reference for ADF Applications 4-3

ADF-Specific WLST Commands

4.2.4.2 Syntax
adf_listURLConnection(appname)

Argument Definition
appname Application name.

4.2.4.3 Example
adf_listURLConnection ('myapp')

4.2.5 getADFMArchiveConfig
Use with WLST: Online or Offline.

4.2.5.1 Description
Returns a handle to the ADFMArchiveConfig object for the specified archive. The
returned ADFMArchiveConfig object's methods can be used to change application
configuration in an archive.
The ADFMArchiveConfig object provides the following methods:
■ setDatabaseJboSQLBuilder([value]) - Sets the Database
jbo.SQLBuilder attribute.
■ getDatabaseJboSQLBuilder() - Returns the current value of the
jbo.SQLBuilder attribute.
■ setDatabaseJboSQLBuilderClass([value]) - Sets the Database
jbo.SQLBuilderClass attribute. Value is the full name of the custom builder
class.
■ getDatabaseJboSQLBuilderClass() - Returns the current value of the
jbo.SQLBuilderClass attribute.
■ setDefaultRowLimit([value]) - Sets the defaults rowLimit attribute.
Value is a long specifying the row limit (Default -1).
■ getDefaultRowLimit() - Returns the current value of the rowLimit attribute.
■ save([toLocation]) - If you specify the toLocation, then the changes will
be stored in the target archive file and the original file will remain unchanged.
Otherwise, the changes will be saved in the original file itself.

4.2.5.2 Syntax
archiveConfigObject = ADFMAdmin.getADFMArchiveConfig(fromLocation)

Argument Definition
fromLocation The name of the ear file, including its complete path.

The syntax for setDatabaseJboSQLBuilder([value]) is:

archiveConfigObject.setDatabaseJboSQLBuilder([value])

4-4 Administrator's Guide for Oracle Application Development Framework

ADF-Specific WLST Commands

Argument Definition
value The value of the jbo.SQLBuilder attribute. Valid values are:
'Oracle' (Default), 'OLite', 'DB2', 'SQL92', 'SQLServer', or 'Custom. If
'Custom' is specified, then the jbo.SQLBuilderClass attribute
should also be set.

The syntax for getDatabaseJboSQLBuilder() is:

archiveConfigObject.getDatabaseJboSQLBuilder()

The syntax for setDatabaseJboSQLBuilderClass([value]) is:

archiveConfigObject.setDatabaseJboSQLBuilderClass([value])

Argument Definition
value The value of the jbo.SQLBuilderClass attribute.

The syntax for getDatabaseJboSQLBuilderClass) is:

archiveConfigObject.getDatabaseJboSQLBuilderClass()

The syntax for setDefaultRowLimit([value]) is:

archiveConfigObject.setDefaultRowLimit([value])

Argument Definition
value The value of the rowLimit attribute.

The syntax for getDefaultRowLimit() is:

archiveConfigObject.getDefaultRowLimit([value])

The syntax for save([toLocation]) is:

archiveConfigObject.save([toLocation])

Argument Definition
toLocation The file name along with the absolute path to store the changes.

4.2.5.3 Example
In the following example. the jbo.SQLBuilder attribute is set to 'DB2'.
wls:/offline> archive =
ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder(value='DB2')
wls:/offline> archive.save()

In the following example, the jbo.SQLBuilder attribute is removed so that

application default is used.
wls:/offline> archive =
ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder()
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

WLST Command Reference for ADF Applications 4-5

ADF-Specific WLST Commands

In the following example, the jbo.SQLBuilder attribute is set to 'Custom', and the
jbo.SQLBuilderClass attribute is set to the class 'com.example.CustomBuilder'.
wls:/offline> archive =
ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder('Custom')
wls:/offline> archive.setDatabaseJboSQLBuilderClass('com.example.CustomBuilder')
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

In the following example, the rowLimit attribute is set to 100.

wls:/offline> archive = getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDefaultRowLimit(100)
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

4.2.6 exportJarVersions
Use with WLST: Offline.

4.2.6.1 Description
Use to export CSV format of JARs versions from current ORACLE_HOME at a specified
location. Exported JARs versions information can be opened in Oracle OpenOffice or
MicroSoft Excel.

4.2.6.2 Syntax
exportJarVersions(path)

Argument Definition
path Location to extract JARs versions.

4.2.6.3 Example
This example shows how JARs versions are exported to
/tmp/export-MyApp-Versions.csv. R/W privileges for the CSV file need to be
verified.
wls:/offline>exportJarVersions('/tmp/export-MyApp-Versions.csv')

4.2.7 exportApplicationJarVersions
Use with WLST: Online.

4.2.7.1 Description
Used to export CSV format of runtime JARs versions of a specified application at a
specified location.

4.2.7.2 Syntax
exportApplicationJarVersions(applicationName, path)

Argument Definition
applicationName Application name to export JARs versions
path Location to export JARs versions.

4-6 Administrator's Guide for Oracle Application Development Framework

ADF-Specific WLST Commands

4.2.7.3 Example
This example shows how MyApp runtime JARs versions are exported to
/tmp/export-MyApp-Versions.csv. R/W privileges for the CSV file need to be
verified.
wls:/DefaultDomain/serverConfig>exportApplicationJarVersions('MyApp',
'/tmp/export-MyApp-Versions.csv')

4.2.8 exportApplicationSelectedJarVersions
Use with WLST: Online.

4.2.8.1 Description
Used to export CSV format of JARs versions of selected JARs at a specified location.

4.2.8.2 Syntax
exportApplicationSelectedJarVersions(applicationName, path, jarsLocation)

Argument Definition
applicationName Application name to export JARs versions.
path Location to extract JARs versions.
jarsLocation Optional list of selected JARs. If not specified, default JARs runtime
version list from
%WLSDOMAIN%/config/fmwconfig/Versions.xml will be
exported.
If the selectedJars property in Versions.xml is empty, version
information of adfm.jar, adf-richclient-impl-11.jar,
adf-controller.jar, adf-pageflow-impl.jar,
adf-share-support.jar and mdsrt.jar will be exported.

4.2.8.3 Example
This example shows how JARs versions are exported to
/tmp/export-MyApp-Versions.csv using the selectedJars property of the
Versions.xml file. In this case, since the jarsLocation parameter is not specified,
the libraries listed in the selectedJars property of the Versions.xml file will be
exported. R/W privileges for the CSV file need to be verified.
wls:/offline>exportApplicationSelectedJarVersions('MyApp',
'/tmp/export-MyApp-Versions.csv')

Versions.xml
<Diagnostics xmlns="xmlns.oracle.com/adf/diagnostics">
<Versions xmlns="xmlns.oracle.com/adf/diagnostics/versions"
exportVersionsOnApplicationStartup="true"
selectedJars="$ORACLE_HOME$/modules/oracle.adf.model_11.1.1/adfm.jar;
$ORACLE_HOME$/modules/oracle.adf.view_11.1.1/adf-richclient-impl-11.jar;
$ORACLE_HOME$/modules/oracle.adf.controller_11.1.1/adf-controller.jar;
$ORACLE_HOME$/modules/oracle.adf.pageflow_11.1.1/adf-pageflow-impl.jar;
$ORACLE_HOME$/modules/oracle.adf.share_11.1.1/adf-share-support.jar;
$ORACLE_HOME$/modules/oracle.mds_11.1.1/mdsrt.jar" />
</Diagnostics>

WLST Command Reference for ADF Applications 4-7

ADF-Specific WLST Commands

This example shows how JARs versions are exported to

/tmp/export-MyApp-Versions.csv using the jarsLocation parameter. In this
case, the libraries passed explicitly in the jarsLocation parameter will be exported.
R/W privileges for the CSV file need to be verified.
wls:/offline>exportApplicationSelectedJarVersions('MyApp',
'/tmp/export-MyApp-Versions.csv',
'$ORACLE_HOME$/modules/oracle.adf.model_11.1.1/adfm.jar;$ORACLE_
HOME$/modules/oracle.adf.view_11.1.1/adf-richclient-impl-11.jar')

4-8 Administrator's Guide for Oracle Application Development Framework

Part III
Part III Appendices

Part III contains the following chapters:

■ Appendix A, "ADF Runtime Libraries"
■ Appendix B, "wsadmin Command Reference for ADF Applications"
■ Appendix C, "Configuring GlassFish Server"
A
A ADF Runtime Libraries

This appendix provides a reference of the contents of ADF runtime libraries that are
deployed into Oracle WebLogic Server to support ADF applications.
The following ADF runtime libraries are described:
■ Section A.1, "Using JDeveloper to Find the ADF Runtime Library"
■ Section A.2, "adf.oracle.domain.webapp.war Library"
■ Section A.3, "adf.oracle.domain.ear Library"
■ Section A.4, "System Classpath"
■ Section A.5, "adf.desktopintegration.war Library"

A.1 Using JDeveloper to Find the ADF Runtime Library

In addition to the listings in this appendix, you can also use JDeveloper to find a JAR’s
corresponding ADF runtime library.

To find the ADF runtime library for a JAR:

1. In JDeveloper, select Tools > Manage Libraries.

2. In the Manage Libraries dialog Libraries tab, click the Search icon and select Jar
name from the dropdown list.
3. In the search field, enter the name of the JAR and click the search icon.

A.2 adf.oracle.domain.webapp.war Library

Table A–1 lists the JAR files that are packaged into the
adf.oracle.domain.webapp.war file and their corresponding ADF runtime
library.

Table A–1 adf.oracle.domain.webapp.war Library

JAR ADF Library
oracle.adf.controller_ ADF Controller Runtime
11.1.1/adf-controller-api.jar
oracle.adf.controller_ ADF Controller Runtime
11.1.1/adf-controller-rt-common.jar
oracle.adf.controller_ ADF Controller Runtime
11.1.1/adf-controller.jar

ADF Runtime Libraries A-1

adf.oracle.domain.webapp.war Library

Table A–1 (Cont.) adf.oracle.domain.webapp.war Library

JAR ADF Library
oracle.adf.pageflow_ ADF Page Flow Runtime
11.1.1/adf-pageflow-dtrt.jar
ADF Designtime API
oracle.adf.pageflow_ ADF Page Flow Runtime
11.1.1/adf-pageflow-fwk.jar
oracle.adf.pageflow_ ADF Page Flow Runtime
11.1.1/adf-pageflow-impl.jar
oracle.adf.pageflow_ ADF Page Flow Runtime
11.1.1/adf-pageflow-rc.jar
oracle.adf.view_11.1.1/adf-dt-at-rt.jar ADF Model Runtime
ADF Designtime API
oracle.adf.view_ ADF Faces Dynamic Components
11.1.1/adf-dynamic-faces.jar
oracle.adf.view_ ADF Faces Change Manager Runtime
11.1.1/adf-faces-changemanager-rt.jar 11
oracle.adf.view_ ADF Designtime API
11.1.1/adf-faces-databinding-dt-core.jar
oracle.adf.view_ Trinidad Databinding Runtime
11.1.1/adf-faces-databinding-rt.jar
ADF Faces Databinding Runtime
oracle.adf.view_ ADF Designtime API
11.1.1/adf-faces-templating-dt-core.jar
oracle.adf.view_ ADF Designtime API
11.1.1/adf-faces-templating-dtrt.jar
oracle.adf.view_ Trinidad Databinding Runtime
11.1.1/adf-richclient-api-11.jar
ADF Faces Runtime 11
oracle.adf.view_ Oracle Extended Selenium
11.1.1/adf-richclient-automation-11.jar (deprecated)
Oracle Extended Selenium (Server
excluded)
oracle.adf.view_ ADF Faces Runtime 11
11.1.1/adf-richclient-impl-11.jar
oracle.adf.view_11.1.1/adf-share-web.jar NA
oracle.adf.view_ ADF Designtime API
11.1.1/adf-view-databinding-dt-core.jar
oracle.adf.view_11.1.1/adf.constants.jar NA
oracle.adf.view_11.1.1/batik-anim.jar ADF DVT Faces Runtime
oracle.adf.view_ ADF DVT Faces Runtime
11.1.1/batik-awt-util.jar
oracle.adf.view_11.1.1/batik-bridge.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-codec.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-css.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-dom.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-ext.jar ADF DVT Faces Runtime

A-2 Administrator's Guide for Oracle Application Framework

adf.oracle.domain.webapp.war Library

Table A–1 (Cont.) adf.oracle.domain.webapp.war Library

JAR ADF Library
oracle.adf.view_ ADF DVT Faces Runtime
11.1.1/batik-extension.jar
oracle.adf.view_ ADF DVT Faces Runtime
11.1.1/batik-gui-util.jar
oracle.adf.view_11.1.1/batik-gvt.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-parser.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-script.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-svg-dom.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-svggen.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-swing.jar ADF DVT Faces Runtime
oracle.adf.view_ ADF DVT Faces Runtime
11.1.1/batik-transcoder.jar
oracle.adf.view_11.1.1/batik-util.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/batik-xml.jar ADF DVT Faces Runtime
oracle.adf.view_ Resource Bundle Variable Resolver
11.1.1/bundleresolver.jar
oracle.adf.view_11.1.1/dvt-basemaps.jar ADF DVT Faces Runtime
oracle.adf.view_ ADF Designtime API
11.1.1/dvt-databinding-dt-core.jar
oracle.adf.view_ BI Data Control Runtime
11.1.1/dvt-databindings.jar
ADF DVT Faces Databinding Runtime
oracle.adf.view_11.1.1/dvt-faces.jar ADF DVT Faces Runtime
oracle.adf.view_ BI Data Control Runtime
11.1.1/dvt-facesbindings.jar
ADF DVT Faces Databinding Runtime
oracle.adf.view_11.1.1/dvt-jclient.jar Oracle BI Graph
ADF DVT Core Runtime
ADF Swing Runtime
ADF DVT Faces Runtime
oracle.adf.view_11.1.1/dvt-trinidad.jar ADF DVT Core Runtime
ADF DVT Faces Runtime
oracle.adf.view_11.1.1/dvt-utils.jar BI Data Control Runtime
Oracle BI Graph
ADF DVT Core Runtime
ADF Swing Runtime
ADF DVT Faces Runtime
oracle.adf.view_11.1.1/inspect4.jar Obsolete JDeveloper Extension SDK
Oracle JEWT
oracle.adf.view_11.1.1/jewt4.jar BC4J Tester
Obsolete JDeveloper Extension SDK
Oracle Help for Java
Oracle JEWT

ADF Runtime Libraries A-3

adf.oracle.domain.ear Library

Table A–1 (Cont.) adf.oracle.domain.webapp.war Library

JAR ADF Library
oracle.adf.view_11.1.1/prefuse.jar ADF DVT Faces Runtime
oracle.adf.view_11.1.1/trinidad-api.jar ADF Faces Runtime 11
Trinidad Runtime 11
oracle.adf.view_11.1.1/trinidad-impl.jar ADF Faces Runtime 11
Trinidad Runtime 11
oracle.adf.view_11.1.1/xml-apis-ext.jar ADF DVT Faces Runtime
oracle.facesconfigdt_ ADF Faces Change Manager Runtime
11.1.1/facesconfigmodel.jar 11
oracle.facesconfigdt_11.1.1/taglib.jar ADF Faces Change Manager Runtime
11
oracle.xdk_11.1.0/xml.jar MDS Runtime Dependencies
Oracle XML Parser v2
XSQL Runtime
velocity-dep-1.4.jar ADF Designtime API

A.3 adf.oracle.domain.ear Library

Table A–2 lists the JAR files that are packaged into the adf.oracle.domain.ear file
and their corresponding ADF runtime library.

Table A–2 adf.oracle.domain.ear Library

JAR ADF Library
groovy-all-1.6.3.jar ADF Model Runtime
ADF Model Generic Runtime
BC4J Runtime
oracle.adf.model_ ADF Controller Schema
11.1.1/adf-controller-schema.jar
oracle.adf.model_ NA
11.1.1/adf-faces-registration.jar
oracle.adf.model_11.1.1/adf-runtime-mbean.jar NA
oracle.adf.model_11.1.1/adf-sec-idm-dc.jar User and Role Data Control
oracle.adf.model_11.1.1/adfbcsvc-client.jar BC4J Service Client
oracle.adf.model_ Kava SDO
11.1.1/adfbcsvc-registration.jar
oracle.adf.model_11.1.1/adfbcsvc-share.jar BC4J Service Runtime
BC4J Service Client
BC4J System Catalog
oracle.adf.model_11.1.1/adfbcsvc.jar BC4J Service Runtime
oracle.adf.model_11.1.1/adfdt_common.jar ADF Model Runtime
ADFm Designtime API
oracle.adf.model_11.1.1/adflibfilter.jar ADF Common Web Runtime

A-4 Administrator's Guide for Oracle Application Framework

adf.oracle.domain.ear Library

Table A–2 (Cont.) adf.oracle.domain.ear Library

JAR ADF Library
oracle.adf.model_11.1.1/adflibrary.jar ADF Model Runtime
ADFm Designtime API
oracle.adf.model_11.1.1/adfm-debugger.jar BC4J Tester
oracle.adf.model_11.1.1/adfm-sqldc.jar ADF SQL Data Control
Runtime
oracle.adf.model_11.1.1/adfm.jar BC4J EJB Client
ADF Model Runtime
BC4J Oracle Domains
ADF Model Generic Runtime
BC4J Runtime
ADF Swing Runtime
ADF Model API
BC4J EJB Runtime
BC4J Client
BC4J IAS Client
oracle.adf.model_11.1.1/adfmportlet.jar NA
oracle.adf.model_11.1.1/adfmweb.jar ADF Web Runtime
oracle.adf.model_11.1.1/adftags.jar Oracle ADF DataTag
oracle.adf.model_11.1.1/adftransactionsdt.jar ADF Model Runtime
ADFm Designtime API
ADF Designtime API
oracle.adf.model_11.1.1/bc4j-mbeans.jar BC4J Runtime
oracle.adf.model_11.1.1/bc4jhtml.jar BC4J Struts Runtime
oracle.adf.model_11.1.1/bc4jimdomains.jar Oracle Intermedia ADF Swing
Oracle Intermedia
oracle.adf.model_11.1.1/bc4jsyscat.jar BC4J System Catalog
oracle.adf.model_11.1.1/datatags.jar NA
oracle.adf.model_11.1.1/db-ca.jar BC4J EJB Client
ADF Model Runtime
BC4J Tester
BC4J Runtime
BC4J Client
BC4J IAS Client
DB Runtime (db-tests)
oracle.adf.model_ ADF DVT Faces Databinding
11.1.1/dvt-databindings-mds.jar MDS Runtime

ADF Runtime Libraries A-5

System Classpath

Table A–2 (Cont.) adf.oracle.domain.ear Library

JAR ADF Library
oracle.adf.model_11.1.1/jdev-cm.jar BC4J EJB Client
ADF Model Runtime
BC4J Tester
BC4J Runtime
Obsolete JDeveloper Extension
SDK
BC4J Client
BC4J IAS Client
Connection Manager
oracle.adf.model_11.1.1/jmxdc.jar JMX Data Control
oracle.adf.model_11.1.1/jr_dav.jar Resource Catalog Service
oracle.adf.model_11.1.1/mds-dc.jar NA
oracle.adf.model_11.1.1/oicons.jar ADFm Designtime API
oracle.adf.model_11.1.1/ordhttp.jar Oracle Intermedia ADF Swing
Oracle Intermedia
oracle.adf.model_11.1.1/ordim.jar Oracle Intermedia ADF Swing
Oracle Intermedia
oracle.adf.model_11.1.1/rcs-adflib-rt.jar NA
oracle.adf.model_11.1.1/rcsrt.jar Resource Catalog Service
oracle.adf.model_11.1.1/regexp.jar BC4J Tester
oracle.xdk_11.1.0/oraclexsql.jar NA
oracle.xdk_11.1.0/xsqlserializers.jar XSQL Runtime

A.4 System Classpath

Table A–3 lists the JAR files that are loaded into the system classpath and their
corresponding ADF runtime library.

Table A–3 System Classpath

JAR ADF Library
features/adf.security_11.1.1.jar NA
features/adf.share_11.1.1.jar NA
features/adf.share.ca_11.1.1.jar NA
oracle.adf.security_ ADF Model Runtime
11.1.1/adf-controller-security.jar
ADF Common Runtime
oracle.adf.security_ ADF Model Runtime
11.1.1/adf-share-security.jar
BC4J Security
ADF Common Runtime

A-6 Administrator's Guide for Oracle Application Framework

System Classpath

Table A–3 (Cont.) System Classpath

JAR ADF Library
oracle.adf.share_11.1.1/adf-share-support.jar MDS Runtime
Dependencies
ADF Model Generic
Runtime
BC4J Runtime
BC4J Security
ADF Common Runtime
oracle.adf.share_11.1.1/adf-share-wls.jar NA
oracle.adf.share_11.1.1/adflogginghandler.jar MDS Runtime
Dependencies
BC4J Tester
ADF Model Generic
Runtime
BC4J Runtime
ADF Common Runtime
oracle.adf.share_11.1.1/adfsharembean.jar BC4J Runtime
ADF Common Runtime
oracle.adf.share_11.1.1/commons-el.jar ADF Model Runtime
MDS Runtime
Dependencies
ADF Model Generic
Runtime
BC4J Runtime
oracle.adf.share_11.1.1/jsp-el-api.jar ADF Model Runtime
MDS Runtime
Dependencies
ADF Model Generic
Runtime
BC4J Runtime
oracle.adf.share_11.1.1/oracle-el.jar ADF Model Runtime
MDS Runtime
Dependencies
ADF Model Generic
Runtime
BC4J Runtime
oracle.adf.share.ca_11.1.1/adf-share-base.jar ADF Common Web
Runtime
MDS Runtime
Dependencies
ADF Model Generic
Runtime
BC4J Runtime
ADF Swing Runtime
BC4J Security
ADF Common Runtime

ADF Runtime Libraries A-7

System Classpath

Table A–3 (Cont.) System Classpath

JAR ADF Library
oracle.adf.share.ca_11.1.1/adf-share-ca.jar MDS Runtime
Dependencies
ADF Model Generic
Runtime
BC4J Runtime
BC4J Security
ADF Common Runtime
oracle.javatools_11.1.1/javamodel-rt.jar Java EE 1.5
J2EE 1.4
JAX-RPC Client
oracle.javatools_ NA
11.1.1/javatools-jndi-local.jar
oracle.javatools_11.1.1/javatools-nodeps.jar ADF Common Web
Runtime
MDS Runtime
Dependencies
Java EE 1.5
ADFm Designtime API
J2EE 1.4
JAX-RPC Client
DB Runtime (db-tests)
oracle.javatools_11.1.1/resourcebundle.jar ADF Desktop Integration
Runtime
Resource Bundle Support
BC4J Runtime
oracle.mds_11.1.1/mdslcm-client.jar NA
oracle.mds_11.1.1/mdslcm.jar NA
oracle.mds_11.1.1/mdsrt.jar MDS Runtime
oracle.mds_11.1.1/oramds.jar MDS Runtime
Dependencies
oracle.xmlef_11.1.1/xmlef.jar MDS Runtime
Dependencies
ADF Faces Change Manager
Runtime 11
ADF Model Generic
Runtime
Obsolete JDeveloper
Extension SDK
oracle.bali.share_11.1.1/share.jar MDS Runtime
Dependencies
BC4J Tester
ADF Model Generic
Runtime
Oracle Help for Java
Oracle JEWT

A-8 Administrator's Guide for Oracle Application Framework

adf.desktopintegration.war Library

A.5 adf.desktopintegration.war Library

Table A–4 lists the JAR files that are packaged into the
adf.desktopintegration.war file and their corresponding ADF runtime library.

Table A–4 adf.desktopintegration.war Library

JAR ADF Library
oracle.adf.desktopintegration_ ADF Desktop Integration Runtime
11.1.1/adf-desktop-integration.jar

ADF Runtime Libraries A-9

adf.desktopintegration.war Library

A-10 Administrator's Guide for Oracle Application Framework

B
wsadmin Command Reference for ADF
B

Applications

This chapter describes the wsadmin commands you can use to deploy, manage, and
configure Oracle ADF applications. wsadmin commands are intended to be used with
the IBM WebSphere Application Server.
This chapter includes the following sections:
■ Section B.1, "Overview of Custom wsadmin Commands for Oracle ADF"
■ Section B.2, "ADF-Specific WebSphere Commands"

B.1 Overview of Custom wsadmin Commands for Oracle ADF

Use the ADF-based URL Connections wsadmin commands to navigate the hierarchy
of configuration or runtime beans and control the prompt display. Use the
getADFMArchiveConfig commands to manage the ADFMArchiveConfig object.
Each command must be qualified by the module name. For example, if the module is
URLConnection.py, then the command can be invoked like this:
URLConnection.createFileUrlConnection. An example for the module
ADFAdmin.py would be ADFAdmin.getADFArchiveConfig.

B.2 ADF-Specific WebSphere Commands

Use the commands in Table B–1 to manage ADF applications.

Table B–1 Browse Commands for wsadmin Configuration

Use with
Use this command... To... wsadmin...
createFileUrlConnection Create a new ADF file Online or
connection. Offline
createHttpUrlConnection Create a new ADF URL Online or
connection. Offline
setURLConnectionAttributes Set or edit the attributes of a Online or
newly created or existing ADF Offline
connection.
listUrlConnection List a new URL connection. Online or
Offline
getADFMArchiveConfig Returns a handle to the Online or
ADFMArchiveConfig object Offline
for the specified archive.

wsadmin Command Reference for ADF Applications B-1

ADF-Specific WebSphere Commands

B.2.1 createFileUrlConnection
Use with wsadmin: Online or Offline.

B.2.1.1 Description
Use this command to creates a new connection based on the
oracle.adf.model.connection.url.FileURLConnection connection class.

B.2.1.2 Syntax
URLConnection.createFileURLConnection(appName, name, URL)

Argument Definition
appName Application name for which the connection will be created.
name The name of the new connection.
URL The URL associated with this connection.

B.2.1.3 Example
URLConnection.createFileURLConnection('myapp','tempDir','/scratch/tmp')

B.2.2 createHttpUrlConnection
Use with wsadmin: Online or Offline.

B.2.2.1 Description
Use this command to create a new connection based on the
oracle.adf.model.connection.url.HttpURLConnection connection type
class.

B.2.2.2 Syntax
URLConnection.createHttpURLConnection (appName, name, [URL], [authenticationType],
[realm], [user], [password])

B.2.2.3 Example
URLConnection.createHttpURLConnection('myapp','cnn','http://www.cnn.com')

B.2.3 setURLConnectionAttributes
Use with wsadmin: Online or Offline.

B-2 Administrator's Guide for Oracle Application Framework

ADF-Specific WebSphere Commands

B.2.3.1 Description
Use this command to set or edit the attributes of a newly created or existing ADF
connection.

B.2.3.2 Syntax
URLConnection.setURLConnectionAttributes(appname, connectionname, attributes)

Argument Definition
appname Application name.
connectionname The name of the connection.
attributes The array containing attributes to set in key/value pairs.

B.2.3.3 Example
URLConnection.setURLConnectionAttributes
('myapp','cnn',’ChallengeAuthenticationType:digest’,
’AuthenticationRealm:XMLRealm’

B.2.4 listUrlConnection
Use with wsadmin: Online or Offline.

B.2.4.1 Description
Use this command to list the connections of the application.

B.2.4.2 Syntax
URLConnection.listURLConnection(appname)

Argument Definition
appname Application name.

B.2.4.3 Example
URLConnection.listURLConnection ('myapp')

B.2.5 getADFMArchiveConfig
Use with wsadmin: Online or Offline.

B.2.5.1 Description
Returns a handle to the ADFMArchiveConfig object for the specified archive. The
returned ADFMArchiveConfig object's methods can be used to change application
configuration in an archive.
The ADFMArchiveConfig object provides the following methods:
■ setDatabaseJboSQLBuilder([value]) - Sets the Database
jbo.SQLBuilder attribute.
■ getDatabaseJboSQLBuilder() - Returns the current value of the
jbo.SQLBuilder attribute.

wsadmin Command Reference for ADF Applications B-3

ADF-Specific WebSphere Commands

■ setDatabaseJboSQLBuilderClass([value]) - Sets the Database

jbo.SQLBuilderClass attribute.
■ getDatabaseJboSQLBuilderClass() - Returns the current value of the
jbo.SQLBuilderClass attribute.
■ setDefaultRowLimit([value])- Sets the defaults rowLimit attribute. Value
is a long specifying the row limit (Default -1).
■ getDefaultRowLimit() - Returns the current value of the rowLimit attribute.
■ save([toLocation]) - If you specify the toLocation, then the changes will
be stored in the target archive file and the original file will remain unchanged.
Otherwise, the changes will be saved in the original file itself.

B.2.5.2 Syntax
archiveConfigObject = ADFMAdmin.getADFMArchiveConfig(fromLocation)

Argument Definition
fromLocation The name of the ear file, including its complete path.

The syntax for setDatabaseJboSQLBuilder([value]) is:

archiveConfigObject.setDatabaseJboSQLBuilder([value])

The syntax for getDatabaseJboSQLBuilder() is:

archiveConfigObject.getDatabaseJboSQLBuilder()

The syntax for setDatabaseJboSQLBuilderClass([value]) is:

archiveConfigObject.setDatabaseJboSQLBuilderClass([value])

Argument Definition
value The value of the jbo.SQLBuilderClass attribute.

The syntax for getDatabaseJboSQLBuilderClass() is:

archiveConfigObject.getDatabaseJboSQLBuilderClass()

The syntax for save([toLocation]) is:

archiveConfigObject.save([toLocation])

Argument Definition
toLocation The file name along with the absolute path to store the changes.

B-4 Administrator's Guide for Oracle Application Framework

ADF-Specific WebSphere Commands

B.2.5.3 Example
In the following example, if the adf-config.xml file in the archive does not have
the application and shared metadata repositories defined, then you should provide the
complete connection information.
# Open something.ear and return an object which can be used
# manipulate it
archive = ADFMAdmin.getADFMArchiveConfig('/path/to/something.ear')

# Return current JBO SQL Builder value

archive.getDatabaseJboSQLBuilder()

# Change JBO SQL Builder value to Oracle

archive.setDatabaseJboSQLBuilder('Oracle')

# Save the changes back to the original file

archive.save()

archive = ADFMAdmin.getADFMArchiveConfig('/path/to/something.ear')
archive.getDatabaseJboSQLBuilder()

In the following example. the jbo.SQLBuilder attribute is set to 'DB2'.

wsadmin> archive =
ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wsadmin> archive.setDatabaseJboSQLBuilder(value='DB2')
wsadmin> archive.save()

In the following example, the jbo.SQLBuilder attribute is removed so that

application default is used.
wsadmin> archive =
ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wsadmin> archive.setDatabaseJboSQLBuilder()
wsadmin> archive.save(toLocation='/tmp/targetArchive.ear')

In the following example, the jbo.SQLBuilder attribute is set to 'Custom', and the
jbo.SQLBuilderClass attribute is set to the class 'com.example.CustomBuilder'.
wsadmin> archive =
ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wsadmin> archive.setDatabaseJboSQLBuilder('Custom')
wsadmin> archive.setDatabaseJboSQLBuilderClass('com.example.CustomBuilder')
wsadmin> archive.save(toLocation='/tmp/targetArchive.ear')

In the following example, the rowLimit attribute is set to 100.

wsadmin:/offline> archive =
getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wsadmin:/offline> archive.setDefaultRowLimit(100)
wsadmin:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

wsadmin Command Reference for ADF Applications B-5

ADF-Specific WebSphere Commands

B-6 Administrator's Guide for Oracle Application Framework

C
CConfiguring GlassFish Server

This appendix describes how to configure GlassFish Server for Oracle ADF Essentials.
It describes how to obtain the Oracle ADF Runtime and how to install these files into
the GlassFish Server.
This appendix contains the following sections:
■ Section C.1, "About Configuring GlassFish"
■ Section C.2, "Obtaining GlassFish Server and Oracle ADF Runtime"
■ Section C.3, "Configuring GlassFish with ADF Runtime Libraries"
■ Section C.4, "Additional Configuration Tasks"
■ Section C.5, "Deploying an ADF Application to GlassFish"

C.1 About Configuring GlassFish

GlassFish Server is an application server that can be configured to run Oracle ADF
applications. If you do not have a GlassFish Server installation, you can download
GlassFish Server from the GlassFish website. Before you can run ADF applications in a
GlassFish Server, you need to configure GlassFish with the Oracle ADF Runtime
libraries.
For a list of the supported Oracle ADF features for GlassFish, go to the OTN site at
http://content.oracle.com/technetwork/developer-tools/adf/overvi
ew/adf-essentials-1719844.html
For instructions on obtaining and installing GlassFish, see
http://glassfish.java.net/downloads/3.1.2-final.html
For information about developing ADF applications for GlassFish, see the "Deploying
ADF Applications to GlassFish" appendix in the Oracle Fusion Middleware Fusion
Developer's Guide for Oracle Application Development Framework.

C.2 Obtaining GlassFish Server and Oracle ADF Runtime

Oracle ADF Essentials supports the Open Source and commercial versions of
GlassFish Server. With either version, you will need the Full Platform distribution. The
Web Profile distribution is not supported. After you have installed the GlassFish
Server, you need to obtain the ADF Essentials adf-essentials.zip file from OTN
and follow the instructions in this appendix to install the ADF Runtime libraries.
For information on how to start and stop the server and other application server tasks,
see GlassFish documentation at the GlassFish website.

Configuring GlassFish Server C-1

Configuring GlassFish with ADF Runtime Libraries

C.2.1 How to Obtain GlassFish Server

You can download the open source version of the GlassFish Server from the GlassFish
website:
http://glassfish.java.net/downloads/3.1.2-final.html
Follow the instructions and documentation at the site to install and configure a
GlassFish Server.

C.2.2 How to Obtain Oracle ADF Runtime

In order for a GlassFish Server to run Oracle ADF applications, you must install the
ADF Runtime library files into the GlassFish installation directory.
You can download the Oracle ADF Essentials adf-essentials.zip file from the
Oracle Technology Network at
http://www.oracle.com/go/?&Src=7578263&Act=4&pcode=WWMK12022244M
PP044.
After you have downloaded the adf-essentials.zip file, you can extract the files
to a temporary directory which you can use to copy the required files into the
GlassFish installation directories.

C.3 Configuring GlassFish with ADF Runtime Libraries

The ADF Runtime libraries consists of the following:
■ ADF Share libraries
■ ADF Model libraries
■ ADF Controller libraries
■ ADF View libraries
The ADF Share libraries must be manually installed into the GlassFish installation.
You use your operating system command or tools to copy the files. For instructions,
see Section C.3.1, "How to Install ADF Share Libraries Manually."
The ADF Model, ADF Controller, and ADF View libraries are loaded into GlassFish
with the deployed application and will be included automatically by JDeveloper.
The steps for installing the ADF Runtime libraries are:
1. Configure ADF Share libraries.
■ Copy the ADF Share libraries from adf-essentials.zip into the GlassFish
installation.
2. Deploy the application as an EAR file.

C.3.1 How to Install ADF Share Libraries Manually

Before you begin:
It may be helpful to have an understanding of the options that are available to you
when you are mapping ADF Share for GlassFish. For more information, see
Section C.3, "Configuring GlassFish with ADF Runtime Libraries."
You will need to complete these tasks:
■ Install the GlassFish Server

C-2 Administrator's Guide for Oracle Application Development Framework

Additional Configuration Tasks

■ Obtain the adf-community.zip file and unzip it to a temporary directory

To install the ADF Share Runtime libraries:

1. Copy or move the ADF Share library files from the temporary directory to the
<glassfish>/domains/domain1/lib folder:
The ADF Share files should be in the temporary directory where you had unzip
the adf-essentials.zip file as described in Section C.2.2, "How to Obtain
Oracle ADF Runtime." Typically, this directory is <temp>/oracle_
common/modules.
oracle.adf.share.ca_11.1.1/adf-share-base.jar
oracle.adf.share.ca_11.1.1/adf-share-ca.jar
oracle.adf.share_11.1.1/commons-el.jar
oracle.adf.share_11.1.1/adf-share-support.jar
oracle.adf.share_11.1.1/adfsharembean.jar
oracle.adf.share_11.1.1/jsp-el-api.jar
oracle.adf.share_11.1.1/adflogginghandler.jar
oracle.adf.share_11.1.1/oracle-el.jar
oracle.mds_11.1.1/mdsrt.jar
oracle.bali.share_11.1.1/share.jar
oracle.xmlef_11.1.1/xmlef.jar
oracle.javatools_11.1.1/resourcebundle.jar
oracle.javatools_11.1.1/javamodel-rt.jar
oracle.javatools_11.1.1/javatools-nodeps.jar
oracle.adf.security_11.1.1/adf-share-security.jar
oracle.adf.security_11.1.1/adf-controller-security.jar
oracle.xdk_11.1.0/xmlparserv2_sans_jaxp_services.jar
oracle.xdb_11.1.0.jar
oracle.jrf_11.1.1/jrf-api.jar
oracle.jdbc_11.1.1/ojdbc6dms.jar
oracle.dms_11.1.1/dms.jar
oracle.odl_11.1.1/ojdl.jar
oracle.odl_11.1.1/ojdl2.jar
oracle.jmx_11.1.1/jmxframework.jar
oracle.jmx_11.1.1/jmxspi.jar
oracle.classloader_11.1.1.jar
oracle.logging-utils_11.1.1.jar
oracle.web-common_11.1.1.jar
oracle.webservices_11.1.1/oc4j-ws-support.jar
org.apache.bcel_5.1.jar
oracle.nlsrtl_11.2.0/orai18n-mapping.jar

2. Verify all the libraries have been copied.

C.4 Additional Configuration Tasks

After you have installed the ADF Runtime into the GlassFish Server, you need to
perform additional configuration tasks on GlassFish.
The configuration tasks are:
■ Section C.4.1, "GlassFish Administration Console"
■ Section C.4.2, "How to Create a Datasource for GlassFish"
■ Section C.4.3, "How to Configure the JVM Cache"

Configuring GlassFish Server C-3

Additional Configuration Tasks

C.4.1 GlassFish Administration Console

You can use the GlassFish Administration Console to configure the GlassFish Server
including managing applications, JDBC pools, and other resources.
The GlassFish Administration Console is at:
http://<machine_name>:4848/

C.4.2 How to Create a Datasource for GlassFish

Before you begin:
It may be helpful to have an understanding of the options that are available to you
when you are creating a datasource for GlassFish. For more information, see
Section C.2, "Obtaining GlassFish Server and Oracle ADF Runtime."
You can use the GlassFish Administration Console or asadmin commands to create
the datasource. For more information, see GlassFish documentation.

To create a datasource for GlassFish using asadmin command:

1. Open a command line window.

2. Invoke the asadmin command to create a datasource for GlassFish.

For instance, the following command creates a datasource for an application:
asadmin> create-jdbc-connection-pool --datasourceclassname
oracle.jdbc.pool.SampleDataSource
--restype javax.sql.XADataSource
--property user=xyz
:password=xyz:url=jdbc:oracle:thin:@machine.com:1521:machine
--target=server SampleDSPool

asadmin> ping-connection-pool SampleDSPool

asadmin> create-jdbc-resource --connectionpoolid SampleDSPool jdbc/OracleDS

C.4.3 How to Configure the JVM Cache

You need to configure the JVM settings to simple and increase the memory size from
192 Mb to 512 Mb.

Before you begin:

It may be helpful to have an understanding of the options that are available to you
when you are configuring JVM for GlassFish. For more information, see Section C.4,
"Additional Configuration Tasks."

To configure JVM Cache for MDS:

1. Start the GlassFish Administration Console.

2. Choose Configurations > server-config > JVM Settings.

3. Select JVM Options and specify -Doracle.mds.cache=simple and
XX:MaxPermSize=512m.
4. Click Save.

C-4 Administrator's Guide for Oracle Application Development Framework

Deploying an ADF Application to GlassFish

5. Or, open the <glassfish>/domains/domain1/config/domain.xml file and

edit the following entries:
<jvm-options>-XX:MaxPermSize=512m</jvm-options>
<jvm-options>-Doracle.mds.cache=simple</jvm-options>

C.5 Deploying an ADF Application to GlassFish

After you have referenced the libraries in the application, you can proceed to deploy
the application to GlassFish Server. For more information, see the "Deploying ADF
Applications to GlassFish" appendix in the Oracle Fusion Middleware Fusion Developer's
Guide for Oracle Application Development Framework.

Configuring GlassFish Server C-5

Deploying an ADF Application to GlassFish

C-6 Administrator's Guide for Oracle Application Development Framework

Administering Oracle Unified Directory
No ratings yet
Administering Oracle Unified Directory
1,564 pages
High Availability Overview and Best Practices
No ratings yet
High Availability Overview and Best Practices
728 pages
High Availability Overview and Best Practices
No ratings yet
High Availability Overview and Best Practices
669 pages
Oracle® Advanced Support Gateway: User's Guide
No ratings yet
Oracle® Advanced Support Gateway: User's Guide
140 pages
Oracle Exadata Database Service Cloudcustomer
No ratings yet
Oracle Exadata Database Service Cloudcustomer
1,152 pages
Installation and Configuration Guide Exadata Database Machine Dbmin
No ratings yet
Installation and Configuration Guide Exadata Database Machine Dbmin
323 pages
Oracle SOABusiness Rules
No ratings yet
Oracle SOABusiness Rules
152 pages
Oracle Fusion Applications Human Capital Management Reference Manual
No ratings yet
Oracle Fusion Applications Human Capital Management Reference Manual
710 pages
ADF Tutorial
No ratings yet
ADF Tutorial
170 pages
Getting Started With ODI 11gR1
No ratings yet
Getting Started With ODI 11gR1
104 pages
Data Warehousing Guide
No ratings yet
Data Warehousing Guide
530 pages
ADF Developer Guide
No ratings yet
ADF Developer Guide
676 pages
Oracle Fusion Middle Ware Web User Interface Guide
No ratings yet
Oracle Fusion Middle Ware Web User Interface Guide
644 pages
FWM Concepts
No ratings yet
FWM Concepts
80 pages
Oracle Transparent Gateway For DRDA Installation and Users Guide
No ratings yet
Oracle Transparent Gateway For DRDA Installation and Users Guide
254 pages
M1 Formula Book
No ratings yet
M1 Formula Book
27 pages
11.5.10.2 System Maintiance Guide
No ratings yet
11.5.10.2 System Maintiance Guide
394 pages
Oracle Database Gateway - Installation and Configuration Guide 11gR1
No ratings yet
Oracle Database Gateway - Installation and Configuration Guide 11gR1
222 pages
Adapters
No ratings yet
Adapters
280 pages
Oracle 10g Guide
No ratings yet
Oracle 10g Guide
582 pages
Oracle 10g Application Developers Guide Fundamentals
No ratings yet
Oracle 10g Application Developers Guide Fundamentals
582 pages
Oracle® Database
No ratings yet
Oracle® Database
196 pages
Functional Upgrade Guide
No ratings yet
Functional Upgrade Guide
318 pages
Oracle® Application Server: Adapter Installation Guide 10g Release 3 (10.1.3.1.0)
No ratings yet
Oracle® Application Server: Adapter Installation Guide 10g Release 3 (10.1.3.1.0)
42 pages
CISSP Simplilearn
80% (5)
CISSP Simplilearn
969 pages
Oracle® Database
No ratings yet
Oracle® Database
402 pages
Oracle® Fusion Middleware: Installation Guide For Oracle Data Integrator 11g Release 1 (11.1.1)
No ratings yet
Oracle® Fusion Middleware: Installation Guide For Oracle Data Integrator 11g Release 1 (11.1.1)
120 pages
Oracle® Applications: Developer's Guide Release 12
No ratings yet
Oracle® Applications: Developer's Guide Release 12
620 pages
Oracle Fusion Applications Post-Installation Guide
No ratings yet
Oracle Fusion Applications Post-Installation Guide
124 pages
Oracle Database Application Developer's Guide - Fundamentals b14251
No ratings yet
Oracle Database Application Developer's Guide - Fundamentals b14251
440 pages
Features of Accounts Class by Accounts Funda 2024-25
No ratings yet
Features of Accounts Class by Accounts Funda 2024-25
42 pages
IAS Best Practice
No ratings yet
IAS Best Practice
164 pages
Oracle Applications Concepts R12
No ratings yet
Oracle Applications Concepts R12
196 pages
Oracle® Isetup: Developer'S Guide Release 12.1
No ratings yet
Oracle® Isetup: Developer'S Guide Release 12.1
62 pages
Apps Concept
No ratings yet
Apps Concept
208 pages
115 HZRG
No ratings yet
115 HZRG
318 pages
Lesson 1 CSE472 Spring 2024
No ratings yet
Lesson 1 CSE472 Spring 2024
26 pages
(FREE PDF Sample) (Ebook) High Performance PostgreSQL For Rails (Beta) : Reliable, Scalable, Maintainable Database Applications by Andrew Atkinson ISBN 9798888650387, 8888650385 Ebooks
100% (1)
(FREE PDF Sample) (Ebook) High Performance PostgreSQL For Rails (Beta) : Reliable, Scalable, Maintainable Database Applications by Andrew Atkinson ISBN 9798888650387, 8888650385 Ebooks
76 pages
Cyber Security Courseware With Tools & Labsetup - Santosh Chaluvadi
No ratings yet
Cyber Security Courseware With Tools & Labsetup - Santosh Chaluvadi
55 pages
DM Trends
No ratings yet
DM Trends
49 pages
Stock Analysis Spreadsheet (10YR, 2024) (Vers 4.2) PUBLIC
No ratings yet
Stock Analysis Spreadsheet (10YR, 2024) (Vers 4.2) PUBLIC
17 pages
Oracle® Applications: Concepts Release 11i (11.5.10.2)
No ratings yet
Oracle® Applications: Concepts Release 11i (11.5.10.2)
160 pages
Oracle® Applications: Concepts Release 11i (11.5.10)
No ratings yet
Oracle® Applications: Concepts Release 11i (11.5.10)
154 pages
Fashion - Worldwide Statista Market Forecast
No ratings yet
Fashion - Worldwide Statista Market Forecast
1 page
Multiple Application Integration Guide: Oracle ATG One Main Street Cambridge, MA 02142 USA
No ratings yet
Multiple Application Integration Guide: Oracle ATG One Main Street Cambridge, MA 02142 USA
34 pages
RAJU
No ratings yet
RAJU
25 pages
120fincg Oracle® Financials Concepts Guide
No ratings yet
120fincg Oracle® Financials Concepts Guide
128 pages
HCPP-03 - Small - and Medium-Sized Campus Network Design Guide-2022.01
No ratings yet
HCPP-03 - Small - and Medium-Sized Campus Network Design Guide-2022.01
77 pages
R12 - Financials For India - IGuide
No ratings yet
R12 - Financials For India - IGuide
102 pages
Factors Influencing Intention of Mobile Application Use Seok Kang Department of Communication, University of Texas at San Antonio
No ratings yet
Factors Influencing Intention of Mobile Application Use Seok Kang Department of Communication, University of Texas at San Antonio
20 pages
Assignment 01 Logika Matematika
No ratings yet
Assignment 01 Logika Matematika
14 pages
Financify
No ratings yet
Financify
8 pages
PR Digital Readouts Linear Encoders ID208864 en
No ratings yet
PR Digital Readouts Linear Encoders ID208864 en
19 pages
SAQA - 115431 - Learner Guide
No ratings yet
SAQA - 115431 - Learner Guide
21 pages
Oracle® Exadata Storage Server Hardware: Read This First 11 Release 2 (11.2)
No ratings yet
Oracle® Exadata Storage Server Hardware: Read This First 11 Release 2 (11.2)
2 pages
Group Assignment Logistic and Supply Chain Management ALS2023
No ratings yet
Group Assignment Logistic and Supply Chain Management ALS2023
29 pages
An Overview of Electronics and Communication
No ratings yet
An Overview of Electronics and Communication
18 pages
SQL Class-12
No ratings yet
SQL Class-12
12 pages
Final Project Report Mobile Phone Jammer
No ratings yet
Final Project Report Mobile Phone Jammer
19 pages
Beginner's Guide To Make A Game Controller
No ratings yet
Beginner's Guide To Make A Game Controller
23 pages
Oracle® Clusterware: Installation Guide 11g Release 1 (11.1) For Microsoft Windows
No ratings yet
Oracle® Clusterware: Installation Guide 11g Release 1 (11.1) For Microsoft Windows
106 pages
Oracle® Service Contracts: Implementation Guide Release 12
No ratings yet
Oracle® Service Contracts: Implementation Guide Release 12
134 pages
Log
No ratings yet
Log
3 pages
Contoh Resume Jurnal Pendidikan
No ratings yet
Contoh Resume Jurnal Pendidikan
4 pages
Final Exam Comp 213
No ratings yet
Final Exam Comp 213
11 pages
Erro
No ratings yet
Erro
9 pages
Pagerank Explained Simple
No ratings yet
Pagerank Explained Simple
4 pages
CIS-240-101-12FA Data Communications Course Syllabus
No ratings yet
CIS-240-101-12FA Data Communications Course Syllabus
9 pages
2015 KS2 L3-5 EnglishGPS Paper2 Spelling PDFA
No ratings yet
2015 KS2 L3-5 EnglishGPS Paper2 Spelling PDFA
4 pages
Name: - Date: - APCSA - Loops Worksheet 1
No ratings yet
Name: - Date: - APCSA - Loops Worksheet 1
2 pages
Lazel's Resume
No ratings yet
Lazel's Resume
1 page
Oracle JDeveloper 11g Handbook: A Guide to Fusion Web Development
From Everand
Oracle JDeveloper 11g Handbook: A Guide to Fusion Web Development
Duncan Mills
No ratings yet
Learning Docker
From Everand
Learning Docker
Pethuru Raj
5/5 (5)
Microsoft Azure Fundamentals Exam Prep AZ 900
From Everand
Microsoft Azure Fundamentals Exam Prep AZ 900
iCertify Training
No ratings yet
Design Principles in Architecture
From Everand
Design Principles in Architecture
Rajendra Asan
No ratings yet
Cloud Computing : Beginners And Intermediate User Guide
From Everand
Cloud Computing : Beginners And Intermediate User Guide
David comer
No ratings yet
React.js for A Beginners Guide : From Basics to Advanced - A Comprehensive Guide to Effortless Web Development for Beginners, Intermediates, and Experts
From Everand
React.js for A Beginners Guide : From Basics to Advanced - A Comprehensive Guide to Effortless Web Development for Beginners, Intermediates, and Experts
Daniel Walker
No ratings yet
Docker Unveiled: The Comprehensive Handbook to Streamlined Development
From Everand
Docker Unveiled: The Comprehensive Handbook to Streamlined Development
William Drake
No ratings yet
Oracle Exalytics Revealed: E-Book
From Everand
Oracle Exalytics Revealed: E-Book
Mark Rittman
No ratings yet
Mastering Azure Kubernetes Service (AKS): Rapidly Build and Scale Your Containerized Applications with Microsoft Azure Kubernetes Service (English Edition)
From Everand
Mastering Azure Kubernetes Service (AKS): Rapidly Build and Scale Your Containerized Applications with Microsoft Azure Kubernetes Service (English Edition)
Abhishek Mishra
No ratings yet
Docker: A Quick-Start Beginner's Guide
From Everand
Docker: A Quick-Start Beginner's Guide
Andy Hayes
3.5/5 (2)
Plain JavaScript: Learning the Front-End
From Everand
Plain JavaScript: Learning the Front-End
Roger Beans-Rivet
No ratings yet
Introduction to Oracle Database Administration
From Everand
Introduction to Oracle Database Administration
Ying Wang
5/5 (1)
JAVA PROGRAMMING FOR BEGINNERS: Master Java Fundamentals and Build Your Own Applications (2023 Crash Course)
From Everand
JAVA PROGRAMMING FOR BEGINNERS: Master Java Fundamentals and Build Your Own Applications (2023 Crash Course)
Theo Houle
No ratings yet
VMware vRealize Orchestrator Essentials: Get hands-on experience with vRealize Orchestrator and automate your VMware environment
From Everand
VMware vRealize Orchestrator Essentials: Get hands-on experience with vRealize Orchestrator and automate your VMware environment
Daniel Langenhan
No ratings yet
Advanced Multiplayer Game Development with Ureal Engine 5: A Comprehensive Guide to C++ Scripting
From Everand
Advanced Multiplayer Game Development with Ureal Engine 5: A Comprehensive Guide to C++ Scripting
Vladimir Kiselev
No ratings yet
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
From Everand
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
Jay Nans
No ratings yet
Transit Quarters
From Everand
Transit Quarters
Shyamala Nemana
4/5 (8)
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet
Exam AZ-800: Administering Windows Server Hybrid Core Infrastructure Preparation
From Everand
Exam AZ-800: Administering Windows Server Hybrid Core Infrastructure Preparation
Georgio Daccache
No ratings yet