Oracle® Fusion Applications

Administrator's Guide

11g Release 8 (11.1.8)

E14496-20

June 2014

Documentation for system administrators that describes how to administer the Oracle Fusion Applications environment, including how to start and stop components, change passwords, monitor the environment, logging, backup and recovery, configure high availability, and troubleshooting.

Oracle Fusion Applications Administrator's Guide, 11g Release 8 (11.1.8)

E14496-20

Copyright © 2014  Oracle and/or its affiliates. All rights reserved.

Primary Author: Amy Lodato (lead), Shelly Butcher, Thom Chumley, Christine Ford, Helen Grembowicz, Vinaye Misra, Leslie Studdard, Carlos Subi, Karen Summerly, Madhubala Ponnekanti

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

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

What's New in This Guide

- New and Changed Features for 11g Release 8 (11.1.8)

- Other Significant Changes in this Document for 11g Release 8 (11.1.8)

Part I Understanding Oracle Fusion Applications

1 Introduction to Oracle Fusion Applications for Systems Administrators

- 1.1 Architecture of Oracle Fusion Applications

- 1.1.1 Oracle Fusion Applications Product Families

- 1.1.2 Oracle Fusion Middleware Infrastructure Components

- 1.1.3 Oracle Fusion Middleware Components

- 1.1.4 Oracle Database

- 1.1.5 Oracle Enterprise Manager Fusion Applications Control

- 1.1.6 Oracle Enterprise Manager Cloud Control

- 1.1.7 Oracle Enterprise Manager Database Control

- 1.2 Key Oracle Fusion Applications Concepts

- 1.2.1 Understanding Provisioning

- 1.2.1.1 Installation Options

- 1.2.1.2 Installing an Oracle Database and Loading Content

- 1.2.2 Oracle WebLogic Server Domains Configuration

- 1.2.3 Provisioned Oracle Fusion Applications Home Directories

- 1.3 Security Features in Oracle Fusion Applications

- 1.4 Roadmap for Administering Oracle Fusion Applications

Part II Basic Administration

2 Getting Started with Administering Oracle Fusion Applications

- 2.1 Introduction to the Tools Used to Administer Oracle Fusion Applications

- 2.2 Key Differences Between Fusion Applications Control and Cloud Control

- 2.3 When to Use Fusion Applications Control Tool, When to Use Oracle WebLogic Server Administration Console

- 2.4 Finding the Administration Server Port and Other Administrative URLs for Domains

- 2.5 Using Fusion Applications Control

- 2.5.1 Understanding How Fusion Applications Control Compares with Fusion Middleware Control

- 2.5.2 Accessing Fusion Applications Control

- 2.5.3 Using Fusion Applications Control Help

- 2.5.4 Navigating within Fusion Applications Control

- 2.5.5 Understanding the Targets in the Target Navigation Pane

- 2.5.6 Navigating to the Product Family and Product Administration Pages

- 2.5.7 Viewing the Performance of Targets

- 2.5.8 Understanding Users and Roles for Fusion Applications Control

- 2.6 Using Oracle Authorization Policy Manager

- 2.6.1 Understanding Authorization Policy Manager

- 2.6.2 Accessing Authorization Policy Manager

- 2.6.3 Navigating Within Authorization Policy Manager

- 2.6.3.1 Understanding the Main Tabs

- 2.6.3.2 Using The Navigation Panel

- 2.6.3.3 Understanding the Home Area

- 2.6.3.4 Accessing Help

- 2.6.4 Searching within Authorization Policy Manager

- 2.6.4.1 Finding Objects with a Simple Search

- 2.6.4.2 Finding Objects with an Advanced Search

- 2.7 Using Oracle WebLogic Server Administration Console

- 2.7.1 Starting Oracle WebLogic Server Administration Console

- 2.7.2 Locking the WebLogic Server Configuration

- 2.8 Using Cloud Control

- 2.8.1 Starting to Use Cloud Control and Discovering Targets

- 2.8.2 Rediscovering Oracle Fusion Applications Targets

- 2.8.3 Removing Oracle Fusion Applications Targets

- 2.8.4 Navigating the Fusion Applications Target Home Page in Cloud Control

- 2.8.5 Using Cloud Control Help

- 2.9 Using Oracle Fusion Functional Setup Manager

- 2.10 Caution Against Using Database Tools to Modify Oracle Fusion Applications Data

3 Installing and Maintaining Oracle Fusion Applications Languages

- 3.1 Installing and Upgrading Languages

- 3.1.1 Language Packs

- 3.1.2 Language Pack Installer

- 3.1.2.1 Installer User Interface

- 3.1.3 Language in the Policy Store

- 3.1.4 Language Pack Installer Configuration Assistants

- 3.1.4.1 Parallel Configuration Assistants

- 3.2 Pre-Installation Steps - Before Down Time

- 3.2.1 Before You Begin

- 3.2.2 Download the Language Pack Repository

- 3.2.3 Download Mandatory Post-Installation NLS Patches

- 3.2.4 Confirm the Oracle Fusion Applications Installation is Complete

- 3.2.5 Confirm Database Settings

- 3.2.6 Maintain Versions of Customized BI Publisher Reports

- 3.2.7 Run Health Checker for Pre-Down Time Checks

- 3.3 Pre-Installation Steps - During Down Time

- 3.3.1 Run Health Checker for General System Health Checks

- 3.3.2 Back Up Oracle Fusion Applications

- 3.3.2.1 Back Up Steps for Windows Platforms

- 3.3.3 Apply Mandatory Prerequisite Patches

- 3.4 Install a Language

- 3.4.1 Run Language Pack Installer in GUI Mode

- 3.4.2 Run Language Pack Installer in Silent Mode

- 3.5 Complete the Post-Installation Tasks

- 3.5.1 Confirm Database Artifact Deployments Were Successful

- 3.5.2 Review Log Files for Errors or Exceptions

- 3.5.3 Run Health Checker for Post Installation Checks

- 3.5.4 Bounce All Servers and Verify the Status of Deployed Applications

- 3.5.5 Reload Custom Templates for BI Publisher Reports

- 3.5.6 Perform Steps in NLS Release Notes

- 3.6 Troubleshoot Language Pack Installer Sessions

- 3.6.1 Log Directories for Language Pack Installer Tasks

- 3.6.2 Troubleshooting Failures During the Installation Phase

- 3.6.3 General Troubleshooting During the Configuration Phase in GUI Mode

- 3.6.3.1 Restart a Failed Installer Session

- 3.6.3.2 Troubleshoot Failures While Parallel Tasks Are Running

- 3.6.3.3 The Next Button Is Not Enabled During Configuration Assistants

- 3.6.3.4 The OPSS Security Store Goes Down While the Installer is Running

- 3.6.3.5 Failure During Opening of Wallet Based Credential Store

- 3.6.3.6 Error While Loading Database Components in GUI Mode

- 3.6.4 General Troubleshooting During the Configuration Phase in Silent Mode

- 3.6.5 Recovering From a Language Pack Installer Session That Was Shut Down

- 3.6.6 Troubleshooting Applying Middleware Patches

- 3.6.7 Troubleshooting Loading Database Components

- 3.6.8 Troubleshooting Deployment of Applications Policies

- 3.6.9 Troubleshooting Deployment of BI Publisher Artifacts

- 3.6.10 Resolve JAZN Conflicts Found by Health Checker

- 3.6.11 Installer Requirement Checks Fail

- 3.6.12 Language Pack Installer Fails Due To Thread Calls

- 3.7 Maintaining Language Content

4 Performing Routine Administrative Tasks

- 4.1 Introduction to Performing Routine Administrative Tasks

- 4.2 Running Administration Servers and Managed Servers from Shared and Local Disks

- 4.3 Viewing and Managing Targets Across Domains (Optional)

- 4.4 Starting and Stopping

- 4.4.1 Starting and Stopping Components in the Oracle Fusion Applications Environment

- 4.4.2 Understanding Starting and Stopping with the fastartstop Utility

- 4.4.2.1 fastartstop Syntax

- 4.4.2.2 fastartstop Examples

- 4.4.3 Starting and Stopping the Entire Oracle Fusion Applications Environment

- 4.4.3.1 Starting an Oracle Fusion Applications Environment

- 4.4.3.2 Stopping an Oracle Fusion Applications Environment

- 4.4.4 Starting and Stopping the Administration Servers and Managed Servers

- 4.4.4.1 Starting the Administration Servers and Managed Servers

- 4.4.4.2 Stopping the Administration Servers and Managed Servers

- 4.4.5 Starting and Stopping Oracle HTTP Server

- 4.4.5.1 Starting the Oracle HTTP Server

- 4.4.5.2 Stopping the Oracle HTTP Server

- 4.4.6 Starting and Stopping Oracle Business Intelligence

- 4.4.6.1 Starting Oracle Business Intelligence

- 4.4.6.2 Stopping Oracle Business Intelligence

- 4.4.7 Starting and Stopping a Product Family Oracle WebLogic Server Domain

- 4.4.7.1 Stopping an Oracle WebLogic Server Domain for a Product Family

- 4.4.7.2 Starting an Oracle WebLogic Server Domain for a Product Family

- 4.4.8 Starting and Stopping an Oracle WebLogic Server Cluster in a Product Family for a Configuration Change

- 4.4.8.1 Starting and Stopping an Oracle WebLogic Server Cluster Using fastartstop

- 4.4.8.2 Starting and Stopping an Oracle WebLogic Server Cluster Using Fusion Applications Control

- 4.4.8.3 Starting and Stopping an Oracle WebLogic Server Cluster Using WebLogic Server Administration Console

- 4.4.9 Starting and Stopping Specific Applications

- 4.4.9.1 Starting and Stopping Java EE Applications Using WLST

- 4.4.9.2 Starting and Stopping an Individual Application Instance for a Cluster Using Fusion Applications Control or Cloud Control

- 4.4.9.3 Starting and Stopping All Application Instances for a Cluster Using Fusion Applications Control or Cloud Control

- 4.5 Viewing and Changing Ports for Components

- 4.6 Changing Passwords

- 4.6.1 Changing Oracle Fusion Applications Passwords in the Oracle Database

- 4.6.1.1 Step 1: Start/Stop the Oracle Fusion Applications Environment

- 4.6.1.2 Step 2: Create a template input file using the templateGen utility

- 4.6.1.3 Step 3: Create an input file using the iniGen utility

- 4.6.1.4 Step 4: Use Password Change Utility with DB Target

- 4.6.1.5 Step 5: Use Password Change Utility with VALIDATE_SCHEMAS Target

- 4.6.1.6 Step 5: Use Password Change Utility in STANDARD Mode

- 4.6.1.7 Step 6: Use Password Change Utility with RESET_PROF Target

- 4.6.2 Validating Password Complexity

- 4.6.3 Running PCU from any Directory Outside APPTOP

- 4.6.4 Rendering PCU Offline

- 4.7 Managing the Oracle Database

- 4.7.1 Viewing and Modifying Initialization Parameters

- 4.7.2 Managing Database Storage Structures

- 4.7.3 Managing Memory

- 4.7.4 Administering User Accounts

- 4.8 Patching

- 4.9 Managing Oracle Fusion Applications-Specific Labels in the Oracle Metadata Repository

- 4.10 Modifying Oracle Application Development Framework Connections in Oracle Fusion Applications

- 4.11 Modifying Oracle Data Integrator Configuration

- 4.11.1 Editing the Oracle Data Integrator Topology for Database Endpoint Changes

- 4.11.2 Modifying ODI Agent Host and Port Configuration

- 4.12 Bulk Updating General User Preferences

5 Securing Oracle Fusion Applications

- 5.1 Introduction to Security

- 5.2 Provisioning Identities

- 5.2.1 Identity Provisioning Concepts

- 5.2.1.1 Administrators For Fusion Applications

- 5.2.1.2 Two Types of Users During Provisioning

- 5.2.2 WebLogic Authenticators and the Primary Identity Store

- 5.2.3 Provisioning Steps

- 5.2.4 Best Practices for the Administrator Groups

- 5.2.5 Managing Identities after Deployment

- 5.3 Managing Authorization Policies

- 5.3.1 Setting Loggers

- 5.3.2 Upgrading Fusion Application Policies

- 5.3.2.1 Overview

- 5.3.2.2 Prerequisites to Patching Policies

- 5.3.2.3 Patching Policies

- 5.3.2.4 Analyzing Patch Differences

- 5.3.2.5 Resolving Patch Differences

- 5.3.2.6 Applying a Patch

- 5.4 Masking Data

- 5.4.1 Data Masking in Oracle Fusion Applications

- 5.4.1.1 Requirements for Data Masking

- 5.4.1.2 Sensitive Data in Oracle Fusion Applications

- 5.4.1.3 Masking Definitions

- 5.4.2 Managing the Masking Templates

- 5.4.2.1 Using Self Update to Obtain the Masking Templates

- 5.4.2.2 Importing Masking Templates from the Library

- 5.4.2.3 Exporting Masking Templates from the Library

- 5.4.3 Viewing and Modifying Data Masking Definitions

- 5.4.4 Generating and Submitting the Masking Script

- 5.4.5 Customizing Mask Formats

- 5.4.6 Best Practices when Masking Test Databases

- 5.4.7 Masking References

- 5.5 Securing Web Services

- 5.5.1 Configuring and Managing Local Policies

- 5.5.2 Configuring and Managing Global Policies

- 5.5.3 Web Services Security Profiles

- 5.5.4 Key Exchange with the Domain Hosting Oracle Identity Manager

- 5.6 Hardening Tasks

- 5.6.1 Securing Database Network Traffic

- 5.6.2 Disabling Unused Components to Minimize Risks

- 5.6.3 Configuring External Clients with Externally-Facing Web Services

- 5.6.3.1 Choosing a Mechanism

- 5.6.3.2 Setting Up Policy Assertions and Configuring Mechanisms

- 5.6.4 Hardening Web Services

- 5.6.5 More Secure Keys and Certificates

- 5.7 Security Store Management

- 5.7.1 Extracting Data from an OID Store to a File

- 5.7.2 Reconciling GUIDs

- 5.7.2.1 Prerequisites to Running DSDataMigrator

- 5.7.2.2 DSDataMigrator Syntax

- 5.7.2.3 Examples of Use

- 5.8 Password and Certificate Management

- 5.8.1 Changing the Oracle Fusion Middleware Administrative User Password

- 5.8.1.1 Changing the Oracle Fusion Middleware Administrative User Password Using the Command Line

- 5.8.1.2 Changing the Oracle Fusion Middleware Administrative User Password Using the Administration Console

- 5.8.2 Changing OIM Passwords

- 5.8.2.1 Syntax and Example of Use

- 5.8.3 Updating Certificates with the Certificate Renewal Utility

- 5.8.3.1 About the Certificate Renewal Utility

- 5.8.3.2 Locating the Certificate Renewal Utility

- 5.8.3.3 Before Using the Certificate Renewal Utility

- 5.8.3.4 Using the Certificate Renewal Utility

- 5.8.3.5 After Using the Certificate Renewal Utility

- 5.9 Related Links

6 Managing Oracle Enterprise Scheduler Service and Jobs

- 6.1 Introduction to Managing Oracle Enterprise Scheduler

- 6.2 Viewing the Oracle Enterprise Scheduler Administration Pages

- 6.3 The Scheduling Service Home Page

- 6.3.1 Top 10 Long Running Requests and Top 10 Ready Job Requests Regions

- 6.3.2 Scheduler Components Region

- 6.3.3 Completed Requests Region

- 6.3.4 Response and Load Region

- 6.3.5 Performance Region

- 6.4 Configuring Oracle Enterprise Scheduler

- 6.5 Searching for Configuration Changes to Oracle Enterprise Scheduler in Cloud Control

- 6.6 Viewing General Oracle Enterprise Scheduler Instance Information

- 6.7 Starting and Stopping Oracle Enterprise Scheduler Service Components

- 6.8 Managing Oracle Enterprise Scheduler Requests

- 6.8.1 Submitting an Oracle Enterprise Scheduler Job Request

- 6.8.1.1 Creating a Job Request

- 6.8.1.2 Specifying a Job Request Schedule

- 6.8.2 Searching for Oracle Enterprise Scheduler Job Requests

- 6.8.2.1 Searching for a Job Request Using Simple Search

- 6.8.2.2 Searching for a Job Request Using the Advanced Search Feature

- 6.8.2.3 Configuring the Display of Columns in the Search Results Table

- 6.9 Monitoring Oracle Enterprise Scheduler Service Activity

- 6.9.1 Viewing Top 10 Long Running Oracle Enterprise Scheduler Requests

- 6.9.2 Viewing Top 10 Oracle Enterprise Scheduler Jobs Ready to Be Executed

- 6.10 Managing Purge Policies in Fusion Applications Control

- 6.11 Managing Job Metadata

- 6.11.1 Managing Job Definitions

- 6.11.1.1 Viewing Job Definitions

- 6.11.1.2 Creating Job Definitions

- 6.11.1.3 Duplicating Job Definitions with their Parameters

- 6.11.2 Managing Job Sets

- 6.11.2.1 Viewing Job Sets

- 6.11.2.2 Creating or Editing Job Sets

- 6.11.2.3 Deleting Job Sets

- 6.11.3 Managing Incompatibilities

- 6.11.3.1 Viewing Incompatibilities

- 6.11.3.2 Creating or Editing an Incompatibility

- 6.11.3.3 Deleting an Incompatibility

- 6.12 Managing Work Assignments and Workshifts

- 6.13 Managing Oracle ADF Connections

- 6.14 Managing Application Properties

- 6.15 Managing Application and Role Policies

- 6.16 Managing Oracle Enterprise Scheduler Web Services

- 6.17 Managing Logging for Oracle Enterprise Scheduler

- 6.17.1 Finding Log Information for a Job Request

- 6.17.2 Setting Oracle Enterprise Scheduler Log Levels

- 6.17.3 Saving Job Request Logs

- 6.18 Managing Alerts for Oracle Enterprise Scheduler in Cloud Control

- 6.18.1 Configuring Metric Alerts for Oracle Enterprise Scheduler in Cloud Control

- 6.18.2 Viewing Alerts for Oracle Enterprise Scheduler in Cloud Control

- 6.19 Managing Oracle Enterprise Scheduler Using Oracle WebLogic Scripting Tool Commands

7 Managing Report Delivery Servers

- 7.1 Introduction to Managing Report Delivery Servers

- 7.2 Navigating to the Oracle BI Publisher Administration Page

- 7.3 Configuring Report Delivery Servers

- 7.4 Understanding the Report and Delivery Processors

- 7.5 Managing Report Processing and Delivery Server Load

- 7.6 Scaling Out Report Processors

- 7.7 Diagnosing Report Processing Issues

- 7.7.1 Using the Scheduler Diagnostics Page

- 7.8 Configuring System Properties for Reporting

8 Managing Search with Oracle Enterprise Crawl and Search Framework

- 8.1 Introduction to Oracle Fusion Applications Search

- 8.1.1 Oracle Fusion Applications Search Use Case Example

- 8.1.2 Oracle Fusion Applications Search UI

- 8.1.3 Oracle Enterprise Crawl and Search Framework

- 8.1.3.1 ECSF Management Features

- 8.1.3.2 Key ECSF Features

- 8.1.3.3 ECSF Process Flow

- 8.1.4 Item Business Object and Data Level Security

- 8.2 Validating the Environment for ECSF

- 8.3 Getting Started with Managing ECSF with Fusion Applications Control

- 8.3.1 Navigating to the ECSF Administration Pages

- 8.3.2 Understanding the Enterprise Crawl and Search Framework Configuration Settings Page

- 8.4 Administering Search

- 8.4.1 Making Seeded Searchable Objects Available for Search

- 8.4.2 Managing Index Schedules

- 8.4.2.1 Creating the Index Schedules

- 8.4.2.2 Associating the Searchable Objects with Index Schedules

- 8.4.2.3 Deploying the Index Schedules

- 8.4.2.4 Starting the Index Schedules

- 8.4.2.5 Stopping Index Schedules

- 8.4.2.6 Disassociating Searchable Objects from Index Schedules

- 8.4.2.7 Starting Full Indexing

- 8.4.2.8 Undeploying Index Schedules

- 8.4.2.9 Deleting Index Schedules

- 8.4.3 Changing the Association of Searchable Objects with Search Categories

- 8.4.4 Renaming Search Categories

- 8.4.5 Deleting Search Categories

- 8.4.6 Making External Search Categories Available for Federated Search

- 8.4.7 Deleting External Search Categories

- 8.4.8 Modifying the Display Name of Deployed Searchable Objects

- 8.4.9 Undeploying Searchable Objects

- 8.4.10 Unregistering Searchable Objects from the Oracle Fusion Applications Database

- 8.4.11 Modifying Search Application Service Component Instance Parameters

- 8.5 Performing Advanced Administration Tasks

- 8.5.1 Modifying the Title, Body, Keyword, and Action Title of Searchable Objects

- 8.5.2 Making New Searchable Objects Available for Search

- 8.5.3 Defining Search Engine Instances

- 8.5.3.1 Creating Search Engine Instances

- 8.5.3.2 Configuring Search Engine Instance Parameters

- 8.5.3.3 Modifying Search Engine Instances

- 8.5.3.4 Modifying Search Engine Instance Parameters

- 8.5.3.5 Deleting Search Engine Instances

- 8.5.4 Enabling Search on External Data Sources

- 8.5.5 Adding Product Families for Federated Search

9 Managing Oracle WebLogic Communication Services for Click-to-Dial Functionality

- 9.1 Introduction to Third Party Call Web Service

- 9.2 Modifying Third Party Call Web Service Default Settings Using the System MBean Browser

- 9.3 Call Routing Through a Session Border Controller

- 9.3.1 Setting Up an Outbound Proxy Server

- 9.3.2 Configuring the PreLoadedRouteUri Attribute

Part III Monitoring

10 Monitoring Oracle Fusion Applications

- 10.1 Introduction to Monitoring Oracle Fusion Applications

- 10.2 The Product Family Home Page and Sections in Fusion Applications Control

- 10.2.1 Applications and Infrastructure Section

- 10.2.2 Topology Section

- 10.2.3 Oracle Enterprise Scheduler Sections

- 10.2.4 Recently Completed SOA Instances Section

- 10.3 The Product Home Page and Sections in Fusion Applications Control

- 10.3.1 Key Performance Indicators Section

- 10.3.2 Fusion Applications Section

- 10.3.3 Servers Section

- 10.4 The Fusion Instance Overview Page and Sections in Cloud Control

- 10.4.1 Summary Section

- 10.4.1.1 Monitoring and Diagnostics Region

- 10.4.1.2 Database System Region

- 10.4.2 Member Target Summary Section

- 10.4.3 Status Section

- 10.4.4 Infrastructure Section

- 10.4.5 Compliance Summary Section

- 10.4.6 Patch Recommendations

- 10.5 The Product Family Home Page and Sections in Cloud Control

- 10.6 The Product Home Page and Sections in Cloud Control

- 10.7 Monitoring Product Families and Products

- 10.8 Monitoring the Detailed Status of Oracle Fusion Applications

- 10.9 Monitoring Business Performance Metrics for a Product Family

- 10.10 Monitoring Business Performance Metrics for a Product

- 10.11 Viewing the Routing Topology of an Oracle Fusion Applications Instance, Product Family, or Product

- 10.12 Viewing the Configuration Topology of an Oracle Fusion Applications Instance, Product Family, or Product

11 Monitoring the Oracle Fusion Applications Middle Tier

- 11.1 Introduction to Monitoring the Middle Tier

- 11.2 Monitoring and Viewing Performance Status of Oracle Fusion Middleware

- 11.2.1 Viewing the General Status of Oracle Fusion Middleware Components for a Product Family

- 11.2.2 Viewing the Detailed Status of Oracle Fusion Middleware Components for a Product Family

- 11.2.3 Viewing the Routing Topology of Oracle Fusion Middleware

- 11.2.3.1 Viewing the Routing Topology of Oracle Fusion Middleware Using Fusion Applications Control

- 11.2.3.2 Viewing the Routing Topology of Oracle Fusion Middleware Using Cloud Control

- 11.2.4 Viewing the Performance of an Oracle WebLogic Server

- 11.2.4.1 Monitoring an Oracle WebLogic Server Domain

- 11.2.4.2 Monitoring an Oracle WebLogic Server Administration or Managed Server

- 11.2.4.3 Monitoring a Cluster

- 11.2.5 Monitoring the System Performance of Oracle Fusion Applications Deployed to a Cluster

- 11.2.5.1 Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Fusion Applications Control

- 11.2.5.2 Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Cloud Control

- 11.2.5.3 Monitoring the Performance of Oracle Fusion Application Instances Using Fusion Applications Control

- 11.2.5.4 Monitoring the Performance of Oracle Fusion Application Instances Using Cloud Control

- 11.3 Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product

- 11.3.1 Monitoring System Performance Metrics for a Product Family or a Product with Fusion Applications Control

- 11.3.2 Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product with Cloud Control

- 11.4 Monitoring Performance for Key Oracle Fusion Middleware Components with Fusion Applications Control

- 11.4.1 Monitoring Oracle Enterprise Crawl and Search Framework

- 11.4.2 Monitoring the Performance of a Single Oracle Enterprise Scheduler Instance

- 11.4.2.1 Viewing a Summary of Oracle Enterprise Scheduler Activity

- 11.4.2.2 Viewing Current Oracle Enterprise Scheduler Activity

- 11.4.2.3 Creating or Editing a Work Assignment

- 11.4.2.4 Viewing Historical Oracle Enterprise Scheduler Reports

- 11.4.2.5 Viewing Oracle Enterprise Scheduler Metrics

- 11.4.2.6 Managing Chart Sets

- 11.4.2.7 Selecting the Performance Time Period

- 11.4.3 Monitoring Oracle Identity Manager Performance Metrics

- 11.4.4 Locating Key Performance Metrics for Specific Components

- 11.4.4.1 Monitoring Key Performance Metrics for Oracle WebLogic Server

- 11.4.4.2 Monitoring Key Performance Metrics for Oracle SOA Suite

- 11.4.4.3 Monitoring Key Performance Metrics for Oracle Enterprise Scheduler

- 11.5 Performing Proactive Performance Monitoring with Cloud Control

- 11.5.1 Monitoring Middle Tier Targets

- 11.5.2 Creating Monitoring Templates

- 11.5.3 Creating Blackouts

- 11.5.4 Setting Up Notifications

- 11.6 Tuning Middle Tiers for Oracle Fusion Applications

12 Monitoring and Tuning Oracle Database for Oracle Fusion Applications

- 12.1 Monitoring Oracle Database

- 12.1.1 Database Statistics

- 12.1.2 Monitoring Database Alerts

- 12.1.2.1 Configuring Database Alerts

- 12.1.2.2 Responding to Database Alerts

- 12.1.3 Monitoring User and Session Activity

- 12.1.4 Monitoring the Database Instance

- 12.1.5 Monitoring the Host System

- 12.2 Tuning Oracle Database

- 12.2.1 Creating a Baseline of the Database

- 12.2.2 Diagnosing and Tuning Database Performance Problems Using ADDM

- 12.2.3 Diagnosing and Tuning Database Performance Problems Reactively

- 12.2.3.1 Comparing Database Performance Over Time Using AWR Reports

- 12.2.3.2 Identifying Transient Performance Problems Using ASH Reports

- 12.2.3.3 Identifying Wait Time Using Wait Events

- 12.2.4 Tuning SQL Statements

- 12.2.4.1 Collecting Optimizer Statistics

- 12.2.4.2 SQL Tuning Sets

- 12.2.4.3 SQL Profiles

- 12.2.4.4 Using SQL Tuning Advisor

- 12.2.4.5 Using SQL Access Advisor

- 12.2.4.6 Using SQL Tracing

- 12.3 Testing Oracle Database Changes

- 12.3.1 Testing SQL Changes

- 12.3.2 Testing Database Changes

13 Managing Oracle Fusion Applications Log Files

- 13.1 Overview of Oracle Fusion Applications Incidents, Logging, and QuickTrace

- 13.2 Understanding Oracle Fusion Applications Log Files and Log Messages

- 13.2.1 Standard Log File Administration Tasks and Tools

- 13.2.2 Log Files and Settings

- 13.2.3 Log Message Structure

- 13.2.3.1 Log Message Attributes Supplied by the Oracle Fusion Middleware and Oracle Database Layers

- 13.2.3.2 Log Message Attributes Supplied by Logging APIs for Oracle Fusion Applications

- 13.2.3.3 Log Message Attributes Supplied by the Application Session

- 13.2.3.4 Log Message Attributes Supplied by Oracle Enterprise Scheduler Job Requests

- 13.2.3.5 Log Message Attributes Supplied by SOA

- 13.3 Viewing and Searching Log Files During Normal Operation

- 13.3.1 Viewing Logs from Fusion Applications Control

- 13.3.2 Searching for Specific Information in Log Files within a Single Domain

- 13.3.3 Searching for Specific Information in Log Files Across Multiple Domains

- 13.3.4 Saving Log Search Criteria for Reuse

- 13.3.5 Reusing Saved Log Search Criteria

- 13.3.6 Typical Log File Locations

- 13.3.7 Location of Logged Information When Using Multiple Managed Servers

- 13.4 Configuring Settings for Log Files During Normal Operation

- 13.4.1 Default System Log Settings

- 13.4.2 When Changes to Log File Configuration Settings Take Effect

- 13.4.3 Standard Logging Levels

- 13.4.4 Managing Log File Size and Disk Space Usage

- 13.4.4.1 Managing Rotating Log File Space Usage for Java and SOA Applications

- 13.4.4.2 Managing Rotating Log File Space Usage for PL/SQL Applications

- 13.4.4.3 Managing Log File Space Usage for C Applications

- 13.4.5 Using Profile Options to Configure Standard Log Settings

- 13.4.6 Using Additional Settings to Configure Logs for Selected Components

- 13.4.6.1 Configuring Additional Log Settings for Oracle Fusion Global Payroll

- 13.4.6.2 Configuring Additional Log Settings for Oracle Fusion Incentive Compensation Batch Jobs

- 13.4.6.3 Configuring Additional Log Settings for Oracle Fusion General Ledger

- 13.4.6.4 Configuring Additional Log Settings for Oracle Fusion Receivables AutoInvoice

- 13.4.7 Configuring Access to Logs for Fusion Applications Control

14 Managing Oracle Fusion Applications Diagnostic Tests

- 14.1 Understanding Oracle Fusion Applications Diagnostic Tests and the Diagnostic Framework

- 14.1.1 Relationships Between Diagnostic Tests, Incidents, and Log Messages

- 14.1.2 Standard Diagnostic Testing Administration Tasks and Tools

- 14.2 Configuring the Diagnostic Testing Framework for Normal Operation

- 14.2.1 Controlling Access to Diagnostic Testing Functionality

- 14.2.2 Navigating to the Diagnostic Dashboard Application

- 14.2.2.1 Navigating to the Diagnostic Dashboard Application from an Oracle Fusion Application

- 14.2.2.2 Navigating to the Diagnostic Dashboard Application from Cloud Control

- 14.2.3 Configuring Required Variables for the diagctl Command Line Interface

- 14.3 Using Diagnostic Tests to Monitor Normal System Health

- 14.3.1 Running Diagnostic Tests

- 14.3.1.1 Using Diagnostic Dashboard to Run Diagnostic Tests

- 14.3.1.2 Using the diagctl Command-Line Interface to Run Diagnostic Tests

- 14.3.2 Searching for Diagnostic Tests by Name, Categorization Tag, or Module

- 14.3.3 Ensuring that Diagnostic Tests Are Available

- 14.3.4 Providing Input Parameters for Diagnostic Tests

- 14.3.5 Running Diagnostic Tests Immediately

- 14.3.6 Scheduling Diagnostic Tests to Run Later

- 14.3.7 Checking the Status of a Diagnostic Test

- 14.3.7.1 Using the Diagnostic Dashboard Application to Check the Status of a Diagnostic Test

- 14.3.7.2 Using the diagctl Command-Line Interface to Check the Status of a Diagnostic Test

- 14.3.8 Canceling Diagnostic Test Runs

- 14.3.9 Viewing the Results of Diagnostic Tests

- 14.3.9.1 Using the Diagnostic Dashboard Application to View the Results of Diagnostic Tests

- 14.3.9.2 Using the diagctl Command-Line Interface to View the Results of Diagnostic Tests

- 14.3.10 Identifying Diagnostic Test Start Methods from Test Run Names

- 14.3.11 Purging the Results of Selected Diagnostic Test Runs

Part IV Advanced Administration

15 Backing Up and Recovering Oracle Fusion Applications

- 15.1 Introduction to Backup and Recovery

- 15.2 Back Up and Recovery Tools

- 15.3 Overview of Backing Up Your Environment

- 15.3.1 Modes of Backup

- 15.3.2 Types of Backups

- 15.3.3 Recommended Backup Strategy

- 15.3.4 Backing Up Windows Registry Entries

- 15.4 Overview of Recovering Your Environment

- 15.4.1 Types of Recovery

- 15.4.2 Recommended Recovery Strategies

- 15.5 Prerequisites for Using Cloud Control to Back Up or Restore Your Environment

- 15.6 Backup and Recovery Recommendations for Oracle Fusion Applications

- 15.6.1 Backup and Recovery Recommendations for Oracle Fusion Customer Relationship Management

- 15.6.2 Backup and Recovery Recommendations for Oracle Fusion Financials

- 15.6.3 Backup and Recovery Recommendations for Oracle Fusion Human Capital Management

- 15.6.4 Backup and Recovery Recommendations for Oracle Fusion Supply Chain Management

- 15.6.5 Backup and Recovery Recommendations for Oracle Fusion Project

- 15.6.6 Backup and Recovery Recommendations for Oracle Fusion Procurement

- 15.6.7 Backup and Recovery Recommendations for Oracle Fusion Incentive Compensation

- 15.6.8 Backup and Recovery Recommendations for Oracle Fusion Applications Technology

- 15.6.9 Backup and Recovery Recommendations for Oracle Fusion Setup

- 15.6.10 Backup and Recovery Recommendations for Oracle WebCenter Content

- 15.6.11 Backup and Recovery Recommendations for Oracle Enterprise Scheduler

- 15.6.12 Backup and Recovery Recommendations for Oracle Enterprise Crawl and Search Framework

- 15.6.13 Backup and Recovery Recommendations for Oracle Authorization Policy Manager

- 15.6.14 Backup and Recovery Recommendations for Java Servers for Oracle E-Mail and Web Marketing

- 15.7 Performing a Backup

- 15.7.1 Performing a Backup Using Cloud Control

- 15.7.1.1 Configuring Cloud Control Backups

- 15.7.1.2 Backing Up Oracle Fusion Applications Using Cloud Control

- 15.7.2 Performing a Full Offline Backup Using the Command Line

- 15.7.3 Performing an Online Backup of Configuration Files Using the Command Line

- 15.8 Creating a Record of Your Oracle Fusion Applications Configuration

- 15.9 Recovering Using Cloud Control

- 15.10 Recovering After Data Loss, Corruption, or Media Failure

- 15.10.1 Recovering the Applications Base Directory

- 15.10.2 Recovering a Middleware Home

- 15.10.3 Recovering an Oracle WebLogic Server Domain

- 15.10.4 Recovering an Oracle Home

- 15.10.5 Recovering an Oracle Instance Home

- 15.10.5.1 Recovering After Oracle Instance Home Deleted from File System

- 15.10.5.2 Recovering After Oracle Instance Home Deregistered

- 15.10.6 Recovering the Administration Server Configuration

- 15.10.7 Recovering a Managed Server

- 15.10.8 Recovering the Databases

- 15.10.9 Reconciling the Data

- 15.10.9.1 Recovering the Oracle Identity Manager Database and Reconciling It with the LDAP Database

- 15.10.9.2 Recovering the Oracle Fusion Applications Database and Reconciling It with the LDAP Database

- 15.10.9.3 Recovering the LDAP Database Using Multimaster Replication

- 15.10.10 Recovering Oracle Fusion Applications

- 15.10.10.1 Recovering Oracle Fusion Customer Relationship Management

- 15.10.10.2 Recovering Oracle Fusion Procurement

- 15.10.11 Recovering Components Related to Oracle Fusion Applications

- 15.10.11.1 Recovering Oracle HTTP Server

- 15.10.11.2 Recovering Oracle WebCenter Content

- 15.10.11.3 Recovering Oracle Enterprise Scheduler

- 15.10.11.4 Recovering Oracle Enterprise Crawl and Search Framework

- 15.10.11.5 Recovering Oracle Authorization Policy Manager

- 15.10.11.6 Recovering Oracle E-Mail and Web Marketing

- 15.10.11.7 Recovering Oracle BI Enterprise Edition

- 15.10.11.8 Recovering Oracle Business Intelligence Publisher

- 15.10.11.9 Recovering Oracle Real-Time Decisions

- 15.10.11.10 Recovering Oracle Essbase

- 15.10.11.11 Recovering Oracle Hyperion Calculation Manager

- 15.10.11.12 Recovering Oracle Hyperion Financial Reporting

- 15.10.11.13 Recovering Oracle Hyperion Smart View

- 15.11 Recovering After Loss of Host

- 15.11.1 Recovering the Applications Base Directory After Loss of Host

- 15.11.2 Recovering After Loss of Administration Server Host

- 15.11.2.1 Recovering the Administration Server to the Same Host

- 15.11.2.2 Recovering the Administration Server to a Different Host

- 15.11.3 Recovering After Loss of Managed Server Host

- 15.11.3.1 Recovering a Managed Server to the Same Host

- 15.11.3.2 Recovering a Managed Server to a Different Host

- 15.11.4 Recovering the Databases After Loss of Host

- 15.11.5 Additional Actions for Recovering Entities After Loss of Host

- 15.11.5.1 Changing the Host Name in the targets.xml File for Fusion Middleware Control

- 15.11.5.2 Modifying the FusionVirtualHost_x.conf File

- 15.11.5.3 Creating a New Machine for the New Host Name

- 15.11.5.4 Updating Oracle Inventory

- 15.11.6 Recovering Oracle Fusion Applications After Loss of Host

- 15.11.6.1 Recovering Oracle Fusion Supply Chain Management After Loss of Host

- 15.11.6.2 Recovering Oracle Fusion Procurement After Loss of Host

- 15.11.7 Recovering Components Related to Oracle Fusion Applications

- 15.11.7.1 Recovering Oracle HTTP Server After Loss of Host

- 15.11.7.2 Recovering Oracle WebCenter Content to a Different Host

- 15.11.7.3 Recovering Oracle Enterprise Scheduler After Loss of Host

- 15.11.7.4 Recovering Oracle Enterprise Crawl and Search Framework After Loss of Host

- 15.11.7.5 Recovering Oracle Authorization Policy Manager After Loss of Host

- 15.11.7.6 Recovering Oracle E-Mail and Web Marketing After Loss of Host

- 15.11.7.7 Recovering Oracle Essbase In Clustered Environment After Loss of Host

- 15.11.7.8 Recovering Oracle BI Enterprise Edition to a Different Host

- 15.11.7.9 Recovering Oracle Business Intelligence Publisher to a Different Host

- 15.11.7.10 Recovering Oracle Real-Time Decisions to a Different Host

- 15.11.7.11 Recovering Oracle Hyperion Calculation Manager After Loss of Host

- 15.11.7.12 Recovering Oracle Hyperion Financial Reporting After Loss of Host

- 15.11.7.13 Recovering Oracle Hyperion Smart View

- 15.12 A Case Study: Recovering Oracle Fusion Customer Relationship Management

- 15.12.1 The Recovery Case Study Scenario

- 15.12.2 Recovering the Middleware Home Containing Java EE Components

- 15.12.3 Recovering the Web Tier Middleware Home

- 15.12.4 Recovering the Oracle Fusion Customer Relationship Management Domain

- 15.12.5 Recovering Servers When the Installation Directory Is Shared Between Hosts

- 15.12.6 Recovering Servers When the Managed Server Configuration Is Local

- 15.12.7 Recovering an Oracle Instance in an Oracle Fusion Customer Relationship Management Installation

- 15.12.8 Recovering an Oracle Fusion Customer Relationship Management Cluster

- 15.12.9 Recovering Databases for Oracle Fusion Customer Relationship Management

16 Configuring High Availability and Scaling Out Oracle Fusion Applications

- 16.1 Introduction to Oracle Fusion Applications High Availability Architecture

- 16.2 Oracle WebLogic Cluster Configuration for Oracle Fusion Applications

- 16.3 Oracle Fusion Applications High Availability

- 16.3.1 Oracle Fusion Applications Single Instance Architecture

- 16.3.1.1 Oracle Fusion Applications External Dependencies

- 16.3.1.2 Oracle Fusion Applications Run-Time Processes

- 16.3.1.3 Oracle Fusion Applications Request Flow

- 16.3.1.4 Oracle Fusion Applications Configuration Artifacts

- 16.3.1.5 Oracle Fusion Applications Deployment Artifacts

- 16.3.1.6 Oracle Fusion Applications Log File Location

- 16.3.2 Oracle Fusion Applications High Availability Architecture and Failover Considerations

- 16.3.2.1 Starting and Stopping the Oracle Fusion Applications Cluster

- 16.3.2.2 Oracle Fusion Applications Cluster-Wide Configuration Changes

- 16.3.2.3 Oracle Fusion Applications Failures and Expected Behaviors

- 16.4 Oracle RAC Database Configuration for Oracle Fusion Applications Repositories

- 16.4.1 Oracle Real Application Clusters

- 16.4.2 Providing High Availability for Oracle Fusion Applications Repositories

- 16.4.2.1 Preparing the System to Use Oracle RAC

- 16.4.2.2 Providing High Availability Through Multi Data Sources

- 16.4.2.3 Failover Processing and Recovery for Oracle RAC Node or Instance Failures

- 16.4.2.4 Load Balancing Across Oracle RAC Nodes

- 16.4.2.5 Retry Logic to Protect Read-Only Operations

- 16.4.3 Best Practices for Deploying JDBC Multi Data Sources on Servers and Clusters

- 16.5 Scaling Out Oracle Fusion Applications

- 16.5.1 Scaling Up the Topology (Adding Managed Servers to Existing Machines)

- 16.5.1.1 Testing the Routing from Oracle HTTP Server to the New Managed Server

- 16.5.2 Scaling Out the Topology (Adding Managed Servers to New Machines)

- 16.5.3 Scaling Out Oracle RAC Databases

- 16.5.3.1 Cloning Oracle RAC Nodes to Scale Out Oracle Fusion Applications

- 16.5.3.2 Configuring the Multi Data Source to Include New Oracle RAC Nodes

Part V Appendixes

A High Availability for Oracle Fusion Middleware Extensions for Applications

- A.1 How Oracle Fusion Middleware Extensions Components Use Fusion Middleware Components for High Availability and Failover

- A.1.1 Oracle Metadata Repository

- A.1.2 Oracle Application Development Framework

- A.1.3 WebLogic Server Failover for Session Content

B High Availability for Oracle Enterprise Scheduler

- B.1 Introduction to High Availability for Oracle Enterprise Scheduler

- B.2 Oracle Enterprise Scheduler Concepts

- B.3 Configuring High Availability for Oracle Enterprise Scheduler

- B.3.1 Oracle Enterprise Scheduler Configuration and Deployment Artifacts

- B.3.2 Oracle Enterprise Scheduler Logging

- B.3.3 Backup and Recovery

- B.4 Managing an Oracle Enterprise Scheduler Cluster

C Seeded Searchable Objects, Search Categories, Index Schedules, and Facets

- C.1 Searchable Objects by Product Family

- C.2 Search Categories by Product Family

- C.3 Index Schedules by Product Family

- C.4 Facets by Product Family

Glossary

Preface

This guide describes how to administer the Oracle Fusion Applications environment, including how to start and stop components, change ports and passwords, manage the Oracle Database, monitor the environment, logging, back up and recover, configure high availability, move components across environments, and troubleshoot runtime issues.

Audience

This document is intended for administrators of the Oracle Fusion Applications environment. The Oracle Fusion Applications administrator performs tasks to manage the Oracle Fusion Applications environment. These tasks are performed to the Oracle Fusion applications, Oracle Fusion Middleware components, and the Oracle Database.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program web site 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 in the Oracle Fusion Applications technology library:

- Oracle Fusion Applications Administrator's Troubleshooting Guide

- Oracle Fusion Applications Installation Guide

- Oracle Fusion Applications Master Glossary

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.

UNIX is used as a generic reference to all UNIX-based platforms. Where information for a particular UNIX platform is different, this is noted in the text.

What's New in This Guide

The following topics introduce the new and changed features of Oracle Fusion Applications and other significant changes that are described in this guide, and provides pointers to additional information.

New and Changed Features for 11g Release 8 (11.1.8)

Oracle Fusion Applications 11g Release 8 (11.1.8) includes the following new and changed administrative features for this document:

- Modified steps for using the Password Change Utility. See Section 4.6.1.

- Validating Password Complexity. See Section 4.6.2.

- Running PCU from any directory and Rendering PCU Offline. See Section 4.6.3 and Section 4.6.4.

- New BUSINESS FLOW TROUBLESHOOTING job role, which lets administrators grant Oracle Fusion Applications users temporary access to the commands in the Troubleshooting Options dialog. See Section 13.4.

- The security topics include new or revised procedures in the following areas:

- Password and certificate management

- Security store management

- Authorization policy management

- Hardening tasks

- Masking data

For details, see .

Other Significant Changes in this Document for 11g Release 8 (11.1.8)

For 11g Release 8 (11.1.8), this guide has been updated in several ways. Following are the sections that have been added or changed.

- Moved information about installing languages using Language Pack Installer from the Oracle Fusion Applications Upgrade Guide to this guide. See .

- Removed the chapter concerning test-to-production content movement.

- Updated references to changed menus. For example, some menu commands that previous releases listed in the Help menu are now listed in the Settings and Actions menu.

- Updated procedures involving the Manage Administrator Profile Values task, which is now found by direct query on the All Tasks tab in the Setup and Maintenance work area.

- Added information about locating the APPL_LOG directory, which is the default location for standard log files for Oracle Fusion Applications code modules that are implemented in PL/SQL. See Section 13.3.6.

- Updated introductory material to align with entirely reorganized and rewritten Oracle Fusion Applications Installation Guide. The enterprise installations described in various Fusion Applications Enterprise Deployment Guides have been replaced by instructions in the Oracle Fusion Applications Installation Guide.

- Reorganized to add hardening topics and to remove the SSL and audit topics.

Part I

Understanding Oracle Fusion Applications

This part provides an overview to Oracle Fusion Applications and its concepts as they relate to administering Oracle Fusion Applications.

Part I contains the following chapters:

- Chapter 1, "Introduction to Oracle Fusion Applications for Systems Administrators"

1 Introduction to Oracle Fusion Applications for Systems Administrators

Oracle Fusion Applications is Oracle's next-generation applications suite built on a service-oriented platform. It brings together enterprise technologies, applications, and services-- including Oracle Fusion Applications and Oracle Fusion Middleware-- to provide an integrated applications marketplace. This chapter provides an overview of the architecture, components, and concepts of Oracle Fusion Applications for the use of administrators.

This chapter contains the following topics:

- Section 1.1, "Architecture of Oracle Fusion Applications"

- Section 1.2, "Key Oracle Fusion Applications Concepts"

- Section 1.3, "Security Features in Oracle Fusion Applications"

- Section 1.4, "Roadmap for Administering Oracle Fusion Applications"

1.1 Architecture of Oracle Fusion Applications

Oracle Fusion Applications are built on the Oracle Fusion Middleware stack and use the Oracle Database. This architecture is depicted in Figure 1-1.

Figure 1-1 Oracle Fusion Applications Architecture

The section contains the following topics

- Section 1.1.1, "Oracle Fusion Applications Product Families"

- Section 1.1.2, "Oracle Fusion Middleware Infrastructure Components"

- Section 1.1.3, "Oracle Fusion Middleware Components"

- Section 1.1.4, "Oracle Database"

- Section 1.1.5, "Oracle Enterprise Manager Fusion Applications Control"

- Section 1.1.6, "Oracle Enterprise Manager Cloud Control"

- Section 1.1.7, "Oracle Enterprise Manager Database Control"

1.1.1 Oracle Fusion Applications Product Families

An installation of Oracle Fusion Applications is logically broken up into groups of features known as product families, which represent the highest-level collection of functionality that you can license and implement. A provisioning configuration is a collection of one or more product offerings.

Product families have interdependencies on companion applications (for example Oracle Fusion Human Capital Management relies on Oracle Financials payroll), as well as middleware dependencies (for example, Oracle SOA Suite) required for runtime execution.

An application can contain multiple products, and a product can also span multiple applications. A product typically has a one-to-one correspondence with an EAR file. Figure 1-2 shows two applications, PayablesApp and ReceivablesApp, each of which is mapped to the same product, Payments.

Figure 1-2 Relationship of Products and Applications

Oracle Fusion Applications includes the following product families:

- Oracle Fusion Customer Relationship Management (Sales and Marketing): Manages customers, contacts, and resources, including data quality configuration.

- Oracle Fusion Financials (Financials, Oracle Fusion Procurement, and Oracle Fusion Projects): Manages financial flows, including assets, ledgers, cash cycle, invoices and payments, accounts receivable, collections, and setup of subledger accounting and tax configuration.

- Oracle Fusion Governance, Risk, and Compliance: Provides business controls to manage risk, multi-regulatory compliance, and enforcement. Can also be used to analyze suspect transactions and configuration settings based on user-defined conditions or apply preventive controls that will limit what a user can see and do within an Oracle Fusion Applications user interface.

- Oracle Fusion Human Capital Management: (Workforce Deployment, Workforce Development, and Compensation Management): Provides employee management for an organization.

- Oracle Fusion Supply Chain Management: (Product Management, Order Orchestration, Material Management and Logistics): Integrates and automates all key supply chain processes, from design, planning and procurement to manufacturing and fulfillment.

You can also choose several standalone product offerings. For this group of offerings, only the direct dependencies are installed, configured, and deployed:

- Customer Data Hub

- Enterprise Contracts

- Oracle Fusion Accounting Hub

- Oracle Fusion Incentive Compensation

To aid with performing current-state analysis of the applications, you can use Oracle Transactional Business Intelligence, which is built on Oracle BI Enterprise Edition. For more information about configuring Oracle Transactional Business Intelligence, see the Oracle Fusion Administrator's Guide for Transactional Business Intelligence.

1.1.2 Oracle Fusion Middleware Infrastructure Components

The product offerings use the following common core framework and infrastructure for Oracle Fusion Applications described in Table 1-1.

Table 1-1 Oracle Fusion Middleware Infrastructure Components

Oracle Fusion Middleware Infrastructure Components

Description

Oracle Fusion Middleware Extensions for Applications (Applications Core)

Provides design time and runtime infrastructure to help standardize complex development patterns for Oracle Fusion Applications. It simplifies the development process of these patterns and provides a consistent user experience. Examples of these patterns include extensibility (Flexfields), hierarchical relationships (Trees), data security, and UI patterns. Applications Core creates simplified methods of implementing these complex requirements by providing robust metadata and comprehensive UI components and services. All of the Applications Core components have been intricately integrated with the rest of the Oracle Fusion Middleware infrastructure so they are available across every layer of the Oracle Fusion Applications platform.

Applications Core provides shared libraries referenced by all the Oracle Fusion Applications, a standalone application for application setup and configuration, an Oracle JDeveloper extension to seamlessly integrate our components with the rest of the Oracle Fusion Applications technology stack, PLSQL APIs, C libraries, and common seed data.

Oracle Enterprise Scheduler

Enables you to manage and schedule jobs for Oracle Fusion Applications.

See Chapter 6, "Managing Oracle Enterprise Scheduler Service and Jobs."

Oracle Enterprise Crawl and Search Framework (ECSF)

Oracle Enterprise Crawl and Search Framework (ECSF) enables Oracle Fusion Applications Search for performing full-text searches securely and simultaneously against multiple logical business objects. Any application that connects to multiple data sources or manages a significant amount of unstructured (non-database) information—or both—needs advanced search capabilities so that application users can easily locate and take action on data that is relevant to them.

See Chapter 8, "Managing Search with Oracle Enterprise Crawl and Search Framework."

1.1.3 Oracle Fusion Middleware Components

Oracle Fusion Middleware includes the following components described in Table 1-2.

Table 1-2 Oracle Fusion Middleware Components

Oracle Fusion Middleware Components

Description

Oracle Application Development Framework (Oracle ADF)

Provides an end-to-end application framework that builds on Java Platform, Enterprise Edition (Java EE) standards and open-source technologies to simplify and accelerate implementing service-oriented applications.

Developers should eve the Oracle Fusion Middleware Administrator's Guide for Oracle Application Development Framework.

Oracle Business Intelligence

Oracle Business Intelligence provides a complete, integrated solution of analytics and reporting for Oracle Fusion Applications.

Oracle Fusion Applications leverages Oracle Business Intelligence components to provide a complete, integrated reporting and analytics solution:

- Oracle Business Intelligence Enterprise Edition provides the underlying reporting and analytics platform.

- Oracle Business Intelligence Publisher provides highly-formatted reports suitable for a wide variety of purposes.

- Oracle Fusion Transactional Business Intelligence (OTBI) provides current-state (ad-hoc) analysis of transactional data for daily use.

- Oracle Business Intelligence Applications, an optionally licensed, on-premise offering, provides analyses of historical data stored in the Oracle Business Analytics Warehouse. (For more information about installing Oracle BI Applications 11g Release 11.1.1.8.0, see the Oracle BI Applications documentation library on the Oracle Technology Network at http://docs.oracle.com/cd/E49139_01/index.htm.)

Oracle Data Integrator

Oracle Data Integrator provides a comprehensive data integration platform that covers bulk data movement requirements for Oracle Fusion Applications.

Developers may want to consult the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.

Oracle HTTP Server

Provides a web listener for applications and the framework for hosting static and dynamic pages and applications over the web. Based on the proven technology of the Apache HTTP Server, Oracle HTTP Server includes significant enhancements that facilitate load balancing, administration, and configuration.

See the Oracle Fusion Middleware Administrator's Guide for Oracle HTTP Server.

Oracle Identity and Access Management

Provides a shared infrastructure for all applications, enabling developers to incorporate identity management into applications.

For more information about Oracle Identity Management components in Oracle Fusion Applications, see the following guides:

- Oracle Authorization Policy Manager: Section 5.3, "Managing Authorization Policies"

- Oracle Identity Manager: Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager

- Oracle Access Manager: Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager with Oracle Security Token Service

Oracle SOA Suite

Provides a complete set of service infrastructure components for designing, deploying, and managing composite applications. Oracle SOA Suite enables services to be created, managed, and orchestrated into composite applications and business processes. Composites enable you to easily assemble multiple technology components into one SOA composite application.

An important component of Oracle SOA Suite is Oracle WSM Policy Manager. Oracle WSM Policy Manager provides the infrastructure for enforcing global security and auditing policies. By securing various endpoints and setting and propagating identity, it secures applications. Oracle WSM Policy Manager provides a standard mechanism for signing messages, performing encryption, performing authentication, and providing role-based access control. You also can change a policy without having to change the endpoints or clients for this endpoints, providing greater flexibility and security monitoring for your enterprise.

The Oracle Business Process Management (Oracle BPM) Suite provides an integrated environment for developing, administering, and using business applications centered around business processes. The Oracle BPM Suite is layered on the Oracle SOA Suite and shares many of the same product components.

See the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.

Oracle Secure Enterprise Search (Oracle SES)

Provides a search engine for Oracle Fusion Applications Search. See Chapter 8, "Managing Search with Oracle Enterprise Crawl and Search Framework."

For more information on Oracle SES, see the following guides:

- Oracle Secure Enterprise Search Administrator's Guide

- Oracle Secure Enterprise Search Administration API Guide

- Oracle Secure Enterprise Search Java API Reference

Oracle WebCenter Content

Provides a comprehensive suite of digital content management tools. These tools can be used across the enterprise to cohesively track, manage, and dispose of content whether written, in digital images, or as email.

For more information, see Oracle Fusion Middleware Administering Oracle WebCenter Content.

Oracle WebCenter Portal

Enables you to create social applications, enterprise portals, collaborative communities, and composite applications, built on a standards-based, service-oriented architecture. Oracle WebCenter Portal combines dynamic user interface technologies with which to develop rich internet applications, the flexibility and power of an integrated, multichannel portal framework, and a set of horizontal Enterprise 2.0 capabilities delivered as services that provide content, collaboration, presence, and social networking capabilities. Based on these components, Oracle WebCenter Portal also provides an out-of-the-box, enterprise-ready customizable application, WebCenter Spaces, with a configurable work environment that enables individuals and groups to work and collaborate more effectively.

See the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter Portal.

Oracle WebLogic Communication Services

Provides click-to-dial functionality for applications primarily through contextual actions. Contextual actions provide related information and actions to users within the immediate context of the object instances upon which they act.

For more information for enabling these services, see Chapter 9, "Managing Oracle WebLogic Communication Services for Click-to-Dial Functionality."

Oracle WebLogic Server

Supports the deployment of mission-critical applications in a robust, secure, highly available, and scalable environment. Oracle WebLogic Server is an ideal foundation for building applications based on service-oriented architecture (SOA).

See the Oracle Fusion Middleware Introduction to Oracle WebLogic Server.

1.1.4 Oracle Database

All Oracle Fusion Applications environments require the following Oracle Database instances:

- Oracle Database instances for Oracle Identity Management: One instance is required for the Policy Store, and another instance is required for the Identity Store.

- The transaction database for Oracle Fusion Applications: The transaction database is used to store and retrieve all transactional and reference data and to store design-time data in repositories. After installation and configuration, the transactional database contains applications and middleware schemas, seed data, the tablespaces, and all other required packages.

Before provisioning a new environment, you use the Oracle Fusion Applications Repository Creation Utility to create Oracle Fusion Applications-specific schemas and tablespaces in the transaction database. The steps to do this, and the schemas, are detailed in the Oracle Fusion Applications Installation Guide.

If you are implementing Oracle Business Intelligence Applications for historical reporting, you must install additional database instances for the:

- Oracle Business Analytics Warehouse schema

- Business Intelligence Applications Components Repository

- ODI Repository for Business Intelligence Applications

These are detailed in Oracle Business Intelligence Applications Installation Guide.

1.1.5 Oracle Enterprise Manager Fusion Applications Control

Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) enables you to manage a single product family in an Oracle WebLogic Server domain for the Oracle Fusion Applications environment, including the products, applications, and Oracle Fusion Middleware components. As a part of management, you can monitor the runtime performance metrics for the various Oracle Fusion Applications and Oracle Fusion Middleware components. See Section 2.5 for more information about Fusion Applications Control and Section 2.2 for a comparison with Cloud Control.

1.1.6 Oracle Enterprise Manager Cloud Control

Oracle Enterprise Manager Cloud Control (Cloud Control) enables you to monitor and manage the complete IT infrastructure for Oracle Fusion Applications from a single console. You can monitor all the product families, Oracle Fusion Middleware components, and the Oracle Database. For example, you can monitor all the Oracle WebLogic Server domains for all the product families from one console. See Section 2.8 for more information about Fusion Applications Control and Section 2.2 for a comparison with Fusion Applications Control.

1.1.7 Oracle Enterprise Manager Database Control

Oracle Enterprise Manager Database Control (Database Control) enables you to manage the Oracle Database.

Using Database Control, you can perform administrative tasks such as creating schema objects (tables, views, indexes, and so on), managing user security, managing database memory and storage, backing up and recovering your database, and importing and exporting data. You can also view performance and status information about your database.

For more information, see the "Introduction to Oracle Enterprise Manager Database Control" section in the Oracle Database 2 Day DBA.

1.2 Key Oracle Fusion Applications Concepts

This section reviews the basics of installation, how Oracle WebLogic Server domains are configured, and the core directory structure. A much more comprehensive picture is provided in the Oracle Fusion Applications Installation Guide.

This section contains the following topics:

- Section 1.2.1, "Understanding Provisioning"

- Section 1.2.2, "Oracle WebLogic Server Domains Configuration"

- Section 1.2.3, "Provisioned Oracle Fusion Applications Home Directories"

1.2.1 Understanding Provisioning

Provisioning is the entire set of operations required to install, configure, and deploy Fusion Applications from a system point of view. There is a provisioning process for the Fusion Applications stack and a separate provisioning process for the Identity Management components. Each has its own Provisioning Wizard.
In general, "provisioning" refers to the Fusion Applications stack and includes these operations:

- Installation provides the operations related to laying down all the component needed to create the environment.

- Configuration tailors components based on the applications topology, the creation of Oracle WebLogic Server Managed Servers and clusters, and the updating of endpoints and virtual hosts.

- Deployment starts the Managed Servers and clusters and facilitates the actual use of product offerings.

This orchestration by a single processing engine helps ensure that components interact smoothly and consistently in the applications environment.

For detailed information about provisioning and installing an Oracle Fusion Applications environment, see Oracle Fusion Applications Installation Guide.

1.2.1.1 Installation Options

You choose options from the Provisioning Wizard menu to initiate installation-related processes:

- Install a transaction database

- Create a new provisioning plan

- Install, configure, and deploy the product offerings in a provisioning plan

- Uninstall an existing environment

1.2.1.2 Installing an Oracle Database and Loading Content

You must have installed and configured a transaction database before you install product offerings. You can use the Provisioning Wizard to create an empty, single-instance database instance. This is a discrete and separate task from the other provisioning options. Alternatively, you can install the database manually without using the wizard.

In either case, you finish the database installation by running the Oracle Fusion Applications Repository Creation Utility (Applications RCU) to load applications and middleware content into the database. This process creates the applications and middleware schemas, loads seed data, and creates the tablespaces, as well all other required packages.

For more information about creating a database with Applications RCU, see the Oracle Fusion Applications Installation Guide.

1.2.2 Oracle WebLogic Server Domains Configuration

During installation, the applications for a single product family are deployed to one Oracle WebLogic Server domain. A domain consists of one or more WebLogic Server instances (and their associated resources) that you manage with a single Administration Server.

Within a single domain, an Administration Server includes the Oracle WebLogic Server Administration Console, Oracle Fusion Middleware Control, Oracle Fusion Applications Control and JMX MBeans. Depending on the installation type, it may also include components for Oracle Business Intelligence. The Administration Server manages any number of Managed Servers.

The Managed Servers host the Java EE applications for the product family. The Managed Servers are grouped together into a cluster for each application of the product family.

Figure 1-3 shows a domain with an Administration Server and three Managed Servers in clusters. If you want to scale out the Java EE application, you simply add new servers to the cluster. In an Oracle Fusion Applications environment, the domains are predefined so that the product families and their dependencies are always stored in a standardized arrangement.

Figure 1-3 Oracle WebLogic Server Domain

As an example of greater detail for a product family, Figure 1-4 shows a portion of the domain for the Oracle Fusion Financials product family with an Administration Server and eight Managed Servers in a cluster. The applications are each deployed to a Managed Server within a cluster. In addition to the applications for Oracle Fusion Financials, the domain also contains an Oracle Enterprise Scheduler cluster and a SOA cluster. The Oracle Enterprise Scheduler (ESSAPP) application manages job requests for the product family. The SOA Infrastructure (soa-infra) application hosts the SOA composites for the applications in the product family.

Figure 1-4 Oracle WebLogic Server Domain for the Oracle Fusion Financials Family

Figure 1-5 shows an Oracle Fusion Applications environment with multiple product families, each in separate Oracle WebLogic Server domains. The CommonDomain is the domain in the Oracle Fusion Setup product family.

Figure 1-5 Multiple Product Families

1.2.3 Provisioned Oracle Fusion Applications Home Directories

An installation of Oracle Fusion Applications contains two mount point directories, APPLICATIONS_BASE for the binaries and APPLICATIONS_CONFIG for the configuration files. The APPLICATIONS_BASE and APPLICATIONS_CONFIG directories contain various types of home directories. The home directories described in Table 1-3.

Table 1-3 Home Directories

Home Directory

Description

Variable Representation

Applications base

This directory is the top-level directory for the Oracle Fusion Applications binaries. You specify the location of this top-level directory at the time of provisioning. Figure 1-6 represents this directory as /net/mount1/appbase to show an example directory structure.

APPLICATIONS_BASE

Applications configuration

This directory is the top-level directory for the Oracle Fusion Applications configuration files. You specify a location for this top-level directory at the time of provisioning. Provisioning automatically creates a subdirectory named instance as a container for the configuration files. Figure 1-6 represents this directory as /net/mount2/instance to show an example directory structure.

APPLICATIONS_CONFIG

Middleware home

This directory provides a container for the Oracle WebLogic Server home, an Oracle Common home, and one or more Oracle homes for components. A Middleware home can reside on a local file system or on a remote shared disk that is accessible through Network File System (NFS).

An installation of Oracle Fusion Applications creates two Middleware homes:

- fusionapps for the Oracle WebLogic Server home and Oracle homes for Oracle Fusion Middleware components, such as Oracle Business Intelligence, Oracle SOA Suite, Oracle Data Integrator, WebCenter, Oracle Enterprise Content Management, Oracle Secure Enterprise Search, and Oracle Fusion Middleware Extensions for Applications (Applications Core)

- webtier_mwhome for the system components, such as Oracle HTTP Server

For operations on specific Middleware home directories, this guide refers to each Middleware home by its product name or specifies the directory. For example, the Middleware home for Oracle Fusion Applications is referred to as the Oracle Fusion Applications Middleware home or the fusionapps Middleware home directory and its variable is FA_MW_HOME, while the Middleware home for Oracle Web Tier is referred to as the Web Tier Middleware home or the webtier_mwhome Middleware home directory and its variable is WT_MW_HOME. In cases where differentiation is not necessary, this guide refers to the Middleware home and uses the MW_HOME variable.

MW_HOME
FA_MW_HOME
WT_MW_HOME

Oracle Business Intelligence configuration home

This directory contains the configuration files for the Oracle Business Intelligence installation.

BI_CONFIG_HOME

Oracle Common home

This directory contains the binary and library files required for Fusion Applications Control, test to production, and Java Required Files (JRF). The Java Required Files include the Oracle ADF libraries, several other components shared by the product suites included in a given installation, and components such as Oracle Metadata Service (MDS) and Oracle Platform Security Services (OPSS).

ORACLE_COMMON_HOME

Oracle Database client home

This directory provides a container for the Oracle Database client software files.

DBCLIENT_ORACLE_HOME

Oracle WebLogic Server home

This directory contains installed files necessary to host Oracle WebLogic Server. The Oracle WebLogic Server home directory is a peer of Oracle home directories and resides within the directory structure of the Middleware home.

WL_HOME

Oracle_Home

This directory contains installed files necessary to host a specific component or software suite. For example, the files for Oracle SOA Suite are stored in an Oracle home directory named soa, and the application artifacts for Oracle Fusion Applications are stored in an Oracle home directory named applications.

An Oracle home resides within the directory structure of the Middleware home. There can be multiple Oracle homes within each Middleware home.

This guide refers to each Oracle home by product name or specifies the directory. For example, the Oracle home for Oracle SOA Suite is referred to as the SOA Oracle home or the soa Oracle home directory and its variable is SOA_ORACLE_HOME, while the Oracle home for Oracle Fusion Applications is referred to as the Oracle Fusion Applications Oracle home or the applications Oracle home and its variable is FA_ORACLE_HOME.

ATGPF_ORACLE_HOME
FA_ORACLE_HOME
JROCKIT_ORACLE_HOME
SOA_ORACLE_HOME
WC_ORACLE_HOME
WG_ORACLE_HOME
WT_ORACLE_HOME

Oracle Web Tier configuration home

This directory contains the configuration files for the Oracle Web Tier installation.

WT_CONFIG_HOME

Oracle WebLogic Server domain home

This directory contains the configuration files for the Administration Server and the Managed Servers for the product family.

DOMAIN_HOME

Figure 1-6 shows the relationship of the home directories using the Oracle Fusion Financials product family on a UNIX environment as an example. This figure does not show all the subdirectories under APPLICATIONS_BASE and APPLICATIONS_CONFIG directory. For example, the APPLICATIONS_CONFIG directory contains several more directories for component-specific configuration files. Also, the Oracle Database and Oracle Identity Management are not represented in this figure, as they are installed separately.

Figure 1-6 Relationship of Home Directories

For more information about the detailed directory structure, see the Oracle Fusion Applications Installation Guide.

1.3 Security Features in Oracle Fusion Applications

Oracle Fusion Applications includes built-in security features. The default roles and security policies are designed to encompass common business needs. Role definitions, role hierarchies, data security, and segregation of duties policies can be changed or extended to meet the security needs of the enterprise.

Oracle Fusion Applications security is based on the following concepts:

- Role-based access: uses job roles, duty roles, and abstract roles to assign access rights to users

- Segregation of duties: separates actions, such as approving, recording, processing, and reconciling results, to limit the potential for unintentional errors and willful fraud

- Consistent and transparent function and data security: makes data and application functions inaccessible to users by default, enabling access only when explicitly granted through roles necessary to access specific data or functions

- Robust privacy protections: uses multiple levels of data privacy classification that work with data security policies to protect sensitive data

- Native identity management and access provisioning: features Oracle Identity Management integration for creating and managing user identities, creating and linking user accounts, managing user access control through user role assignment, managing workflow approvals, and delegating administration

- Enforcement across tools (all the tools use the same policies) and across the information lifecycle: uses common Oracle Fusion Applications security policies that are consistent across enterprise information access methods

- Integration with Oracle Fusion Governance, Risk, and Compliance: provides critical business controls to manage risk and multi-regulatory compliance and to control enforcement

- An extensive reference implementation: uses a predefined business processes, roles, role memberships, entitlement, and policies

- Standard tools to extend the footprint: uses a common set of tools to manage, edit, and expand the security features of Oracle Fusion Applications

- Data masking for environments performing production-to-test content movement (P2T)

- Auditing for regulatory compliance

1.4 Roadmap for Administering Oracle Fusion Applications

Before using the administrative procedures in this guide, ensure the Oracle Fusion Applications environment is provisioned, as described in the Oracle Fusion Applications Installation Guide.

The following provides a summary of the steps to configure, manage, and perform ongoing maintenance of an Oracle Fusion Applications environment after you have installed the software:

1. Start components. See Section 4.4.

2. Configure ports. See Section 4.5.

3. Configure passwords. See Section 4.6.

4. Manage the Oracle database. See Section 4.7.

5. Configure security. See Chapter 5.

6. Deploy customizations. See the Oracle Fusion Applications Extensibility Guide for Developers.

7. Monitor your environment. See Chapter 10, Chapter 11, and Chapter 12.

8. Manage log files and diagnostic information. See Chapter 13.

9. Backup your environment. See Chapter 15.

10. Configure load balancing between different components or applications. See Chapter 16.

11. Configure Oracle Transactional Business Intelligence to perform real-time analysis of the Oracle Fusion applications. See the Oracle Fusion Administrator's Guide for Transactional Business Intelligence.

12. After the Oracle Fusion applications are running, configure the Oracle Business Intelligence Applications applications for analyzing historical data. See the Oracle Business Intelligence Applications Installation Guide.

Related Links

In addition to this guide, refer to the following guides for tasks that you may need to perform, depending on your business needs:

- Oracle Fusion Applications Installation Guide for configuration tasks to perform after installation

- Oracle Fusion Applications Common Implementation Guide for common setup and maintenance tasks for Oracle Fusion applications

- Oracle Fusion Applications Administrator's Troubleshooting Guide for common issues in the runtime environment

Part II

Basic Administration

This part describes basic administration tasks.

Part II contains the following chapters:

- Chapter 2, "Getting Started with Administering Oracle Fusion Applications"

- Chapter 4, "Performing Routine Administrative Tasks"

- Chapter 5, "Securing Oracle Fusion Applications"

- Chapter 6, "Managing Oracle Enterprise Scheduler Service and Jobs"

- Chapter 7, "Managing Report Delivery Servers"

- Chapter 8, "Managing Search with Oracle Enterprise Crawl and Search Framework"

- Chapter 9, "Managing Oracle WebLogic Communication Services for Click-to-Dial Functionality"

2 Getting Started with Administering Oracle Fusion Applications

This chapter provides information you need to get started administering your Oracle Fusion Applications environment, including information about the tools you use.

Before using the administrative procedures in this chapter and the rest of this guide, ensure the Oracle Fusion Applications environment is provisioned, as described in the Oracle Fusion Applications Installation Guide.

This chapter contains the following topics:

- Section 2.1, "Introduction to the Tools Used to Administer Oracle Fusion Applications"

- Section 2.2, "Key Differences Between Fusion Applications Control and Cloud Control"

- Section 2.3, "When to Use Fusion Applications Control Tool, When to Use Oracle WebLogic Server Administration Console"

- Section 2.4, "Finding the Administration Server Port and Other Administrative URLs for Domains"

- Section 2.5, "Using Fusion Applications Control"

- Section 2.6, "Using Oracle Authorization Policy Manager"

- Section 2.7, "Using Oracle WebLogic Server Administration Console"

- Section 2.8, "Using Cloud Control"

- Section 2.9, "Using Oracle Fusion Functional Setup Manager"

- Section 2.10, "Caution Against Using Database Tools to Modify Oracle Fusion Applications Data"

2.1 Introduction to the Tools Used to Administer Oracle Fusion Applications

Oracle provides several tools to administer the Oracle Fusion Applications, the Oracle Fusion Middleware layer, and the Oracle Database within your Oracle Fusion Applications installations. Use these tools, rather than directly editing configuration files, to perform all administrative tasks unless a specific procedure requires you to edit a file. Editing a file may cause the settings to be inconsistent and generate problems.

The primary administration tools for Oracle Fusion Applications are described in Table 2-1.

Table 2-1 Administration Tools for Oracle Fusion Applications

Tool

Description

Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control)

Enables you to monitor and administer a product family within the Oracle Fusion Applications environment. See Section 2.5.

Oracle Enterprise Manager Cloud Control (Cloud Control)

Enables you to monitor and administer the entire Oracle Fusion Applications environment, including product families, Oracle Fusion Middleware components across all Oracle WebLogic Servers, and the Oracle Database. See Section 2.2 to understand the key difference between Cloud Control and Fusion Applications Control, and see Section 2.8 to get started with using Cloud Control.

Oracle Fusion Functional Setup Manager

Guides you through the tasks of setting up the functional data and reference data. See Section 2.5.

Oracle Fusion Applications Diagnostic Dashboard

Enables you to register, execute, and monitor diagnostic tests for Oracle Fusion Applications, and also work with diagnostic test registration tags and purge diagnostic test results. See Chapter 13.

The primary administration tools for Oracle Fusion Middleware are described in Table 2-2.

Table 2-2 Administration Tools for Oracle Fusion Middleware

Tool

Description

Fusion Applications Control

Enables you to monitor and administer Oracle Fusion Middleware components within an Oracle WebLogic Server Domain for a specific product family. Within a single domain, an Administration Server hosts the applications for Fusion Applications Control and Oracle WebLogic Server Administration Console. The Managed Servers in the domain host the Java EE applications for the product family. The Managed Servers are grouped together into a cluster for each application of the product family. See Section 2.5.

Fusion Applications Control also includes a System MBean Browser that enables you browse the MBeans for an Oracle WebLogic Server or for a selected application. See "Getting Started Using the Fusion Middleware Control MBean Browsers" in the Oracle Fusion Middleware Administrator's Guide.

Oracle Enterprise Manager Cloud Control (Cloud Control)

Enables you to monitor and administer the entire Oracle Fusion Applications environment, including product families, Oracle Fusion Middleware components across all Oracle WebLogic Servers, and the Oracle Database. See Section 2.2 to understand the key difference between Cloud Control and Fusion Applications Control, and see Section 2.8 to get started with using Cloud Control.

Oracle Data Integrator Console

Enables you to manage and monitor an Oracle Data Integrator runtime architecture and browse design-time objects. For an overview of this console, see Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator. For common modifications in an Oracle Fusion Applications environment, see Section 4.11.

Oracle WebLogic Server Administration Console

Enables you to manage the Oracle WebLogic Server in each domain. The Administration Server hosts the application for the Oracle WebLogic Server Administration Console. See Section 2.3 to understand the when to use Administration Console, and see Section 2.8 to get started with using the Administration Console.

Oracle Fusion Middleware command-line tools

Enables you to manage Oracle Fusion Middleware components. See "Getting Started Using Command-Line Tools" in the Oracle Fusion Middleware Administrator's Guide to learn about the Oracle WebLogic Scripting Tool (WLST) and the Oracle Process Manager and Notification Server (OPMN).

Middleware support for application security

General Fusion Applications security topics are covered in both Chapter 5, "Securing Oracle Fusion Applications" of this guide, and the Oracle Fusion Applications security guides.

The Oracle Fusion Applications environment includes the following tools for managing application security:

- Oracle Authorization Policy Manager enables you to manage application policies. See Section 5.3, "Managing Authorization Policies".

- Oracle Access Manager Administration Console enables you to manage system configurations, including Oracle Access Manager server instances and data sources, access policies, agent profiles, and other security elements. See the Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager with Oracle Security Token Service.

- Oracle Identity Manager Administrative and User Console enables you to access the organization's resources (through self-service) and enable administrators to manage the access (by creating users and roles, and defining authorization policies). See the Oracle Fusion Middleware Administrator's Guide for Oracle Directory Integration Platform.

- Oracle Web Service Policy Manager enables you manage and secure web services for SOA composite applications. See the Oracle Fusion Middleware Security and Administrator's Guide for Web Services.

The primary administration tools for the Oracle Database are described in Table 2-3.

Table 2-3 Administration Tools for the Oracle Database

Tool

Description

Oracle Enterprise Manager Database Control

Enables you to monitor and manage the Oracle Database for the Oracle Fusion Applications. See the Oracle Database 2 Day DBA.

Cloud Control

Enables you to monitor historical data for the Oracle Database. See Section 2.8.

SQL Plus

This is the command-line interface for administering databases.

2.2 Key Differences Between Fusion Applications Control and Cloud Control

You can manage your Oracle Fusion Applications environment using Fusion Applications Control or Cloud Control.

Fusion Applications Control organizes a wide variety of performance data and administrative functions into distinct, Web-based home pages for the farm, cluster, domain, servers, components, and applications. The Fusion Applications Control home pages make it easy to locate the most important monitoring data and the most commonly used administrative functions all from your Web browser. Fusion Applications Control is automatically installed with each Oracle WebLogic Server domain for each product family during an Oracle Fusion Applications installation. For more information about this control, see Section 2.5.

Managing several farms from different, distinct Fusion Applications Controls becomes very difficult in an Oracle Fusion Applications environment. For centralized management and additional management functionality (such as historical data collections for performance trending, email and page notifications for potential availability or performance problems, and service level management), you can use Cloud Control.

Cloud Control enables you to monitor all the product families, Oracle Fusion Middleware components, and the Oracle Database across the entire Oracle Fusion Applications environment from one console. To use Cloud Control, you need to separately install Oracle Enterprise Manager Cloud Control 12c (12.1.0.1) with the Application Management Pack for Oracle Fusion Applications. For more information about this control, see Section 2.8. For more information about installing Cloud Control, see the following documentation:

- Oracle Enterprise Manager Cloud Control Basic Installation Guide for more information about the installation process

- Oracle Enterprise Manager Licensing Information for more information about the Application Management Pack

2.3 When to Use Fusion Applications Control Tool, When to Use Oracle WebLogic Server Administration Console

Fusion Applications Control and Oracle WebLogic Server Administration Console are graphical user interfaces that you can use to monitor and administer your environment. Use Table 2-4 to locate the task you are performing.

Table 2-4 Comparing Fusion Applications Control and WebLogic Server Administration Console

Task

Tool to Use

Manage Oracle WebLogic Server

Use:

Create additional Managed Servers

WebLogic Server Administration Console

Clone Managed Servers

WebLogic Server Administration Console

Cluster Managed Servers

WebLogic Server Administration Console

Start and stop Oracle WebLogic Server

Fusion Applications Control or WebLogic Server Administration Console

Add users and groups

WebLogic Server Administration Console if using the default embedded LDAP; if using another LDAP server, use the LDAP server's tool

Manage Data Sources

Use:

Create data sources

WebLogic Server Administration Console

Create connection pools

WebLogic Server Administration Console

Manage JMS Resources

Use:

Create JMS queues

WebLogic Server Administration Console

Configure advanced queuing

WebLogic Server Administration Console

Manage SOA environment

Use:

Deploy and undeploy SOA Composite applications

Fusion Applications Control

Monitor SOA Composite applications

Fusion Applications Control

Modify Oracle BPEL Process Manager MBean properties

Fusion Applications Control

Debug applications such as Oracle BPEL Process Manager applications

Fusion Applications Control

ADF Applications

Use:

Deploy and undeploy ADF applications

Fusion Applications Control

Java EE applications

Use:

Deploy and undeploy Java EE applications

WebLogic Server Administration Console or Fusion Applications Control

Security

Use:

Configure and manage auditing

Fusion Applications Control

Configure SSL

WebLogic Server Administration Console for Oracle WebLogic Server

Fusion Applications Control for Java components and system components. See Chapter 5.

Change passwords

WebLogic Server Administration Console

Manage Components

Use:

View and manage log files

Fusion Applications Control for most log files. See Section 13.3.

WebLogic Server Administration Console for the following logs:

DOMAIN_HOME/servers/server_name/logs/access.log
DOMAIN_HOME/servers/server_name/data/ldap/log/EmbeddedLDAP.log
DOMAIN_HOME/servers/server_name/data/ldap/log/EmbeddedLDAPAccess.log

Change ports

WebLogic Server Administration Console for Oracle WebLogic Server and Java components

For some system components, Fusion Applications Control.

Manage Oracle HTTP Server

Fusion Applications Control

Start and stop components

Fusion Applications Control

Start and stop applications

Fusion Applications Control

Manage Business Intelligence (BI) system components

Fusion Applications Control

2.4 Finding the Administration Server Port and Other Administrative URLs for Domains

Within a single Oracle WebLogic Server domain, an Administration Servers hosts the application for Fusion Applications Control and Oracle WebLogic Server Administration Console. To locate the port for the Administration Server and other administrative URLs for the Oracle WebLogic Server domains, use the provisioning summary file saved during provisioning.

During provisioning of Oracle Fusion Applications, on the Summary page of the Provisioning Wizard, you used the Response File Name and Provisioning Summary fields to specify the response and provisioning summary file locations. For more information about these files, see the "Summary" section in the Oracle Fusion Applications Installation Guide.

In the provisioning summary file, under the Admin Server entry for the domain, locate the following subentries:

- Managed Server Port for the Administration Server port

- Enterprise Manager Welcome Page for the URL for Fusion Applications Control

- Admin Console for the URL for the Oracle WebLogic Server Administration Console

Example 2-1 shows an excerpt of the summary file.

Example 2-1 Summary File Excerpt

...
Common Domain
Admin Server
Host: hostname.domain
Managed Server Port: 7001
Secure Managed Server Port: 7002
Admin Console
http://commoninternal.domain:7777/console
Enterprise Manager Welcome Page
http://commoninternal.domain:7777/em
Functional Setup Manager
Host: hostname.domain
Managed Server Port: 7004
Secure Managed Server Port: 7005
Home Page
Host: hostname.domain
Managed Server Port: 7006
Secure Managed Server Port: 7007
Home Page
Host: hostname.domain
Managed Server Port: 7006
Secure Managed Server Port: 7007
Help Portal
Host: hostname.domain
Managed Server Port: 7008
Secure Managed Server Port: 7009
Business Process Server
Host: hostname.domain
Managed Server Port: 7010
Secure Managed Server Port: 7011
Content Server
Host: hostname.domain
Managed Server Port: 7012
Secure Managed Server Port: 7013
Secure Enterprise Search
Host: hostname.domain
Managed Server Port: 7016
Secure Managed Server Port: 7017
Enterprise Scheduler
Host: hostname.domain
Managed Server Port: 7020
Secure Managed Server Port: 7021
WebCenter Spaces
Host: hostname.domain
Managed Server Port: 7022
Secure Managed Server Port: 7023
WebCenter Collaboration
Host: hostname.domain
Managed Server Port: 7024
Secure Managed Server Port: 7025
OWLCS Server
Host: hostname.domain
Managed Server Port: 7030
Secure Managed Server Port: 7031
OWLCS SIP State Server
Host: hostname.domain
Managed Server Port: 7032
Secure Managed Server Port: 7033
Web Tier
Host: hostname.domain
CRM Domain
Admin Server
Host: hostname.domain
Managed Server Port: 9001
Secure Managed Server Port: 9002
Admin Console
http://crminternal.domain:7777/console
Enterprise Manager Welcome Page
http://crminternal.domain:7777/em
...
Financial Domain
Admin Server
Host: hostname.domain
Managed Server Port: 7401
Secure Managed Server Port: 7401
Admin Console
http://fininternal.domain:7777/console
Enterprise Manager Welcome Page
http://fininternal.domain:7777/em
...

2.5 Using Fusion Applications Control

Fusion Applications Control is a Web browser-based, graphical user interface that you can use to monitor a product family and its products. It also enables you to monitor and administer Oracle Fusion Applications and an Oracle Fusion Middleware farm.

A farm is a collection of components managed by Fusion Applications Control. It can contain an Oracle WebLogic Server domain, one Administration Server, one or more Managed Servers, clusters, and the Oracle Fusion Middleware components that are installed, configured, and running in the domain.

Fusion Applications Control organizes a wide variety of performance data and administrative functions into distinct, Web-based home pages for the product family, products, Oracle Fusion Applications, farm, domain, servers, and Oracle Fusion Middleware components. The Fusion Applications Control home pages make it easy to locate the most important monitoring data and the most commonly used administrative functions for various targets—all from your Web browser.

The section contains the following topics:

- Section 2.5.1, "Understanding How Fusion Applications Control Compares with Fusion Middleware Control"

- Section 2.5.2, "Accessing Fusion Applications Control"

- Section 2.5.3, "Using Fusion Applications Control Help"

- Section 2.5.4, "Navigating within Fusion Applications Control"

- Section 2.5.5, "Understanding the Targets in the Target Navigation Pane"

- Section 2.5.6, "Navigating to the Product Family and Product Administration Pages"

- Section 2.5.7, "Viewing the Performance of Targets"

- Section 2.5.8, "Understanding Users and Roles for Fusion Applications Control"

For information about the System MBean Browser, see the "Getting Started Using the Fusion Middleware Control MBean Browsers" section in the Oracle Fusion Middleware Administrator's Guide.

2.5.1 Understanding How Fusion Applications Control Compares with Fusion Middleware Control

If you have worked with Oracle Fusion Middleware, then you may already be familiar with Fusion Middleware Control. Fusion Middleware Control enables you to monitor and administer a farm. Fusion Applications Control provides all the functionality available in Fusion Middleware Control plus functionality specific to Oracle Fusion Applications.

Many procedures throughout this guide reference content in Oracle Fusion Middleware guides, which describes using Fusion Middleware Control. Where these references occur, the same procedures also apply to Fusion Applications Control. Where the controls vary, the procedures for Fusion Applications Control are contained within this guide.

2.5.2 Accessing Fusion Applications Control

To display Fusion Applications Control for a given Oracle WebLogic Server domain:

1. Enter the URL in your Web browser:

http://product_familyinternal.domain:port/em

where product_familyinternal.domain. port is the host and domain of the Oracle HTTP Server or a Load Balancer.

During provisioning of Oracle Fusion Applications, on the Summary page of the Provisioning Wizard, you used the Response File Name and Provisioning Summary fields to specify the response and provisioning summary file locations. For more information about these files, see the "Summary" section in the Oracle Fusion Applications Installation Guide.

In the provisioning summary file, for the domain, find the Enterprise Manager Welcome Page entry to locate the URL. For example:

....
CommonDomain
Enterprise Manager Welcome Page
http://commoninternal.domain:7777/em
....
CRM Domain
Enterprise Manager Welcome Page
http://crminternal.domain:7777/em
....
Financial Domain
Enterprise Manager Welcome Page
http://fininternal.domain:7777/em
...

The login page displays.

2. Enter Oracle Fusion Middleware administrative user name and password, and then click Login.
This user is the super user specified on the Identity and Policy Management page of the Provisioning Wizard. See "Identity and Policy Management Configuration" section in the Oracle Fusion Applications Installation Guide for information about using the Identity and Policy Management Configuration page.

2.5.3 Using Fusion Applications Control Help

At any time while using the Fusion Applications Control, you can click Help > Enterprise Manager at the top of the page to get more information. In most cases, the Help window displays a help topic about the current page. Click Contents in the Help window to browse the list of help topics, or click Search to search for a particular word or phrase.

2.5.4 Navigating within Fusion Applications Control

Fusion Applications Control displays the target navigation pane on the left and the content pane on the right. For example, when you first log in to Fusion Applications Control, the product family home page is displayed on the right.

From the target navigation pane, you can expand the tree and select either targets for the product family or the farm. See Section 2.5.5 for more information about the target navigation pane.

When you select a target, the target home page displays in the content pane and that target's menu is displayed at the top of the page, in the context pane. For example, if you select a product family, the product family menu is displayed. You can also view the menu for a target by right-clicking the target in the navigation pane.

Figure 2-1 shows the target navigation pane and the home page of a product family. Because a product family was selected, the dynamic target menu listed in the context pane is the product family menu.

Figure 2-1 Overview of Fusion Applications Control

In the preceding figure, the following items are called out:

- Target Navigation Pane lists all of the targets for an Oracle Fusion Applications product family and the farm navigation tree.

- Content Pane shows the current page for the target. When you first select a target, that target's home page is displayed.

- Dynamic Target Menu provides a list of operations that you can perform on the currently selected target. The menu that is displayed depends on the target you select. The menu for a specific target contains the same operations as those in the Right-Click Target Menu.

- Right-Click Target Menu provides a list of operations that you can perform on the currently selected target. The menu is displayed when you right-click the target name in the target navigation pane. In the figure, the user has right-clicked the product family.
The menu for a specific target contains the same operations as those in the Dynamic Target Menu.

- Topology Viewer displays the topology of the product family, including the middleware relationships and the products and applications in the product family.

- Target Name is the name of the currently selected target.

- General Information Icon provides information about the target. For example, for a domain, it displays the target name, the version, and the domain home.

- Context Pane provides the name of the target, the name of the current user, the host name, and the time of the last page refresh, as well as the Refresh icon.

- Expand All/Collapse All lets you expand or collapse the navigation tree.

- Refresh indicates when the page is being refreshed. Click it to refresh a page with new data. (Refreshing the browser window refreshes the page but does not retrieve new data.)

- Go To Home takes you to the product family home page, when you click the Oracle logo.

Table 2-5 describes some common ways you can navigate within Fusion Applications Control.

Table 2-5 Navigating within Fusion Applications Control

To:

Take This Action:

View all of the targets in the farm

Click the Expand All icon at the top of the target navigation pane.

Navigate to a target

Select the target in the target navigation pane.

Selecting the product family from the top of the displays the product family home page and selecting the farm displays the farm home page. You can expand the product family and the farm for additional targets.

Operate on a target

Right-click the target in the target navigation pane. The target menu display.

Alternatively, you can select the target and use the dynamic target menu in the context pane.

Return to the target's home page

Click the target name at the top left-hand corner of the context pane.

Refresh a page with new data

Click the Refresh icon in the top right of the context pane.

Return to a previous page

Click the breadcrumbs, which appear below the context pane. The breadcrumbs appear when you drill down in a target. For example, from the WebLogic Server menu, choose Logs >View Log Messages. Select a log file and click View Log File. The breadcrumbs show:

Log Messages > Log Files > View Log File: logfile_name

View the host on which the target is running

Select the target in the target navigation pane and view the host name in the target's context pane. You can also view the host name by clicking the General Information icon.

Return to the product family home page

Click the Oracle Enterprise Manager logo at the top left of the page.

View the topology

Click Topology.

View a server log file

Right-click the server name in the target navigation pane. Choose Logs > View Log Messages to see a summary of log messages and to search log files.

In addition, from Fusion Applications Control, from the home pages of targets such as the Administration Server or Managed Servers, you can access the WebLogic Server Administration Console.

2.5.5 Understanding the Targets in the Target Navigation Pane

Figure 2-2 shows the target navigation pane. The product family tree enables you to view an Oracle Fusion Applications product or application target. The farm tree enables you to select an Oracle WebLogic Server domain, an Oracle WebLogic Server Managed Server, an Oracle Fusion Middleware component, an application, or an Oracle Metadata Repository.

Figure 2-2 Target Navigation Pane

2.5.6 Navigating to the Product Family and Product Administration Pages

To navigate to the product family and product administration pages in Fusion Applications Control:

1. Navigate to the product family and product home page:

- To access the product family home page, from the navigation pane, select the name of the product family.

- To access the product home page, from the navigation pane, expand the product family, then Products, and then select the product.

2. Select the Product Family or Product menu.
The following figure shows the Product Family menu:

The following figure shows the Product menu:

The Product Family and Product menu displays the options described in Table 2-6.

Table 2-6 Product Family and Product Target Menu Options

Menu Option

Description

Home

Displays the product family or product home page. For more information about this page, see Section 10.2 and Section 10.3.

Control

This option provides options for starting and stopping all the cluster applications in the product family. These options do not start and stop the Managed Servers, which is recommended when starting and stopping all applications in a product family. Instead of these options, use one of the start and stop use cases described in Section 4.4.

Logs

Displays the options to either view log messages or configure log messages for all the applications in the product family. For more information, see Section 13.3.

Key Performance Indicators

Displays the Key Performance Indicators page for viewing the middle-tier metrics for the product family or product. see Section 2.5.7, Section 10.9, and Section 10.10.

System Performance

Displays the System Performance page for viewing the middle-tier metrics for the product family, see Section 2.5.7 and Section 11.3.1.

Applications and Infrastructure

Displays the Applications and Infrastructure page to view the status of Oracle Fusion Applications and Oracle Fusion Middleware components for the product family. See Section 10.8 for more information about using this page for monitoring applications, and see Section 11.2.1 for more information about using this page for monitoring Oracle Fusion Middleware.

General Information

Displays general details about the target.

2.5.7 Viewing the Performance of Targets

Fusion Applications Control automatically and continuously measures run-time performance. The performance metrics are automatically enabled; you do not need to set options or perform any extra configuration to collect them.

If you encounter a problem, such as an application that is running slowly or is hanging, you can view more detailed performance information, including performance metrics for a particular target, to find out more information about the problem. In many cases, these metrics are shown in interactive charts; other times they are presented in tabular format. The best way to use and correlate the performance metrics is from the Performance Summary page for the component or application you are monitoring.

To view the performance of a target with Fusion Applications Control:

1. From the menu for a specific target, choose Performance Summary. If the target is a product family or product, choose Key Performance Indicators to view business metrics or System Performance to view middle tier metrics.
The Performance Summary page displays.

2. To see additional metrics, click Show Metric Palette and expand the metric categories.
The following figure shows the System Performance page for a product family with the Metric Palette displayed:

3. Select additional metrics to add them to the Performance Summary.

4. To re-organize the display of performance charts in the System Performance page, select View > Reorder Chart Sets and move charts up or down, or remove a particular chart from the page.

5. To overlay another target, click Overlay, and select the target. The target is added to the charts, so that you can view the performance of more than one target at a time, comparing their performance.
Alternatively, you can display historical business metrics of the same product instance. Select Overlay > Today with Yesterday, This Week with Last Week or This Month with Last Month.

6. To customize the time frame shown by the charts, you can:

- Click Slider to display a slider tool that lets you specify that more or less time is shown in the charts. For example, to show the past 10 minutes, instead of the past 15 minutes, slide the left slider control to the right until it displays the last 10 minutes.

- Click the Enter Time clock icon. Then, enter the Start Time and End Time, and click OK. If there is no data available from the earlier time point, a confirmation message displays, explaining the timeline will be automatically adjusted to the time period for which the data is available.

7. To save the chart set so as to preserve a specific set of metrics selected for display, as opposed to the default metrics, select View > Save Chart Set and enter a name for the chart set to be saved.

Use the Fusion Applications Control online help to obtain a definition of a specific performance metric. There are two ways to access this information:

- Browse or search for the metric in the Fusion Applications Control online help.

- Navigate to the Performance Summary page for your component or application and perform the following:

1. Click Show Metric Palette.

2. Browse the list of metrics available for the component or application to locate a specific metric.

3. Right-click the name of the metric and select Help from the context menu.

2.5.8 Understanding Users and Roles for Fusion Applications Control

To access Fusion Applications Control and perform tasks, you must have the appropriate role. Fusion Applications Control uses the Oracle WebLogic Server security realm and the roles defined in that realm. If a user is not granted one of these roles, the user cannot access Fusion Applications Control.

Each role defines the type of access a user has. For example, a user with the role Admin has full privileges. A user with the role Operator has privileges to perform essential day-to-day operations. A user with the role Monitor has privileges only to view the configuration.

For more information, see "Users, Groups, and Security Roles" in the Oracle Fusion Middleware Securing Resources Using Roles and Policies for Oracle WebLogic Server.

2.6 Using Oracle Authorization Policy Manager

Oracle Authorization Policy Manager is a browser-based, graphical interface for managing policies and related security objects. It supports the creation and management of Authorization Policies. An Authorization Policy defines the rules for accessing a software component or business object. Only users with sufficient privileges can log in to Oracle Authorization Policy Manager.

This section contains the following topics:

- Section 2.6.1, "Understanding Authorization Policy Manager"

- Section 2.6.2, "Accessing Authorization Policy Manager"

- Section 2.6.3, "Navigating Within Authorization Policy Manager"

- Section 2.6.4, "Searching within Authorization Policy Manager"

2.6.1 Understanding Authorization Policy Manager

Access privileges are defined in an authorization policy by specifying who can do what to which resource, when it can be done, and how. The authorization policy can enforce controls on all types of resources including software components (URLs, Java Server Pages, Enterprise JavaBeans, methods, servlets and the like used to construct an application) and business objects (representations of user accounts, personal profiles and contracts such as bank accounts in a banking application, patient records in a health care application, or anything used to define a business relationship).

2.6.2 Accessing Authorization Policy Manager

Authorization Policy Manager is accessed from the Setup and Maintenance work area in Oracle Fusion Functional Setup Manager. After a task requiring action upon an authorization policy is selected, Authorization Policy Manager is launched automatically.

To display Oracle Authorization Policy Manager:

1. In Oracle Fusion Functional Setup Manager, go to Administration > Setup and Maintenance > Manage Tasks Lists and Tasks.

2. Click the name of the task.
Figure 2-3 is a screenshot of the Authorization Policy Manager with the Authorization Management tab active.

Figure 2-3 The Oracle Authorization Policy Manager Graphical Interface

You can also launch Oracle Authorization Policy Manager directly from a web browser.

To launch and sign in to Authorization Policy Manager directly:

1. Enter the Authorization Policy Manager Administration Console URL in the address bar of your browser. For example:
https://hostname:port/apm/

where:

- HTTPS represents the Hypertext Transfer Protocol (HTTP) with the Secure Socket Layer (SSL) enabled to encrypt and decrypt user page requests and the pages returned by the Web server.

- hostname refers to the fully qualified domain name of the computer hosting the Oracle Authorization Policy Manager Administration Console.

- port refers to the designated bind port for the Authorization Policy Manager Administration Console. (This is the same as the bind port for the WebLogic Server Administration Console.)

- /apm/ refers to the Authorization Policy Manager Log In page

2. Enter the System Administrator credentials.

3. Click Sign In.

2.6.3 Navigating Within Authorization Policy Manager

After a successful log in, the Authorization Policy Manager is displayed with the Authorization Management Tab active. The Navigation Panel is on the left side and the Home area on the right side. Objects selected in the Navigation Panel are opened in tabs and displayed in the Home area. Figure 2-3 is a screenshot of Authorization Policy Manager after an administrative user has successfully signed in.

The following sections contain descriptions of the top-level items displayed.

- Section 2.6.3.1, "Understanding the Main Tabs"

- Section 2.6.3.2, "Using The Navigation Panel"

- Section 2.6.3.3, "Understanding the Home Area"

- Section 2.6.3.4, "Accessing Help"

2.6.3.1 Understanding the Main Tabs

The following sections describe the organizational tabs available in Authorization Policy Manager. Each tabbed section includes a Navigation Panel and a Home area.

- Section 2.6.3.1.1, "Authorization Management Tab"

- Section 2.6.3.1.2, "System Configuration Tab"

2.6.3.1.1 Authorization Management Tab

Use the Authorization Management tab to search and manage policy objects. This tab is active after successful log in. Figure 2-3 is a screenshot of Authorization Policy Manager with the Authorization Management tab.

The left side contains the Navigation Panel and the right side contains the Home area. The options displayed in the Home area change depending upon which object was selected in the Navigation Panel. For more information, see Section 2.6.3.2 and Section 2.6.3.3.

2.6.3.1.2 System Configuration Tab

Use the System Configuration tab to manage administrative and system type objects. Figure 2-4 is a screenshot of an active System Configuration tab. The object selected in the Navigation Panel is displayed using tabs in the Home area.

Figure 2-4 System Configuration Tab

Use the System Configuration tab to manage system administrators (for example, creating additional system administrator roles, assigning users to system administrator roles, and assigning rights to system administrator roles)

2.6.3.2 Using The Navigation Panel

Use the Navigation Panel to find security objects by browsing the Global or Applications information trees, or by conducting a simple search. A list of all Global and Application policy objects is available in a navigable tree. You can browse the tree or display objects as Search Results based on defined search criteria. Figure 2-5 is a screenshot that displays the Navigation Panel with its nodes collapsed. Figure 2-6 displays the Navigation Panel with its nodes expanded and many policy objects in view.

Figure 2-5 Navigation Panel Browse Tab with Nodes Expanded

The Navigation Panel contains, from top to bottom, the following elements:

- A pull-down list to select the policy object for a simple search. For more information, see Section 2.6.4.1.

- A pull-down list to select the scope of a simple search. For more information, see Section 2.6.4.1.

- A text box to enter the simple search string. The string is compared against both the Name and Display Name of policy objects; those that match are displayed in the Search Results tab.

- The Browse tab displays the following expandable and collapsible nodes:

- The Global node collects global objects such as external roles.

- The Applications node contains one or more Applications being managed by the administrator that is logged in. (Only Applications which the logged in user is authorized to access are displayed.) From any of those displayed, the administrator can access application-specific policy objects such as resource types, entitlements, resources, policies, and roles.

- The Search Results tab displays the results of the last simple search as seen in Figure 2-6.

- Actions and View drop downs to select operations on the chosen policy object.

Figure 2-6 Navigation Panel Search Tab

From the Navigation Panel, there are two methods for displaying the New and Open options comprised in the Actions drop-down list.

- Locate the desired application, expand the node, and select the desired object. Click the Actions drop-down and select New.

- Locate the desired application, expand the node, and select the desired object. Right-click the object from the application node.

Select New to create a new object of the same type and select Open to display a search tab in the Home area. Double-clicking an object from the node also opens a Search tab in the Home area.

2.6.3.3 Understanding the Home Area

The Home area displays on the right side of the Navigation Panel and contains quick access links to New and Search screens for the most commonly used policy objects. As shown in Figure 2-7, the Home area is divided into the following sections.

- The Application area is the upper region of the Home area. The Application Name pane displays all applications available to the logged in user. To the right of this pane are links to screens for performing common operations such as creating new policy objects (entitlements, resources, resource types, application roles, and authorization policies) or searching defined policy objects.

- The Search and Create section is the lower right region of the Home area. This section is for objects shared across all applications and includes external role search.

- The Help Center section is the lower left region of the Home area. It contains links to information regarding the most commonly used procedures.

Figure 2-7 The Home Area

2.6.3.4 Accessing Help

To get more information while using the Authorization Policy Manager, click the Help link located in the upper right corner (as seen in Figure 2-3). A separate window opens. From this window you can access both the online help and an embedded version of this book in HTML. After the window displays, select either Administration Console Online Help or Fusion Applications Administrator's Guide from the drop-down Book list. The help topics link to the corresponding section of the embedded book as do the links in the Help's Table of Contents.

2.6.4 Searching within Authorization Policy Manager

Several kinds of search queries for policy and security objects are available.

- A simple search matches names and display names only. The search is generated from the top of the Navigation Panel and results are displayed in the Navigation Panel. For more information, see Section 2.6.4.1.

- An advanced search uses operators that enable more sophisticated matching. The advanced search screen is launched by double-clicking an object in the Navigation Panel, or from the Home area. The search box opens in the Home area and results are also displayed there. For more information, see Section 2.6.4.2.

- A pop-up search opens from within the Authorization Policy screen, when the policy is being created or modified, by clicking the green Add button (plus sign). The pop-up search box uses a shopping cart paradigm. You add choices selected from the multiple, displayed tabs on the top of the search box to the Selected box on the bottom of the search box. All choices in the Selected box are added when you click Add.
Figure 2-8 is a screen shot of the pop-up search box for adding a Principal. You can click between the three tabs (Application Roles, External Roles, and Users), selecting one or more policy subjects and adding them to the Selected Principals box. When you click Add Principals, all choices added from all tabs will then be added to the policy.

Figure 2-8 Pop-up Search Box

2.6.4.1 Finding Objects with a Simple Search

A simple search matches names and display names only. The fields in the top portion of the Authorization Management tab in the Navigation Panel, as shown in Figure 2-9, are used to specify simple queries.

Figure 2-9 Simple Search Fields and Results Tab in Navigation Panel

To specify a simple search, proceed as follows:

1. Select the policy object for which you are searching from the For list.
The following object types are available:

- Application Roles

- External Roles

- Users

- Resources

- Resource Types

- Entitlements

2. Select the search scope from the In list.
The search scope defines the level at which the search will take place. When searching for Application Roles, Resources, Resource Types, and Entitlements, the search scope is an Application. For External Roles and Users, the search scope is Global. For Entitlements and Resources, the search scope is the Policy Domain within an Application.

Note:

If performing a Resource search, you also select the Resource Type from the Type list.

3. Optionally, enter a string to match in the text box.
Wildcard characters percent (%) and asterisk (*) are supported for a simple search.

4. Click the arrow icon next to the text box to begin the search.
Names and display names matching the specified criteria are returned and displayed in the Search Results tab. If no search string was entered, a list of all objects of the specified type is returned.

5. Double-click the object to edit, right click the object and select New to create, or click the object's information icon for details.
For more information on managing policy objects, see Section 5.3, "Managing Authorization Policies".

2.6.4.2 Finding Objects with an Advanced Search

An advanced search is generally initiated by double-clicking the object name in the Navigation Panel, or from the Search link for the object in the Home area. An advanced search can use the following operators:

- Starts with

- Ends with

- Contains

- Equal to

There is no support for wildcard characters in an advanced search. In particular, the asterisk (*) or percent (%) characters are treated as plain text in any advanced search parameter. The following sections have information on searching for policy objects with an advanced search.

- Section 2.6.4.2.1, "Searching External Roles"

- Section 2.6.4.2.2, "Searching Applications"

- Section 2.6.4.2.3, "Searching Resource Types"

- Section 2.6.4.2.4, "Searching Application Roles"

- Section 2.6.4.2.5, "Searching Resources"

- Section 2.6.4.2.6, "Searching Entitlements"

- Section 2.6.4.2.7, "Searching Authorization Policies"

- Section 2.6.4.2.8, "Searching for Users Globally"

2.6.4.2.1 Searching External Roles

To search External Roles, proceed as follows:

1. Select from the following methods to display the Search External Roles page:

- In the Navigation Panel, expand Global and double-click External Roles.
Alternately, right-click External Roles and select Open.

- In the Home area, click Search - External Roles from the Search and Create section.

2. Enter the following query parameters:

- Name: Select an operator from the list and enter a string to match.

- Display Name: Select an operator from the list and enter a string to match.

Optionally, select from the Saved Search drop-down list of previously saved searches. Its query parameters automatically populate the search fields. Select Personalize... to set options for previously saved searches.

3. Optionally, click Save... to name the current query parameters.
The named search is added to the Saved Search list.

4. Click Search.
The results are displayed in Search Results.

2.6.4.2.2 Searching Applications

To search through Applications, proceed as follows:

1. Select from the following methods to display the Search Applications page:

- In the Navigation Panel, double-click Applications to display the Search Applications page.
Alternately, right-click Applications and select Open.

- In the Home area, click Search - Applications from the Search and Create section.

2. Enter the following query parameters:

- Name: Select an operator from the list and enter a string to match.

- Display Name: Select an operator from the list and enter a string to match.

Optionally, select from the Saved Search drop-down list of previously saved searches. Its query parameters automatically populate the search fields. Select Personalize... to set options for previously saved searches.

3. Optionally, click Save... to name the current query parameters.
The named search is added to the Saved Search list.

4. Click Search.
The results are displayed in Search Results.

2.6.4.2.3 Searching Resource Types

To search Resource Types, proceed as follows:

1. Select from the following methods to display the Search Resource Types page as in Figure 2-10.

- In the Navigation Panel, expand the Application node and double-click Resource Types.
Alternately, right-click Resource Types and select Open.

- In the Home area, select the appropriate Application Name and click Search under Resource Types.

Figure 2-10 Searching for Resource Types

2. Enter the following query parameters:

- Display Name: Select an operator from the list and enter a string to match.

- Name: Select an operator from the list and enter a string to match.

- Actions: Select an operator from the list and enter a string to match.

Optionally, select from the Saved Search drop-down list of previously saved searches. Its query parameters automatically populate the search fields. Select Personalize... to set options for previously saved searches.

3. Optionally, click Save... to name the current query parameters.
The named search is added to the Saved Search list.

4. Click Search.
All results matching the query specifications are displayed in the Search Results table as illustrated in Figure 2-11.

Figure 2-11 Resource Type Search Results

2.6.4.2.4 Searching Application Roles

To search Application Roles, proceed as follows:

1. Select from the following methods to display the Search Role Catalog page.

- In the Navigation Panel, expand Applications and the named Application node applicable to the search, and double-click Role Catalog.
Alternately, right-click Role Catalog and select Open.

- In the Home area, select the Application Name and click Search from Application Roles.

The Search Role Catalog tab is displayed as in Figure 2-12.

Figure 2-12 Searching for Application Roles in a Role Catalog

2. Enter the following query parameters:

- Role Name: Select an operator from the list and enter a string to match.

- Display Name: Select an operator from the list and enter a string to match.

- Category: Select a Role Category from the list. (Oracle Entitlements Server only supports an equals search for Role Category.)

Optionally, select from the Saved Search drop-down list of previously saved searches. Its query parameters automatically populate the search fields. Select Personalize... to set options for previously saved searches.

3. Optionally, click Save... to name the current query parameters.
The named search is added to the Saved Search list.

4. Click Search.
All results matching the query specifications are displayed in the Search Results table as in Figure 2-13.

Figure 2-13 Application Role Search Results

2.6.4.2.5 Searching Resources

A Resource can be hierarchical (a scenario in which the sub resource inherits attributes from the parent resource) or non-hierarchical. If a Resource is hierarchical, its tiered-organization is shown in the Search results. To search Resources, proceed as follows:

1. Select from the following methods to display the Search Resources page:

- In the Navigation Panel, expand Applications and the named Application node applicable to the search. Expand the appropriate Policy Domain and Resource Catalog and double-click Resources.
Alternately, right-click Resources and select Open.

- In the Home area, select the Application Name and click Search from Resources.

The Search Resources page is displayed as in Figure 2-14.

Figure 2-14 Searching for Resources

2. Enter the following query parameters:

- Resource Type: Select a resource type from the list. This parameter is required.

- Display Name: Select an operator from the list and enter a string to match.

- Name: Select an operator from the list and enter a string to match.

3. Click Search.
All results matching the query specifications are displayed in the Search Results table.

2.6.4.2.6 Searching Entitlements

To search Entitlements, proceed as follows:

1. Select from the following methods to display the Search Entitlements page:

- In the Navigation Panel, expand Applications and the named Application node applicable to the search. Expand the appropriate Policy Domain and Resource Catalog and double-click Entitlements.
Alternately, right-click Entitlements and select Open.

- In the Home area, select the Application Name and click Search from Entitlements. (In this case, the search is done only within the Default Policy Domain.)

The Search Entitlements tab is displayed in the Home area as in Figure 2-15.

Figure 2-15 Searching for Entitlements

2. Enter the following query parameters:

- Entitlement Name: Select an operator from the list and enter a string to match.

- Display Name: Select an operator from the list and enter a string to match.

- Resource name: Select an operator from the list and enter a string to match.

Optionally, select from the Saved Search drop-down list of previously saved searches. Its query parameters automatically populate the search fields. Select Personalize... to set options for previously saved searches.

3. Optionally, click Save... to name the current query parameters.
The name search is added to the Saved Search list.

4. Click Search.
All results matching the query specifications are displayed in the Search Results table.

2.6.4.2.7 Searching Authorization Policies

Authorization Policies can be searched by specifying a policy name, a principal, or a target. To search Authorization Policies, proceed as follows:

1. Select from the following methods to display the Search Policies page:

- In the Navigation Panel, expand Applications and the named Application node applicable to the search. Expand the appropriate Policy Domain and Resource Catalog and double-click Authorization Policies.
Alternately, right-click Authorization Policies and select Open.

- In the Home area, select the Application Name, and click Search under Authorization Policies. (In this case, the search is done within the Default Policy Domain.)

The Search Policies tab is displayed in Figure 2-16.

Figure 2-16 Searching for Policies

2. Select the search type from the Find By list.
The query parameters change according to the selection. Options include Policy, Principal or Target. Figure 2-17 is a screenshot in which Policy is selected. Figure 2-18 is a screenshot in which Target is selected.

Figure 2-17 Searching Polices by Target

3. Search using the option based on your previous selection.

- To Find By: Policy, enter the following query parameters.

- Database Resources: Select an operator from the list and enter a string to match.

- Principal: Select an operator from the list and enter a string to match.

- Target: Select an operator from the list and enter a string to match.

- To Find By: Principal or Find By: Target, select an operator from the list, and enter a string to match.
A Resource Type must be provided if the Resource or Resource Type operator is selected.

4. Click Search.

2.6.4.2.8 Searching for Users Globally

To search for Users, proceed as follows:

1. Select from the following methods to display the Search External Roles page:

- In the Navigation Panel, expand Global and double-click Users.
Alternately, right-click Users and select Open.

- In the Home area, click Search - Users from the Search and Create section.

2. Enter the following query parameters:

- User Name: Select an operator from the list and enter a string to match.

- Display Name: Select an operator from the list and enter a string to match.

Optionally, select from the Saved Search drop-down list of previously saved searches. Its query parameters automatically populate the search fields. Select Personalize... to set options for previously saved searches.

3. Optionally, click Save... to name the current query parameters.
The named search is added to the Saved Search list.

4. Click Search.
The results are displayed in Search Results.

2.7 Using Oracle WebLogic Server Administration Console

Oracle WebLogic Server Administration Console is a Web browser-based, graphical user interface that you use to manage an Oracle WebLogic Server domain.

While Fusion Applications Control is the primary administrative interface, use Administration Console as specified by Table 2-4 and wherever recommended in procedures in this guide.

The section contains the following topics:

- Section 2.7.1, "Starting Oracle WebLogic Server Administration Console"

- Section 2.7.2, "Locking the WebLogic Server Configuration"

2.7.1 Starting Oracle WebLogic Server Administration Console

To display Oracle WebLogic Server Administration Console for a given Oracle WebLogic Server domain:

1. Enter the URL in your Web browser:

http://product_familyinternal.domain:port/console

where product_familyinternal.domain. port is the host and domain of the Oracle HTTP Server or a Load Balancer.

During provisioning of Oracle Fusion Applications, on the Summary page of the Provisioning Wizard, you used the Response File Name and Provisioning Summary fields to specify the response and provisioning summary file locations. For more information about these files, see the "Summary" section in the Oracle Fusion Applications Installation Guide.

In the provisioning summary file, for the domain, find the Admin Console entry to locate the URL. For example:

....
CommonDomain
Admin Console
http://commoninternal.domain:7777/console
....
CRM Domain
Admin Console
http://crminternal.domain:7777/console
....
Financial Domain
Admin Console
http://fininternal.domain:7777/console
...

The login page displays.

2. Enter Oracle Fusion Middleware administrative user name and password, and then click Login.
This user is the super user specified on the Identity and Policy Management page of the Provisioning Wizard. See "Identity and Policy Management Configuration" section in the Oracle Fusion Applications Installation Guide for information about using the Identity and Policy Management Configuration page.

The home page displays, as shown in the following figure:

Alternatively, you can access the Administration Console from Fusion Applications Control, from the home pages of targets such as the Administration Server or Managed Servers.

2.7.2 Locking the WebLogic Server Configuration

Before you make configuration changes, lock the domain configuration, so you can make changes to the configuration while preventing other accounts from making changes during your edit session. To lock the domain configuration:

1. Locate the Change Center in the upper left of the Administration Console screen.

2. Click Lock & Edit to lock the configuration edit hierarchy for the domain.

As you make configuration changes using the Administration Console, you click Save (or in some cases Finish) on the appropriate pages. This does not cause the changes to take effect immediately. The changes take effect when you click Activate Changes in the Change Center. At that point, the configuration changes are distributed to each of the servers in the domain. If the changes are acceptable to each of the servers, then they take effect. If any server cannot accept a change, then all of the changes are rolled back from all of the servers in the domain. The changes are left in a pending state; you can then either edit the pending changes to resolve the problem or revert to the previous configuration.

2.8 Using Cloud Control

Cloud Control enables you to monitor runtime and historical data for the Oracle Fusion applications, Oracle Fusion Middleware components, and Oracle Database across the entire environment.

For an overview of Cloud Control, see the "Overview of Enterprise Manager Cloud Control 12c" chapter in Oracle Enterprise Manager Concepts.

Application Management Pack for Oracle Fusion Application is required to be licensed with Oracle Fusion Applications, and must match the number of licenses for the associated Oracle WebLogic Suite and Oracle WebLogic Suite for Oracle Fusion Applications and Oracle SOA Suite for Oracle Middleware or Oracle SOA Suite for Oracle Middleware for Oracle Fusion Applications. For more information about other Oracle Enterprise Manager products that can be licensed with Oracle Fusion Applications, see the Oracle Enterprise Manager Licensing Information.

The section contains the following topics:

- Section 2.8.1, "Starting to Use Cloud Control and Discovering Targets"

- Section 2.8.2, "Rediscovering Oracle Fusion Applications Targets"

- Section 2.8.3, "Removing Oracle Fusion Applications Targets"

- Section 2.8.4, "Navigating the Fusion Applications Target Home Page in Cloud Control"

- Section 2.8.5, "Using Cloud Control Help"

For specific uses of Cloud Control with an Oracle Fusion Applications environment, see the following sections:

- Section 11.5, "Performing Proactive Performance Monitoring with Cloud Control"

2.8.1 Starting to Use Cloud Control and Discovering Targets

To use Cloud Control, you must have installed the appropriate version of Oracle Enterprise Manager Cloud Control using the Application Management Pack for Oracle Fusion Applications.

To display Cloud Control:

1. Enter the URL in your Web browser:

http://oms_hostname.domain:port/em

where oms_hostname and oms_hostname are the host and port number of the Oracle Management Service. Note that the OMS typically runs on a different machine/server than the one running Fusion Applications.

The login page displays.

2. Enter the default super administrator account, SYSMAN, that is created with the password you specified during the installation, and then click Login.
The home page displays. This page provides a high-level view of your entire enterprise. For more information about this page, see Section 2.8.4 and click the Help link at the top of the page.

3. Enable licenses according to your licensing agreement with Oracle.
For more information, access the Enterprise Manager documentation library at the following URL and view the Oracle Enterprise Manager Licensing Information Guide: http://www.oracle.com/technetwork/indexes/documentation/index.html

4. To enable business metrics, perform the following before performing discovery:

1. Install the agent on the host where the specified Administration Server is running.

2. Give the agent read access to all the files in the directory that contains the jps-config-jse.xml file. The jps-config-jse.xml file is located in one of the following directories:

(UNIX) DOMAIN_HOME/config/fmwconfig
(Windows) DOMAIN_HOME\config\fmwconfig

The agent must be installed a host that has NFS access to the domain home directory using the path as would be used on the Administration Server host. In addition, the agent user must have read access to this file.

5. Discover the Oracle Fusion Applications environment:

1. From the Targets menu, choose Fusion Applications.

2. Click Add Fusion Instance.
The Add Fusion Instance: Functional Setup wizard displays.

3. Enter the host name for the Administration Server for the CommonDomain is in the Administration Server Host field.

4. Enter the Administration Server port in the Port field.

5. In the Username and Password fields, enter the username and password for the Administration Server.

6. In the Unique Fusion Instance Identifier, enter an intuitive name for the Fusion Instance. This name will be used to identify the Fusion Instance throughout Cloud Control. It must be unique and can include alphanumeric as well as dash (-), underscore (_) or period (.) characters.

7. If the Fusion Instance is deployed within a secured Functional Setup Domain, click Secured.

8. Enter the host name and port for the Management Agent that will enable monitoring of the Fusion Instance targets. To search for an agent, click the icon next to the Agent field. Local Agents deployed on the WebLogic Admin Server host will be displayed first.

9. Click Next to complete the configuration.

2.8.2 Rediscovering Oracle Fusion Applications Targets

As you work with your Oracle Fusion Applications environment, you may add additional targets through provisioning and scalability. When these types of changes occur, you can refresh the instance to add the new components as targets within a Fusion Instance already being managed by Cloud Control. You will typically do this because you need to:

- Add a new product family that is part of an already managed Fusion Instance as an additional target

- Add new instances within a product Family or an Oracle WebLogic Server domain that is already being managed by Cloud Control as new targets

To re-discover Oracle Fusion Applications environment:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page displays.

2. From the table, choose the Fusion Instance you want to refresh.

3. From the Fusion Instance menu, choose Refresh Fusion Instance.
The Refresh Fusion Instance wizard opens, pre-populated with existing data for the Fusion Instance.

4. Use the wizard to complete the refresh.

2.8.3 Removing Oracle Fusion Applications Targets

To re-discover the Oracle Fusion Applications environment:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page displays.

2. From the table, choose the Fusion Instance, Product Family, or Product you want to remove.

3. From the Fusion Instance, Product Family, or Product menu, choose Target Setup > Remove Target.

4. In the Remove Target page, choose Yes to remove the target.

2.8.4 Navigating the Fusion Applications Target Home Page in Cloud Control

Figure 2-18 shows the Fusion Applications target home page. This page displays the instance as a whole, product families, and products, giving an aggregate status of incidents and recent configuration changes.

Figure 2-18 Fusion Applications Target Home Page of Cloud Control

To access the Fusion Applications target home page in Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page displays. The table on the page lists the Fusion Instances, product families and products for the environment.

The Targets menu enables you to select the type of target you want to monitor. For more information about the Middleware option, see Section 11.5.1.

2. View the current data reported for each target.
The Fusion Applications overview page displays a table of Fusion instances. You can expand a given Fusion instance to display the Fusion Applications product families deployed to that instance. Each Fusion Applications product family can be expanded to display the applications within each product family. The following information displays for each item in the table.

- Name: This column displays the name of the Fusion instance or Fusion Applications product family.

- Type: This column indicates whether the item in the row is a Fusion instance, a Fusion Applications product family or a product.

- Database: This column displays the name of the database to which the Fusion instance is written.

- Incidents: This column displays incidents that have occurred within the scope of each item in the table. Incidents are categorized in sub-columns from left to right as follows: fatal, critical, warning and escalation level.

- Configuration Changes (last 7 days): This column displays any configuration changes to the given item in the row during the last seven days.

- Patches Applied: This column displays the number of software patches applied to the Fusion instance.

The Fusion Applications overview page allows you to create and view Fusion instances. Use the View menu to expand and collapse instances in the table. Click the Add Instance button to add a Fusion instance as a managed target in Cloud Control.

You can drill down to a Fusion instance, product family or product by clicking the relevant item in the table.

From this page, you can also access the global operations for the enterprise from the Enterprise menu:

- Summary enables to view the aggregate status of all managed targets, giving a big picture of system availability, alerts, and job status. Use this page to manage the grid by exception. Even with hundreds of managed targets, this page enables you to quickly detect and begin troubleshooting of problem areas without being distracted by noncritical issues.

- Monitoring provides options for global monitoring.

- Job provides information about all scheduled, currently running, and past jobs. It also enables you to display and manage jobs in the job library. The job library allows users to share and re-use library jobs that have been created.

- Reports enables you to manage all report definitions to which you have been granted access.

- Configuration enables you to manage configuration changes. For example, you can compare configuration to track down updates.

- Compliance enables you to view the policies for specific targets and obtain a summary of all the policy violations in your enterprise.

- Quality Management provide a complete testing solution for the Oracle Fusion applications.

- My Oracle Support provides access to software and patches.

2.8.5 Using Cloud Control Help

If you need information about the page or the use cases supported by a particular functionality exposed by the page, then click the Help link on that page at the top of the page. In most cases, the Help window displays a help topic about the current page. Click Contents in the Help window to browse the list of help topics, or click Search to search for a particular word or phrase

2.9 Using Oracle Fusion Functional Setup Manager

Oracle Fusion Functional Setup Manager guides you through the tasks of setting up the functional data and reference data after installation and helps you move the setup data from one environment to another (such as from the development environment to the production environment).

To access the administrative area of Oracle Fusion Functional Setup Manager:

1. Sign in to Oracle Fusion Applications with a user account that is provisioned with the necessary role. Contact your security administrator for details.

2. From the Administration menu in the work area of Oracle Fusion Applications, choose Setup and Maintenance.

The Setup and Maintenance options display:

The following table describes the options in the Tasks pane.

Option

Description

Implementations

Getting Started

Research and review the different offerings or business solutions to determine which fit your requirements.

Configure Offerings

Select options and the related features associated with each offering to dynamically create an implementation task list based on just the functionality you are implementing. This enhances productivity by presenting a targeted list of tasks presented in the appropriate implementation order.

Manage Implementation Projects

Create implementation projects to define the structure of an implementation. They contain task lists and tasks required to implement the functionality you select. Multiple implementation projects may exist within a single instance and may be managed by one or more implementers.

Setup Data Export and Import

Manage Configuration Packages

Create and manage configuration packages. A configuration package is the combined unit of an implementation project and its related setup data. Configuration packages can be exported, imported or uploaded from this page.

Manage Export and Import Processes

Export a configuration package multiple times by creating multiple versions. While the export definition remains the same in each version, the setup data can be different if you modified the data in the time period between the different runs of the export process. Since each version of the configuration package has a snapshot of the data in the source instance, you can compare and analyze various versions of the configuration package to see how the setup data changed.

In the target application instance, the setup import process will insert all new data from the source configuration package that does not already exist and update any existing data with changes from the source. Setup data that exists in the target instance but not in source will remain unchanged.

Implementation Objects

Manage Offerings and Options

Create and maintain offerings and options. Offerings are the highest level grouping of functionality and are the starting points for configuration decisions. Options represent specific pieces of functionality for offerings. The selection of the offerings and options begin to define the task lists and related implementation tasks required to complete an implementation.

Manage Features

Create and maintain features. A feature is a decision point a person evaluates to customize their business needs and processes. Features are the lowest level in this hierarchy: offering, option, feature. Features determine how and to what extent a specific business process is included in an implementation.

Manage Business Processes

Create and maintain business processes, detailed business processes and activities and the relationships within the business process hierarchies.

Manage Task Lists and Tasks

This is the entry point for managing setup task lists and tasks. You can edit tasks or create new ones and edit predecessor tasks. You can also view all occurrences of task lists and tasks and any associated features.

NOTE: This is an entry point for the Authorization Policy Manager (Section 2.6, "Using Oracle Authorization Policy Manager").

Manage Business Objects

Business objects and associated features can be created, edited and deleted from the search dialog.

Topology Objects

Manage Domains

Manage the Oracle WebLogic Server domain in the Oracle Fusion Applications environment.

Manage Enterprise Applications

Register and manage enterprise applications.

Manage Modules

Register and manage modules for enterprise applications.

Topology Registration

Review Topology

Display the topology of the Oracle WebLogic Server domains for the product families.

To review procedures and view demonstrations of the most common procedures:

1. Access the Oracle Fusion Applications Help.

2. In the Search by Functional Setup section, choose Functional Setup Manager and then Manage Application Implementation.

3. In the Manage Application Implementation section, from the Sort By list, choose Help type, as shown in the following figure:

4. Select the topic you want to review.

5. When the topic displays, use the Viewing Options section to either view the procedure in a demonstration or read the steps to perform the task.

For additional information about Oracle Fusion Functional Setup Manager, see Oracle Fusion Functional Setup Manager User's Guide and Oracle Fusion Functional Setup Manager Developer's Guide.

2.10 Caution Against Using Database Tools to Modify Oracle Fusion Applications Data

Do not use SQL*Plus, Oracle Data Browser, database triggers, or any other tool to modify Oracle Fusion Applications data unless otherwise instructed.

Oracle provides powerful tools you can use to create, store, change, retrieve, and maintain information in an Oracle database. But if you use Oracle tools such as SQL*Plus to modify Oracle Fusion Applications data, you risk destroying the integrity of your data and you lose the ability to audit changes to your data.

Because Oracle Fusion Applications tables are interrelated, any change you make using an Oracle Fusion Applications form can update many tables at once. But when you modify Oracle Fusion Applications data using anything other than Oracle Fusion Applications, you may change a row in one table without making corresponding changes in related tables.

If your tables get out of synchronization with each other, you risk retrieving erroneous information and you risk unpredictable results throughout Oracle Fusion Applications.

When you use Oracle Fusion Applications to modify your data, Oracle Fusion Applications automatically checks that your changes are valid. Oracle Fusion Applicationsalso keeps track of who changes information. If you enter information into database tables using database tools, you may store invalid information. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes.

3 Installing and Maintaining Oracle Fusion Applications Languages

This chapter provides an introduction to the tools you use to install and maintain a set of languages in Oracle Fusion Applications.

This chapter includes the following topics:

- Installing and Upgrading Languages

- Pre-Installation Steps - Before Down Time

- Pre-Installation Steps - During Down Time

- Install a Language

- Complete the Post-Installation Tasks

- Troubleshoot Language Pack Installer Sessions

- Maintaining Language Content

3.1 Installing and Upgrading Languages

Oracle Provisioning installs only the English language and Upgrade Orchestrator upgrades only the languages that were previously installed. To add a language, use Language Pack Installer. If patches containing translatable artifacts were previously applied to this environment, you may apply the translated versions of each of those patches after you install the new language.

This section provides an introduction to the following concepts related to language packs:

- Language Packs

- Language Pack Installer

- Language in the Policy Store

- Language Pack Installer Configuration Assistants

3.1.1 Language Packs

A language pack for a given language and release contains artifacts at the specific release level that are translated to the specific language. Translated artifacts include Oracle Fusion Applications seed data that is uploaded into Oracle Fusion Applications database, SOA resource bundles, JEE resource bundles, LDAP data, Diagnostics Test Framework, and BI Presentation Catalog data. You install language packs with Language Pack Installer.

3.1.2 Language Pack Installer

Language Pack Installer enables you to add a language in your Oracle Fusion Applications environment and delivers translated artifacts for that language. You can run Language Pack Installer in GUI mode or silent mode. In GUI mode, you proceed through the installation by providing information in the user interface when prompted. In silent mode, progress is reported to the console.

3.1.2.1 Installer User Interface

Language Pack Installer provide a graphical user interface which allows you to control the behavior of the installer by the use of buttons, in cases where it encounters a failure. Note that the behavior of these buttons may vary, depending on whether it is a configuration assistant, or a step within a configuration assistant, that fails. The behavior also depends on whether a configuration assistant is mandatory. All mandatory configuration assistants must complete successfully before proceeding to the next configuration assistant. For information about which configuration assistants are mandatory, see Section 3.1.4, "Language Pack Installer Configuration Assistants."

You can exit out of the installer in the event of a failure and restart from the point of failure. If a non-mandatory configuration assistant fails, and you continue to the next configuration assistant, you must restart the installer after it finishes the last configuration assistant. When you restart, the installer retries all failed configuration assistants and steps.

An explanation of the usage of each button follows. Note that the buttons are available only in GUI mode, not in silent mode.

3.1.2.1.1 Abort Button

The Abort button allows you to skip a failed configuration assistant or step within a configuration assistant, and records the failure so it can be rerun when you restart the installation. For mandatory configuration assistants, after you abort the configuration assistant, the installer does not proceed and only the Cancel button is enabled. You must then resolve the cause of the failure and start the installer from this failure point. For non-mandatory configuration assistants, the installer proceeds to the next configuration assistant after you abort the configuration assistant. This button is enabled only after a failure.

3.1.2.1.2 Cancel Button

The Cancel button allows you to stop an installer session after the failure of a mandatory action. This button is enabled only after a failure.

3.1.2.1.3 Close Button

The Windows Close button allows you to stop an installer session after a failure. This is enabled only after a failure.

3.1.2.1.4 Continue Button

The Continue button allows you to skip a failed non-mandatory step within any configuration assistant. The installer records the failure and then proceeds with the next step within the configuration assistant. When you rerun this installer session, the failed steps within the configuration assistant are attempted again.

Note that this button is enabled only for non-mandatory steps within a configuration assistant.

3.1.2.1.5 Next Button

The Next button allows you to proceed to the next screen. This button is enabled only when all configuration assistants complete successfully in the current screen.

3.1.2.1.6 Retry Button

The Retry button allows you to attempt to rerun a failed configuration assistant, or a step within a configuration assistant. Use Retry when you know the cause of the failure and can resolve the issue during the current Language Pack Installer session.

3.1.3 Language in the Policy Store

The policy store can maintain attributes in only one language. If you want to override the base English strings in the policy store, you set the -DupdateJAZNPolicyStore option to true when you install the Language Pack. The Description and Displayname are the two attributes which are translatable and are loaded in JAZN files in the language pack.

3.1.4 Language Pack Installer Configuration Assistants

During the installation phase, Language Pack Installer copies all files from the language pack to the appropriate locations, such as Oracle Fusion Middleware home and Oracle Fusion Applications Oracle home. After the file copy is completed, Language Pack Installer calls configuration assistants to perform the remaining tasks required to update and deploy the artifacts included in the language pack. Language Pack Installer supports parallel processing of certain configuration assistants to improve performance. Parallel configuration assistants are organized by groups and all configuration assistants in a group start running at the same time.

If any tasks fail during the installation phase, refer to "Troubleshooting Failures During the Installation Phase" in the Oracle Fusion Applications Upgrade Guide for more information.

All mandatory configuration assistants must complete successfully before proceeding to the next configuration assistant. For more information, see Section 3.6.3, "General Troubleshooting During the Configuration Phase in GUI Mode" and Section 3.6.4, "General Troubleshooting During the Configuration Phase in Silent Mode."

The following table provides list of possible configuration assistants, including steps within the configuration assistants. The Retry Behavior and Troubleshooting column describes what Language Pack Installer does after a configuration assistant fails and you select the Retry button or you restart Language Pack Installer in silent mode. If available, links are provided to relevant troubleshooting sections.

Table 3-1 Configuration Assistants Run by Language Pack Installer

Name

Mandatory

Description

Retry Behavior and Troubleshooting

Activate Language

Yes

Activates the language in the database.

Runs Activate Language again.

Preverification

Yes

Performs the following validation checks:

- Policy Store

- Check for Number of DB Workers

- Database Content Upload

- Taxonomy URL

- Flexfields

- LDAP Data (LDIF)

- SOA Resource Bundle

Runs failed steps.

Synchronize Multilingual Tables

Yes

Runs the Maintain Multilingual Tables utility to maintain the tables related to the newly activated language. For more information, see "Maintaining Multi-lingual Tables" in the Oracle Fusion Applications Patching Guide.

Restart from failure.

Consolidate Repository And Downloaded Patches

Yes

Consolidates patches in the repository and the patches you download in Section 3.2.3, "Download Mandatory Post-Installation NLS Patches".

Starts from the beginning of the task.

Apply Middleware Language Patches

Yes

- Applies Language Repository Patches

- Applies Language Downloaded Patches, as described in Section 3.2.3, "Download Mandatory Post-Installation NLS Patches".

Applies the failed patches. See "Troubleshooting Applying Middleware Patches" in the Oracle Fusion Applications Upgrade Guide.

Load Database Components

Yes

Uploads the database content packaged in the language pack to the database.

Runs failed database commands. See "Troubleshooting Loading Database Components" in the Oracle Fusion Applications Upgrade Guide.

Deploy Applications Policies (jazn-data.xml)

Yes

Performs the deployment of the updated applications policies, based on your selections during the Policy Store Analysis task.

This task runs only if you chose to override the base English strings in the policy store by using the -DupdateJAZNPolicyStore option set to true when you install the language pack.

Deploys the failed stripes. See "Troubleshooting Deployment of Applications Policies" in the Oracle Fusion Applications Upgrade Guide.

Deploy BI Publisher Artifacts

Yes

Using Catalog Manager:

- Backs up BI Presentation Catalog under APPLICATIONS_CONFIG/lcm/admin/version/fapatch/BIP/language_code for example, APPLICATIONS_CONFIG/lcm/admin/11.1.8.0.0/fapatch/BIP/en_US/webcat.zip.

- Backs up captions under APPLICATIONS_CONFIG/lcm/admin/version/fapatch/BIP/language_code/captions.zip.

- Copies captions to the Oracle Business Intelligence repository.

- Deploys BI Presentation Catalog to the Oracle Business Intelligence repository.

Starts from the beginning of the task. See "Troubleshooting Deployment of BI Publisher Artifacts" in the Oracle Fusion Applications Upgrade Guide.

Deploy Flexfields

No

Deploys flexfields to the domain that hosts the FndSetup application.

Starts from the beginning of the task.

Deploy LDAP Data (LDIF)

Yes

Uploads LDIF XLIFF translations to the identity store

Retries failed XLIFF files.

Deploy SOA Resource Bundles

Yes

Deploys SOA Resource Bundles to the corresponding SOA servers.

Deploys failed SOA resource bundles.

Activate SOA Language

Yes

Runs the SOA Human Workflow configuration script to activate the language of the language pack.

Starts from the beginning of the task.

Apply Downloaded Language Patches

Yes

Applies post-installation patches that you downloaded in the 11.1.8.0.0_post_repo_patches directory. See Section 3.2.3, "Download Mandatory Post-Installation NLS Patches".

Applies failed patches.

3.1.4.1 Parallel Configuration Assistants

Language Pack Installer supports parallel processing of certain configuration assistants to improve performance. Parallel configuration assistants are organized by groups and all configuration assistants in a group start running at the same time. The installer proceeds to the next configuration assistant outside of the group, only after all parallel tasks in a group complete successfully.

3.2 Pre-Installation Steps - Before Down Time

This section describes the following preparation steps for installing a language pack, all of which can be performed before your scheduled down time.

- Before You Begin

- Download the Language Pack Repository

- Download Mandatory Post-Installation NLS Patches

- Confirm the Oracle Fusion Applications Installation is Complete

- Confirm Database Settings

- Maintain Versions of Customized BI Publisher Reports

- Run Health Checker for Pre-Down Time Checks

3.2.1 Before You Begin

Before you begin the language pack installation, you should have access to the following documentation:

- Oracle Fusion Applications release notes from the current release.

- Oracle Fusion Applications NLS Release Notes from the current release.

You should also have a clear understanding of the following host and directories:

- Primordial host: The location of the Common domain (specifically the Administration Server of the Common domain). Only one primordial host exists in each environment.

- APPLICATIONS_CONFIG: The top-level directory for the Oracle Fusion Applications configuration files.

- APPLICATIONS_BASE: The top-level directory for the Oracle Fusion Applications binaries.

- FA_ORACLE_HOME: Directory named applications, located under the fusionapps Oracle Fusion Applications Middleware home.

For more information, see Figure 1–3, "Relationship of Home Directories" in the Oracle Fusion Applications Upgrade Guide.

3.2.2 Download the Language Pack Repository

The language pack repository contains the language pack installer, translated Oracle Fusion Middleware patches, and the Oracle Fusion Applications language pack contents that are required to install a language pack for a specific language. You download the repository from the Oracle Fusion Applications Product Media Package to a location of your choice. This directory is referred to as REPOSITORY_LOCATION.

1. Go to http://edelivery.oracle.com/ and follow these instructions:

2. Complete the Export Validation process by entering basic identification information using the online form.

3. On the Media Pack Search page, specify Oracle Fusion Applications as the product pack and then select your platform to identify the media pack you want to download.

4. Choose the appropriate media pack from the search results, such as Release 8 (11.1.8.0.0) for your platform, and download the language pack repository (in zipped format). You can download the repository to a location of your choice. This directory is referred to as REPOSITORY_LOCATION.

5. Extract the contents of all zipped files to the same target directory. The directory must be on a networked drive or shared disk so that it will be accessible to all the hosts in your new environment. The installers are normally located in the installers subdirectory under REPOSITORY_LOCATION.

For more information, see "Obtain the Software" in the Oracle Fusion Applications Installation Guide.

Note:

You should avoid creating the repository in a deeply nested directory on Windows. The Windows PATH variable has a limited size, and long directory names may cause it to overflow. For example, c:\work\my_repository is a better choice than c:\Work\WorkInProgress\FusionApps\FusionAppsv1\Nov2012\tempfiles\my_repository.

The following table lists the installers in the language pack repository.

Table 3-2 Language Pack Installers

Media Label Name

Staging Destination

Language Pack Installer

(UNIX) REPOSITORY_LOCATION/language_code/installers/fusionapps/Disk1/runInstaller

(Windows) REPOSITORY_LOCATION/language_code\installers\fusionapps\Disk1\Setup.exe

or REPOSITORY_LOCATION/language_code\installers\fusionapps\Disk1\install\Win64\Setup.exe

3.2.3 Download Mandatory Post-Installation NLS Patches

Note:

If there are no post-installation patches in the Oracle Fusion Applications NLS Release Notes when you run Language Pack Installer, there is no action required for this step and you can proceed to Section 3.2.4, "Confirm the Oracle Fusion Applications Installation is Complete".

Language Pack Installer can apply mandatory post-installation patches that are required by Oracle Fusion Applications if you download the patches from My Oracle Support before you start the installation. Note that this feature relates only to patches that are documented in the Oracle Fusion Applications NLS Release Notes and that are specifically required for the language pack you are installing.

Perform the following steps to download the patches:

1. Create a directory named 11.1.8.0.0_post_repo_patches in the parent directory of your APPLICATIONS_BASE directory. For example, if APPLICATIONS_BASE is /u01/APPTOP, the patch directory is /u01/11.1.8.0.0_post_repo_patches. For more information about the APPLICATIONS_BASE directory, see Section 3.2.1, "Before You Begin".

2. Copy PostRepoPatchDirs.zip from the REPOSITORY_LOCATION/installerspreinstall directory to the 11.1.8.0.0_post_repo_patches directory.

3. Unzip PostRepoPatchDirs.zip in the 11.1.8.0.0_post_repo_patches directory to create the directory structure for the patches you download.

4. Review the README.txt file that was created when you unzipped REPOSITORY_LOCATION/installers/pre_install/PostRepoPatchDirs.zip, to learn how the subdirectories under the 11.1.8.0.0_post_repo_patches directory map to the corresponding components, such as Oracle Fusion Middleware, database client, and database server components.

Note:

If you choose to download the patches to a different directory, you must use the -DpatchDownloadLocation option when you start Language Pack Installer. See Section 3.4, "Install a Language" for more information.

5. Refer to Oracle Fusion Applications NLS Release Notes, 11g Release 8 (11.1.8) to find the patches to be downloaded from My Oracle Support.
The following table describes the types of patches that you download, their location in the NLS release notes and which configuration assistant applies the patches.

Table 3-3 Mandatory Patches to be Downloaded

Type of Patches

Location in Oracle Fusion Applications NLS Release Notes

Configuration Assistant That Applies Patches

Oracle Fusion Middleware

Upgrade Known Issues, Pre-Upgrade Known Issues, Mandatory Patches to be Downloaded, Oracle Fusion Middleware

Apply Language Middleware Patches

Oracle Fusion Applications

Upgrade Known Issues, Pre-Upgrade Known Issues, Mandatory Patches to be Downloaded, Oracle Fusion Applications

Apply Downloaded Patches

Oracle Fusion Applications Release 8 Installer

Upgrade Known Issues, Pre-Upgrade Known Issues, Mandatory Patches to be Downloaded, Installer

Oracle Fusion Applications Upgrade Installer

6. Download and unzip the patches into the appropriate subdirectory under the 11.1.8.0.0_post_repo_patches directory, based on the mapping information in the README.txt file described in Step 4. A failure could result if you do not download a patch to the correct directory. Note that when you download the Oracle Fusion Applications patches, you must create a patch plan by running the script in Step 7.

7. Run this step to create a patch plan. This step assumes that you have downloaded the patches as described in Step 6.

The perl script, adGenerateFAPatchPlan.pl, reads the patch metadata from the downloaded patches to generate the patch plan file, FAPatchPlan.xml. To run this script, use the Perl executable from APPLICATIONS_BASE/dbclient/perl/bin for UNIX platforms and APPLICATIONS_BASE\dbclient\perl\5.8.3\bin\MSWin32-x64-multi-thread for Windows.

Use the following command syntax to create the patch plan file:

(UNIX)
setenv PERL5LIB $APPLICATIONS_BASE/dbclient/perl/lib/5.8.3:$APPLICATIONS_BASE/dbclient/perl/lib/site_perl/5.8.3/:
$APPLICATIONS_BASE/dbclient/perl/lib/site_perl

$APPLICATIONS_BASE/dbclient/perl/bin/perl
$APPLICATIONS_BASE/fusionapps/applications/lcm/ad/bin/adGenerateFAPatchPlan.pl patches_download_location

(Windows)
SET PERL5LIB=%APPLICATIONS_BASE%\dbclient\perl\5.8.3;%APPLICATIONS_BASE%\dbclient\perl\site\5.8.3\;
%APPLICATIONS_BASE%\dbclient\perl\site

%APPLICATIONS_BASE%\dbclient\perl\5.8.3\bin\MSWin32-x64-multi-thread\perl
%APPLICATIONS_BASE%\fusionapps\applications\lcm\ad\bin\adGenerateFAPatchPlan.pl patches_download_location

3.2.4 Confirm the Oracle Fusion Applications Installation is Complete

If you are installing a language pack on a freshly installed Oracle Fusion Applications environment, ensure that you performed all mandatory tasks described in "Completing Oracle Fusion Applications Post-Installation Tasks" in the Oracle Fusion Applications Installation Guide.

If you are installing a language pack on an upgraded environment, ensure that you completed all tasks described in "Post-Upgrade Tasks for Oracle Fusion Applications" in the Oracle Fusion Applications Upgrade Guide.

In either case, you must also perform the steps in the "Post-Installation" section of Technical Release Notes for Oracle Fusion Applications 11g Release 8 (11.1.8.0.0).

3.2.5 Confirm Database Settings

Refer to Oracle Fusion Applications release notes for information about database tuning parameters, to verify that your database and Sql*Net tuning parameters are set properly to avoid time-out errors during the installation.

3.2.6 Maintain Versions of Customized BI Publisher Reports

Ensure that you have your own versions of any customized BI Publisher reports. If a language pack includes an update to a catalog object that was delivered with an Oracle Fusion application, the patch will overwrite any customizations applied to the original report.

Related Link

The following document provides additional information related to subjects discussed in this section:

- For more information, see "Before You Begin Customizing Reports" in the Oracle Fusion Applications Extensibility Guide.

3.2.7 Run Health Checker for Pre-Down Time Checks

You must run Health Checker directly from APPLICATIONS_BASE and from the primordial host. You can run these checks any number of times prior to your down time. For information about the checks that Health Checker runs, see "Language Pack Readiness Health Checks" in the Oracle Fusion Applications Upgrade Guide.

Perform the following steps to run Health Checker:

1. Set the APPLICATIONS_BASE and REPOSITORY_LOCATION environment variables. Set the APPLICATIONS_BASE environment variable to point to the directory that contains Oracle Fusion Applications. For example, if Oracle Fusion Applications is installed in /server01/APPTOP/fusionapps, then set the APPLICATIONS_BASE environment variable to /server01/APPTOP. Set the REPOSITORY_LOCATION environment variable to point to the root directory where the Language Pack repository is staged. You created this directory in Section 3.2.2, "Download the Language Pack Repository."

Examples follow:

(UNIX)
setenv APPLICATIONS_BASE /server01/APPTOP/
setenv REPOSITORY_LOCATION /server01/REL8Repo/

(Windows)
SET APPLICATIONS_BASE=\server01\APPTOP\
SET REPOSITORY_LOCATION=\server01\REL8Repo\

2. Run Health Checker. Note that this is one command.

(UNIX)
$APPLICATIONS_BASE/fusionapps/applications/lcm/hc/bin/hcplug.sh -manifest
$APPLICATIONS_BASE/fusionapps/applications/lcm/hc/config/LanguagePackReadinessHealthChecks.xml [-DlogLevel=log_level]

(Windows)
%APPLICATIONS_BASE%\fusionapps\applications\lcm\hc\bin\hcplug.cmd -manifest
%APPLICATIONS_BASE%\fusionapps\applications\lcm\hc\config\LanguagePackReadinessHealthChecks.xml [-DlogLevel=log_level]

Review the Health Checker log file or the HTML summary report to see if any errors occurred that require corrective action. The log file and the HTML summary are located in APPLICATIONS_CONFIG/lcm/logs/release_version/healthchecker.

After you resolve the issue that caused the error, start Health Checker again to run the failed tasks. You must rerun Health Checker until there are no more failed tasks.

3.3 Pre-Installation Steps - During Down Time

This section describes the following mandatory preparation steps for installing a language pack, all of which must be performed during your system down time. Language Pack Installer does not require any servers to be shut down. However, no users should be online, so it is still considered to be down time.

- Run Health Checker for General System Health Checks

- Back Up Oracle Fusion Applications

- Apply Mandatory Prerequisite Patches

3.3.1 Run Health Checker for General System Health Checks

You must run Health Checker directly from APPLICATIONS_BASE and from the primordial host. For information about the checks that Health Checker runs, see "General System Health Checks" in the Oracle Fusion Applications Upgrade Guide.

Perform the following steps to run Health Checker:

1. Set the APPLICATIONS_BASE and REPOSITORY_LOCATION environment variables. For more information, see Step 1 in Section 3.2.7, "Run Health Checker for Pre-Down Time Checks".

Note:

Set this environment variable on all hosts that share the same APPLICATIONS_BASE before executing all tools and utilities mentioned in this guide.

2. Run Health Checker. Note that this is one command.

(UNIX)
$APPLICATIONS_BASE/fusionapps/applications/lcm/hc/bin/hcplug.sh -manifest
$APPLICATIONS_BASE/fusionapps/applications/lcm/hc/config/GeneralSystemHealthChecks.xml [-DlogLevel=log_level]

(Windows)
%APPLICATIONS_BASE%\fusionapps\applications\lcm\hc\bin\hcplug.cmd -manifest
%APPLICATIONS_BASE%\fusionapps\applications\lcm\hc\config\GeneralSystemHealthChecks.xml [-DlogLevel=log_level]

Review the Health Checker log file or the HTML summary report to see if any errors occurred that require corrective action. The log file and the HTML summary are located in APPLICATIONS_CONFIG/lcm/logs/release_version/healthchecker.

After you resolve the issue that caused the error, start Health Checker again to run the failed tasks. You must rerun Health Checker until there are no more failed tasks.

3.3.2 Back Up Oracle Fusion Applications

Back up your entire Oracle Fusion Applications environment by following the steps in Chapter 15, "Backing Up and Recovering Oracle Fusion Applications." You should also back up your central inventory.

For additional back up steps that are specific to Windows, refer to Section 3.3.2.1, "Back Up Steps for Windows Platforms".

3.3.2.1 Back Up Steps for Windows Platforms

Back up the Oracle Fusion Applications environment, including APPLICATIONS_BASE, inventory, registry entries, Oracle Identity Management, the database and the System environment PATH variable of the Oracle Fusion Applications host machine.

1. APPLICATIONS_BASE contains many files whose path is more than 256 characters. The Microsoft Windows Copy function is limited to copying only those files with a path of less than 256 characters. Therefore, many files fail to copy.
Use Robust File Copy (Robocopy), which is available as part of the Windows Resource Kit, to copy APPLICATIONS_BASE. Use the following command:

robocopy <source> <destination> /MIR > <file>

Sample output from the robocopy command follows:

Total

Copied

Skipped

Mismatch

FAILED

Extras

Dirs:

112640

112640

0

0

0

Files:

787114

787114

0

0

0

Bytes:

63.822 g

63.822 g

0

0

0

Times:

2:22:20

2:19:00

0:00:00

0:03:19

2. Back up the inventory.
Back up the inventory location referenced in the registry HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\inst_loc.

3. Back up the registry.
Use Regedit.exe to back up the following registries related to Oracle Fusion Applications.

- HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services

- Web Tier service

- BI Service

- Node Manager service

- HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE

- HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Oblix

4. Ensure that the System PATH has the following values:

C:\<APPLICATIONS_BASE>\dbclient\bin
C:\<APPLICATIONS_BASE>\webtier_mwhome\webtier\bin
C:\<APPLICATIONS_BASE>\webtier_mwhome\webtier\\bin
C:\<APPLICATIONS_BASE>\webtier_mwhome\webtier\opmn\lib
C:\<APPLICATIONS_BASE>\webtier_mwhome\webtier\perl\bin
C:\<APPLICATIONS_BASE>\fusionapps\bi\products\Essbase\EssbaseServer\bin
C:\<APPLICATIONS_BASE>\fusionapps\bi\bin
C:\<APPLICATIONS_BASE>\fusionapps\bi\opmn\bin
C:\<APPLICATIONS_BASE>\fusionapps\bi\opmn\lib
C:\<APPLICATIONS_BASE>\fusionapps\bi\perl\bin

Add any of the previous values that are missing to the system PATH. Missing values cause failures in launching the OPMN services and BI Presentation Catalog deployment configuration assistants in Language Pack Installer.

5. Save the system PATH variable.

3.3.3 Apply Mandatory Prerequisite Patches

Download and apply any prerequisite patches listed in the Post-Installation and Post-Upgrade sections of Oracle Fusion Applications release notes prior to starting Language Pack Installer. Note that the only patches that need to be applied are those that have been added to the release notes since the last time you applied patches from this list.

3.4 Install a Language

Language Pack Installer does not require any servers to be shut down. However, no users should be online, so it is still considered to be down time. Oracle recommends that language packs be installed from a machine that is co-located in the same subnetwork as the database server to maximize performance. You must run Language Pack Installer on the primordial host. Primordial host is defined in Section 3.2.1, "Before You Begin".

Ensure that the steps in Section 3.2, "Pre-Installation Steps - Before Down Time" and Section 3.3, "Pre-Installation Steps - During Down Time" are successfully completed before you start Language Pack Installer.

Language Pack Installer supports GUI mode and silent mode. In GUI mode, you navigate through screens that display the progress of the upgrade, including log file locations and status messages. In silent mode, Language Pack Installer reports the progress of the upgrade as console output.

- Run Language Pack Installer in GUI Mode

- Run Language Pack Installer in Silent Mode

Note:

If Language Pack Installer encounter errors, refer to Section 3.6, "Troubleshoot Language Pack Installer Sessions" before clicking any buttons in the Language Pack Installer user interface.

3.4.1 Run Language Pack Installer in GUI Mode

Perform the following steps to run Language Pack Installer in GUI mode from the command line, using specific options to further define the necessary actions. You must run Language Pack Installer from the primordial host.

1. Set the JAVA_HOME environment variable as follows:

(UNIX) setenv JAVA_HOME APPLICATIONS_BASE/fusionapps/jdk6

(Windows) set JAVA_HOME=APPLICATIONS_BASE\fusionapps\jdk6

2. Confirm registration of the network location of FA_ORACLE_HOME.
If the Oracle Fusion Applications Oracle home directory (FA_ORACLE_HOME), which is APPLICATIONS_BASE/fusionapps/applications, is registered in the central inventory with a /net path, then provide the oraInst.loc location including /net when starting Language Pack Installer. An example follows:

(UNIX only)
$REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -jreLoc APPLICATIONS_BASE/fusionapps/jdk6/
-invPtrLoc /net/APPLICATIONS_BASE/fusionapps/applications/oraInst.loc

If not triggered with a /net path, Language Pack Installer copies the -invPtrLoc file to FA_ORACLE_HOME. This results in a copy of the file to itself, which then becomes an empty or zero byte file. As a result, the copy phase will fail when oracle_common patches are applied. For more information, see "Inventory Pointer File is Empty" in the Oracle Fusion Applications Upgrade Guide.

3. Run the following command to start Language Pack Installer in GUI mode.

(UNIX) $REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -addLangs -jreLoc APPLICATIONS_BASE/fusionapps/jdk6
[-invPtrLoc FA_ORACLE_HOME/oraInst.loc]
-noCheckForUpdates OR -updatesDir installer_patch_directory
[-DpatchStageLocation=directory_location_of_patch_stage
[-Dworkers=number_of_workers][-DlogLevel=level]
[-DserverStartTimeout=timeout_period_for_server_in_seconds]
[-DpatchDownloadLocation=patch_directory][-debug]
[-DupdateJAZNPolicyStore=true]

(Windows) %REPOSITORY_LOCATION%\installers\fusionapps\Disk1\setup.exe -addLangs -jreLoc APPLICATIONS_BASE\fusionapps\jdk6
-noCheckForUpdates OR -updatesDir installer_patch_directory
[-DpatchStageLocation=directory_location_of_patch_stage
[-Dworkers=number_of_workers][-DlogLevel=level]
[-DserverStartTimeout=timeout_period_for_server_in_seconds]
[-DpatchDownloadLocation=patch_directory][-debug]
[-DupdateJAZNPolicyStore=true]

The following table shows valid options that can be used when running Language Pack Installer.

Table 3-4 Language Pack Installer Command Line Options

Option Name

Description

Mandatory

-addLangs

Runs Language Pack Installer to install one language.

Yes

-jreLoc

Path where the Java Runtime Environment is installed. This option does not support relative paths, so you must specify the absolute path.

Yes

-noCheckForUpdates

Skips the application of the installer update patch, if there is no installer update patch available for this release.

No, this option cannot be used if the -updatesDir option is used. Either -noCheckForUpdates or -updatesDir must be used.

-updatesDir

The location of the installer update patch. When a valid installer patch is found, the installer automatically restarts itself after applying the patch.

No, this option cannot be used if the -noCheckForUpdates option is used. Either -noCheckForUpdates or -updatesDir must be used.

-DpatchStageLocation

Location of patch stage. This is the directory where Middleware patches from a downloaded location, as well as the repository, are consolidated before applying.

No, the default directory is APPLICATIONS_BASE/../patch_stage. For example, if APPLICATIONS_BASE is /u01/APPLTOP, the patch stage directory is /u01/patch_stage.

-invPtrLoc

(UNIX platforms only)

The location of an overriding inventory pointer file. If the Oracle Fusion Applications Oracle home directory (FA_ORACLE_HOME), is registered in inventory with a /net path, then provide the location of oraInst.loc including /net in the path.

Recommended, use to override the default location of the inventory pointer file, located in /etc/oraInst.loc.

-Dworkers

The number of workers to use for uploading database content. If you provide a value for the number of workers that is outside the calculated range, you are prompted to provide a value that is within the optimal range. If you do not use this option, a calculated optimal value is used.

No, overrides the default number of workers calculated by Language Pack Installer.

-DserverStartTimeout

Configures the timeout value for server in seconds.

No, overrides the default value for server timeout.

-DpatchDownloadLocation

The directory path where you downloaded mandatory prerequisite patches to be applied by Language Pack Installer. See Section 3.2.3, "Download Mandatory Post-Installation NLS Patches".

No, the default is 11.1.8.0.0_post_repo_patches.

-DlogLevel

Records messages in the log file at the level you specify. Enter a value to override the default log level of INFO.

No, the default value is INFO.

-DupdateJAZNPolicyStore=true

Updates the policy store with translated attributes so field descriptions, display names, and other attributes display their translated values.

No, use only when you do not want to use base English in the policy store.

-debug

Retrieve debug information from Language Pack Installer.

No.

Example 3-1 Language Pack Installation with no policy store translation

(UNIX) $REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -addLangs
-jreLoc APPLICATIONS_BASE/fusionapps/jdk6
-invPtrLoc FA_ORACLE_HOME/oraInst.loc
-noCheckForUpdates OR -updatesDir installer_patch_directory

(Windows) %REPOSITORY_LOCATION%\installers\fusionapps\Disk1\setup.exe -addLangs
-jreLoc APPLICATIONS_BASE\fusionapps\jdk6
-noCheckForUpdates OR -updatesDir installer_patch_directory

Example 3-2 Language Pack Installation with policy store translation

(UNIX) $REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -addLangs
-jreLoc APPLICATIONS_BASE/fusionapps/jdk6
-invPtrLoc FA_ORACLE_HOME/oraInst.loc -DupdateJAZNPolicyStore=true
-noCheckForUpdates OR -updatesDir installer_patch_directory

(Windows) %REPOSITORY_LOCATION%\installers\fusionapps\Disk1\setup.exe -addLangs
-jreLoc APPLICATIONS_BASE\fusionapps\jdk6 -DupdateJAZNPolicyStore=true
-noCheckForUpdates OR -updatesDir installer_patch_directory

Example 3-3 Language Pack installation when FA_ORACLE_HOME is registered with a /net path

(UNIX) $REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -addLangs
-jreLoc APPLICATIONS_BASE/fusionapps/jdk6
-invPtrLoc /net/APPLICATIONS_BASE/fusionapps/applications/oraInst.loc
-noCheckForUpdates OR -updatesDir installer_patch_directory

The following table illustrates the tasks that Language Pack Installer runs. For information about log files and troubleshooting Language Pack Installer errors, see Section 3.6, "Troubleshoot Language Pack Installer Sessions".

Table 3-5 Language Pack Installer Screen Sequence

Screen

Description and Action Required

Welcome

Appears when you start Language Pack Installer. This screen does not appear if you restart Language Pack Installer after a failure. The standard Welcome screen is read-only. It contains a navigation pane on the left-hand side that summarizes the tasks the installer will take. Each item in the pane represents an installer screen, which contains prompts for the necessary information.

Click Next to continue.

Install Software Updates

Appears when you start Language Pack Installer. This screen does not appear if you supplied the -noCheckForUpdates option, or after the installer restarts itself automatically after applying an installer patch. The screen displays two options:

- Skip applying the installer update

- Search Local Directory for Updates

Select Search Local Directory for Updates. Specify the correct Installer update patch location or click Browse to locate the file. Then click Search for Updates to display the patch number and the type of patch.

Click Next to continue.

Installation Location

Specify the location of the existing Oracle Fusion Applications home (FA_ORACLE_HOME) where you want to install the language.

Click Next to continue.

Installation Summary

Summarizes the selections you made during this installation session. It includes the Oracle home, required and available disk space, and the language to be installed. Review the information displayed to ensure that the installation details are what you intend.

To make changes before installing, click Back to return to previous screens in the interview.

Click Install to start installing this language.

Installation Progress

Displays a progress indicator that shows the percentage of the installation phase that is complete and indicates the location of the installation log file. The installation phase consists of copying files from the language pack to the appropriate Oracle homes.

When the installation progress indicator shows 100 percent, click Next to continue.

Policy Store Analysis

(Note that this screen displays only when the -DupdateJAZNPolicyStore option is set to true when you start Language Pack Installer.)

Analysis is available for the following policy store stripes: hcm, crm, fscm, soa, ucm, bpm, and obi. Select the stripes to be analyzed and then click Run Analysis to identify any conflicts or deletions. Only the stripes that are included in the language pack are enabled for analysis and the analysis could run for several minutes. After the analysis runs, review the results of the analysis to determine which deployment method you want Language Pack Installer to use for policy store changes to each stripe. Oracle recommends that you select Apply safe changes only. This is the safest method unless you have read and totally understood the consequences of the other three options. If you decide to resolve the conflicts or deletions before the actual JAZN upload from Language Pack Installer, you should run the Policy Store Analysis step again to get the most accurate analysis report. The choices for deployment method are:

- Apply safe changes only (choose this method if there are no conflicts)

- Apply all changes and overwrite customizations (not available for soa, ucm, and bpm stripes)

- Append additive changes

- Manually resolve conflicts and upload changes using Authorization Policy Manager.

If you choose Apply safe changes only or Append additive changes, then you must review the results of the analysis to manually upload any changes not applied by Language Pack Installer with the choice you selected, after the installation is complete. If you choose Apply all changes and overwrite customizations, then you may need to reapply the customizations that are overwritten after the installation is complete. If you choose one of these options, click Next after you make your selection.

If you choose Manually resolve conflicts and upload changes using Authorization Policy Manager (APM), you must pause the installation while you bring up the APM application and upload the changes. For more information, see Section 5.3.2, "Upgrading Fusion Application Policies." Note the location of the following files:

- Baseline file: FA_ORACLE_HOME/admin/JAZN/stripe/baseline

- Patch file for fscm, crm, and hcm stripes: FA_ORACLE_HOME/stripe/deploy/system-jazn-data.xml

- Patch file for obi, soa, ucm, and bpm stripes: FA_ORACLE_HOME/com/acr/security/jazn/bip_jazn-data.xml

When you complete this task in APM, shut down the APM application, return to Language Pack Installer, and click Next.

Configuration Progress

Displays a progress indicator that shows the percentage of the configuration phase that is complete. It displays each configuration assistant in the message pane as it is performed. Configuration assistants that could be included in the configuration phase are described in Section 3.1.4, "Language Pack Installer Configuration Assistants".

No additional user action is required in the Configuration Progress screen unless a failure occurs. For more information, see Section 3.6.3, "General Troubleshooting During the Configuration Phase in GUI Mode". Links to troubleshooting specific failures are available in Table 3-1.

Installation Complete

Summarizes the installation just completed. If you want to save this configuration to a response file, click Save.

To complete a successful installation, click Finish. The Finish button is activated only if all mandatory configuration assistants completed successfully. If you want to rerun this session after you resolve failed configuration assistants, click Cancel.

4. Proceed to Section 3.5, "Complete the Post-Installation Tasks".

3.4.2 Run Language Pack Installer in Silent Mode

Perform the following steps to start Language Pack Installer in silent mode from the command line, using specific options to further define the necessary actions. You must run Language Pack Installer from the primordial host.

1. Create a response file named silent.rsp to be used in silent mode. This file can be located in any directory that is accessible while launching Language Pack Installer. An example follows:

ORACLE_HOME=/u01/APPLTOP/fusionapps/applications
CRM_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY
FSCM_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY
HCM_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY
OBI_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY
UCM_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY
BPM_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY
SOA_SELECTED_JAZN_MIGRATION_TYPE=PATCH_POLICY

Note:

The stripe_SELECTED_JAZN_MIGRATION_TYPE properties allow you to choose which deployment method Language Pack Installer will use for policy store changes to each stripe. The following choices are available:

- PATCH_POLICY: Apply safe changes only. This is the recommended method. Choose this method if there are no conflicts.

- MIGRATE_POLICY_OVERRIDE: Apply all changes and overwrite customizations.

- MIGRATE_POLICY_NO_OVERRIDE: Append additive changes.

- MIGRATE_POLICY_APM: Manually resolve conflicts and upload changes using Authorization Policy Manager (APM).

If you choose PATCH_POLICY or MIGRATE_POLICY_NO_OVERRIDE, then you must review the results of the analysis to manually upload any changes not applied by Language Pack Installer, based on the choice you selected, after the upgrade is complete. If you choose MIGRATE_POLICY_OVERRIDE, then you may need to reapply the customizations that are overwritten after the upgrade is complete.

If you choose MIGRATE_POLICY_APM, you must pause the upgrade while you bring up the APM application and upload the changes. For more information, see Section 5.3.2, "Upgrading Fusion Application Policies." Note the location of the following files:

- Baseline file: FA_ORACLE_HOME/admin/JAZN/stripe/baseline

- Patch file for fscm, crm, and hcm stripes: FA_ORACLE_HOME/stripe/deploy/system-jazn-data.xml

- Patch file for the obi, ucm, bpm, and soa stripes: FA_ORACLE_HOME/com/acr/security/jazn/bip_jazn-data.xml

2. Set the JAVA_HOME environment variable as follows:

(UNIX) setenv JAVA_HOME APPLICATIONS_BASE/fusionapps/jdk6

(Windows) set JAVA_HOME=APPLICATIONS_BASE\fusionapps\jdk6

3. Confirm the registration of the network location of FA_ORACLE_HOME.
If the Oracle Fusion Applications Oracle home directory (FA_ORACLE_HOME), which is APPLICATIONS_BASE/fusionapps/applications, is registered in the central inventory with a /net path, then provide the oraInst.loc location including /net when starting Language Pack Installer. An example follows:

$REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -addLangs -jreLoc APPLICATIONS_BASE/fusionapps/jdk6/
-invPtrLoc /net/APPLICATIONS_BASE/fusionapps/applications/oraInst.loc -silent -response location_of_response_file

If not triggered with /net path, Language Pack Installer copies the -invPtrLoc file to FA_ORACLE_HOME. In the example, this results in a copy of the file to itself, which then becomes an empty or zero byte file. As a result, the copy phase will fail when oracle_common patches are applied. For more information, see "Inventory Pointer File is Empty" in the Oracle Fusion Applications Upgrade Guide.

4. Run the following command to start Language Pack Installer in silent mode:

Note:

If Language Pack Installer encounters errors in silent mode during the first installer, it terminates the session. You must resolve the issue that caused the failure and then restart Language Pack Installer, using the same command you used previously. Language Pack Installer then restarts from the first failed task. For more information, see Section 3.6.4, "General Troubleshooting During the Configuration Phase in Silent Mode".

(UNIX) $REPOSITORY_LOCATION/installers/fusionapps/Disk1/runInstaller -addLangs -jreLoc
APPLICATIONS_BASE/fusionapps/jdk6 [-invPtrLoc FA_ORACLE_HOME/oraInst.loc] -silent
-response location_of_silent.rsp_file
-noCheckForUpdates OR -updatesDir installer_patch_directory
[-DpatchStageLocation=directory_location_of_patch_stage
[-Dworkers=number_of_workers][-DlogLevel=level]
[-DserverStartTimeout=timeout_period_for_server_in_seconds]
[-DpatchDownloadLocation=patch_directory][-debug]

(Windows)
%REPOSITORY_LOCATION%\installers\fusionapps\Disk1\setup.exe -addLangs -jreLoc
APPLICATIONS_BASE\fusionapps\jdk6 [-Dworkers=number_of_workers][-DlogLevel=level] -silent
-response location_of_silent.rsp_file
-noCheckForUpdates OR -updatesDir installer_patch_directory
[-DpatchStageLocation=directory_location_of_patch_stage
[-DpatchDownloadLocation=patch_directory]
[-DserverStartTimeout=timeout_period_for_server_in_seconds]
[-debug]

The following table shows valid options that can be used when running Language Pack Installer in silent mode.

Table 3-6 Language Pack Installer Command Options in Silent Mode

Option Name

Description

Mandatory

-addLangs

Runs Language Pack Installer to install one language.

Yes.

-jreLoc

Path where the Java Runtime Environment is installed. This option does not support relative paths, so you must specify the absolute path.

Yes.

-invPtrLoc

(UNIX platforms only)

The location of an overriding inventory pointer file. If the Oracle Fusion Applications Oracle home directory (FA_ORACLE_HOME) is registered in inventory with a /net path, then provide the location of oraInst.loc including /net in the path.

Recommended, use to override the default location of the inventory pointer file, located in /etc/oraInst.loc.

-silent

Run Language Pack Installer in silent mode.

Yes.

-response

The location of the response file, silent.rsp.

Yes.

-noCheckForUpdates

Skips the application of the installer update patch, if there is no installer update patch available for this release.

No, this option cannot be used if the -updatesDir option is used. Either -noCheckForUpdates or -updatesDir must be used.

-updatesDir

The location of the installer update patch. When a valid installer patch is found, the installer automatically restarts itself after applying the patch.

No, this option cannot be used if the -noCheckForUpdates option is used. Either -noCheckForUpdates or -updatesDir must be used.

-DpatchStageLocation

Location of patch stage. This is the directory where Middleware patches from a downloaded location, as well as the repository, are consolidated before applying.

No, the default directory is APPLICATIONS_BASE/../patch_stage. For example, if APPLICATIONS_BASE is /u01/APPLTOP, the patch stage directory is /u01/patch_stage.

-DupdateJAZNPolicyStore=true

Updates the policy store with translated attributes so field descriptions, display names, and other attributes display their translated values.

No, use only when you do not want to use base English in the policy store.

-Dworkers

The number of workers to use for uploading database content. If you provide a value for the number of workers that is outside the calculated range, you are prompted to provide a value that is within the optimal range. If you do not use this option, a calculated optimal value is used.

No, overrides the default number of workers calculated by Language Pack Installer.

-DserverStartTimeout

Configures the timeout value for server in seconds.

No, overrides the default value for server timeout.

-DpatchDownloadLocation

The directory path where you downloaded mandatory prerequisite patches to be applied by Language Pack Installer. See Section 3.2.3, "Download Mandatory Post-Installation NLS Patches".

No, the default is 11.1.8.0.0_post_repo_patches.

-DlogLevel

Records messages in the log file at the level you specify. Enter a value to override the default log level of INFO.

No, default value is INFO.

-debug

Retrieve debug information from Language Pack Installer.

No.

5. Proceed to Section 3.5, "Complete the Post-Installation Tasks".

3.5 Complete the Post-Installation Tasks

Perform the following required manual steps after Language Pack Installer completes successfully:

- Confirm Database Artifact Deployments Were Successful

- Review Log Files for Errors or Exceptions

- Run Health Checker for Post Installation Checks

- Bounce All Servers and Verify the Status of Deployed Applications

- Reload Custom Templates for BI Publisher Reports

- Perform Steps in NLS Release Notes

3.5.1 Confirm Database Artifact Deployments Were Successful

Confirm that all database artifact deployments were successful by reviewing the Diagnostics report and log files. For more information, see "Diagnostics Report" in the Oracle Fusion Applications Patching Guide.

3.5.2 Review Log Files for Errors or Exceptions

Confirm there are no unresolved errors or exceptions in the log files. For information about resolving errors, see Section 3.6, "Troubleshoot Language Pack Installer Sessions".

3.5.3 Run Health Checker for Post Installation Checks

Run Health Checker to perform post installation checks directly from APPLICATIONS_BASE and from the primordial host by performing the following steps. For information about the checks that Health Checker runs, see "Post-Upgrade Tasks Performed by Health Checker" in the Oracle Fusion Applications Upgrade Guide.

1. Set the APPLICATIONS_BASE and REPOSITORY_LOCATION environment variables. For more information, see Step 1 in Section 3.2.7, "Run Health Checker for Pre-Down Time Checks".

2. Run Health Checker.

(UNIX)
$APPLICATIONS_BASE/fusionapps/applications/lcm/hc/bin/hcplug.sh -manifest
$APPLICATIONS_BASE/fusionapps/applications/lcm/hc/config/PostLanguagePackHealthChecks.xml
[-DlogLevel=log_level]

(Windows)
%APPLICATIONS_BASE%\fusionapps\applications\lcm\hc\bin\hcplug.cmd -manifest
%APPLICATIONS_BASE%\fusionapps\applications\lcm\hc\config\PostLanguagePackHealthChecks.xml
[-DlogLevel=log_level]

Review the Health Checker log file or the HTML summary report to see if any errors occurred that require corrective action. The log file and the HTML summary are located in APPLICATIONS_CONFIG/lcm/logs/release_version/healthchecker.

After you resolve the issue that caused the error, start Health Checker again to run the failed tasks. You must rerun Health Checker until there are no more failed tasks. If the JAZN Conflicts check fails, refer to Section 3.6.10, "Resolve JAZN Conflicts Found by Health Checker".

3.5.4 Bounce All Servers and Verify the Status of Deployed Applications

1. Bounce all servers using the fastarstop script "bounce" option. For more information, see Section 4.4.2.1, "fastartstop Syntax" and Section 4.4.2.2.1, "Starting Examples with fastartstop."

Note:

If you are installing more than one language in an environment, you need to bounce servers only once at the end of installing all languages in that environment, to minimize time spent bouncing servers.

2. Verify that all deployed applications are up and running. You can check this from Fusion Applications Control, or by reviewing the server side log files. For more information, see Section 2.5.2, "Accessing Fusion Applications Control" or Table 3-7, "Log Directories for Language Pack Installer Activities".

3.5.5 Reload Custom Templates for BI Publisher Reports

Follow this step if you have customized BI Publisher reports.

Reload custom templates for BI Publisher reports on Oracle-delivered BI Publisher reports.

3.5.6 Perform Steps in NLS Release Notes

Perform any steps listed in the Post-Installation Tasks section of NLS Release Notes.

3.6 Troubleshoot Language Pack Installer Sessions

This section the following topics related to troubleshooting Language Pack Installer sessions.

- Log Directories for Language Pack Installer Tasks

- Troubleshooting Failures During the Installation Phase

- General Troubleshooting During the Configuration Phase in GUI Mode

- Recovering From a Language Pack Installer Session That Was Shut Down

- Troubleshooting Applying Middleware Patches

- Troubleshooting Loading Database Components

- Troubleshooting Deployment of Applications Policies

- Troubleshooting Deployment of BI Publisher Artifacts

- Resolve JAZN Conflicts Found by Health Checker

- Installer Requirement Checks Fail

- Language Pack Installer Fails Due To Thread Calls

3.6.1 Log Directories for Language Pack Installer Tasks

The following table provides a list of log directories for Language Pack Installer tasks.

Table 3-7 Log Directories for Language Pack Installer Activities

Log directory name

Description

APPLICATIONS_BASE/oraInstall_timestamp/log

Installation phase logs

APPLICATIONS_CONFIG/lcm/logs/11.1.8.0.0/LanguagePack/language

Top level directory for Language Pack Installer logs

APPLICATIONS_CONFIG/lcm/logs/11.1.8.0.0/LanguagePack/language/configlogs

Top level log directory for configuration assistants. A log file exists for each configuration assistant.

APPLICATIONS_CONFIG/lcm/logs/11.1.8.0.0/LanguagePack/language/PatchManager_DBPatch

Log directory for the Loading Database Components configuration assistant

APPLICATIONS_CONFIG/lcm/logs/11.1.8.0.0/LanguagePack/language/PatchManager_ActivateLanguage

Log directory for the Activate Language configuration assistant

APPLICATIONS_CONFIG/lcm/logs/11.1.8.0.0/LanguagePack/language/PatchManager_DownloadedPatches directory contains the following fapmgr multi-apply logs:

- FAPMgr_Multiapply_apply_timestamp.log

- FAPMgr_Multiapply_DiagnosticsSummary_timestamp.html

- FAPMgr_Multiapply_DiagnosticsSummary_timestamp.xml

Log directory for the Apply Downloaded Language Patches configuration assistant

APPLICATIONS_CONFIG/lcm/logs/11.1.8.0.0/LanguagePack/language/soalogs

Log files from SOA Composite activities

Note that SOA server logs are located under respective domains. For example, the SOA server logs for Common Domain are under APPLICATIONS_CONFIG/domains/hostname/CommonDomain/servers/soa_server1/logs. For more information, see "SOA Composite Log Files" in the Oracle Fusion Applications Upgrade Guide.

3.6.2 Troubleshooting Failures During the Installation Phase

For information regarding troubleshooting failures during the Language Pack Installation phase, see "Troubleshooting Failures During the Installation Phase" in the Oracle Fusion Applications Upgrade Guide.

3.6.3 General Troubleshooting During the Configuration Phase in GUI Mode

This section describes the following troubleshooting scenarios:

- Restart a Failed Installer Session

- Troubleshoot Failures While Parallel Tasks Are Running

- The Next Button Is Not Enabled During Configuration Assistants

- The OPSS Security Store Goes Down While the Installer is Running

- Failure During Opening of Wallet Based Credential Store

- Error While Loading Database Components in GUI Mode

3.6.3.1 Restart a Failed Installer Session

The installer can be restarted to rerun all failed configuration assistants as well as those configuration assistants that were not started from the previous session. When a configuration assistant or step fails, the Configuration Progress screen displays the location of the log file and the exception that caused the failure. You can also view the content of the log files that appear at the bottom of the screen to obtain detailed information to assist in diagnosing the cause of the failure.

If one or more failures occur during the configuration phase, after the final configuration assistant is complete, the following message displays:

Configuration is completed with errors, exit the installer by clicking the 'Cancel' button and retry the failed configurations.

Perform the following steps to rerun the installer and retry the failed configuration assistants:

1. Click Cancel to exit the installer.

2. Resolve the issues that caused the failure.

3. Start the installer using the same command syntax that you used for the previous incomplete installation.

4. A pop up dialog displays, asking if you want to continue the previous incomplete installation. Select Yes to continue running the previous session. If you select No, the installer starts from the beginning and it will fail, indicating that a release cannot be installed again in the same environment. You would then need to restore from your backup and restart the installer.

5. The Configuration Progress screen displays only the failed and remaining configuration assistants, and then runs these configuration assistants.

6. Assuming all configuration assistants complete successfully, click Next to go to the Installation Complete screen and then click Finish to end the session. If a configuration assistant fails again and you want to attempt to run the session again, click Cancel to save the session. If all configuration assistants were successful for the first installer, the second installer launches automatically. If all configuration assistants completed successfully, click Finish to end the session.
Note that Language Pack runs only one installer.

3.6.3.2 Troubleshoot Failures While Parallel Tasks Are Running

If one or more tasks in a group fail, you can select the failed tasks in any combination, and the Abort, Retry, and Continue buttons are enabled as appropriate for the selected tasks. For example, if two tasks in a group fail, and the first task allows you to select Continue, but the other task does not, then the Continue button is not enabled if you select both tasks.

You can process one or more failed tasks at a time. For example, if three tasks fail, you can retry one of them, and while it is running, you can abort the second task. Then you can retry the third task. When the first and third tasks finish processing, the next step depends on whether the second task is mandatory. If it is a mandatory task, the installer stops, and if it is non-mandatory the installer continues with the next task after the group. You can also pick two out of three or all three tasks and select Retry, Abort, or Continue, based on which buttons are enabled.

Note that all tasks in a group must either fail or complete successfully before the Cancel button is enabled.

3.6.3.3 The Next Button Is Not Enabled During Configuration Assistants

Problem

On the Configuration Progress page of the installer, the Next button is enabled only when all configuration assistants are successful.

If you see that all your configurations are complete, and the Next button is not enabled, you encountered a configuration failure and continued to the next configuration assistant.

Solution

In this case, you must retry the failed configuration assistants by following these steps:

1. On the Configuration Progress page of the installer, click Cancel.

2. Restart the installer. All failed configuration assistants or steps rerun upon restart. For more information, see Section 3.6.3.1, "Restart a Failed Installer Session."

As long as a configuration assistant is not successful, the Next button remains disabled. It may be necessary to repeat the cancel and retry procedure until all configuration assistants are successful.

3.6.3.4 The OPSS Security Store Goes Down While the Installer is Running

Problem

The OPSS Security Store goes down while the installer is running.

Solution

Configuration tasks that are related to the OPSS Security Store will fail if the store goes down. Perform the following steps to recover:

1. Abort the failed configuration task.

2. Select Cancel to end the installer session.

3. Start the OPSS Security Store. For more information, see "Starting Oracle Internet Directory" in the Oracle Fusion Applications Upgrade Guide.

4. Start a new installer session. The installer resumes with the remaining tasks because you selected Cancel, which saves the session

3.6.3.5 Failure During Opening of Wallet Based Credential Store

Problem

The following error occurs during the configuration phase.

Reason:oracle.security.jps.service.credstore.CredStoreException: JPS-01050:
Opening of wallet based credential store failed.
Reason java.io.IO Exception: PKI-02002: Unable to open the wallet. Check password.

Solution

After you resolve the cause of the failure, or cancel the installation and then restart the installer.

Related Link

The following document provides additional information related to subjects discussed in this section:

- If the failure still occurs, refer to "Other Reasons why Server Fails to Start" in the Oracle Fusion Middleware Application Security Guide to further diagnose the failure

3.6.3.6 Error While Loading Database Components in GUI Mode

Problem

Language Pack Installer reports that one or more database workers failed during the Loading Database Components configuration assistant.

Solution

You must AD Controller to manage the failed workers. After you resolve the issue that caused the workers to fail and you restart the failed worker, click OK in the dialog box and Language Pack Installer continues processing. For additional information, see "Troubleshooting Patching Sessions for Database Content" in the Oracle Fusion Applications Patching Guide.

3.6.4 General Troubleshooting During the Configuration Phase in Silent Mode

The installer can be restarted to rerun all failed configuration tasks as well as those tasks that were not started from the previous session. When a mandatory configuration task or step fails in silent mode, the installer exits. After you resolve the issue that caused the failure, restart the installer using the same command you used to start it. When the installer restarts, it restarts from the first failed task.

If any non-mandatory tasks fail in silent mode, the installer continues with the next configuration task and does not exit. You must review the logs to find any non-mandatory tasks that failed and then rerun the installer until all tasks complete successfully.

If you decide to run the installer in GUI mode, you must start it from the REPOSITORY_LOCATION/installers/farup/Disk1/ directory.

3.6.5 Recovering From a Language Pack Installer Session That Was Shut Down

Problem

A Language Pack Installer session was shut down during the upgrade.

Solution

To recover from this situation, restore your backup of APPLICATIONS_BASE and start from the beginning of the upgrade.

3.6.6 Troubleshooting Applying Middleware Patches

For information about troubleshooting a failure that occurs during the Applying Middleware Patches configuration assistant, see "Troubleshooting Applying Middleware Patches" in the Oracle Fusion Applications Upgrade Guide.

3.6.7 Troubleshooting Loading Database Components

For information about troubleshooting a failure that occurs during the Loading Database Components configuration assistant, see "Troubleshooting Loading Database Components" in the Oracle Fusion Applications Upgrade Guide.

3.6.8 Troubleshooting Deployment of Applications Policies

For information about troubleshooting failures during the Deployment of Applications Policies configuration assistant, see "Troubleshooting Deployment of Applications Policies" in the Oracle Fusion Applications Upgrade Guide.

3.6.9 Troubleshooting Deployment of BI Publisher Artifacts

Problem

The following error occurs if the BI Presentation servers are running during the deployment of BI Publisher artifacts:

java.lang.RuntimeException: Webcat patch file creation failed!

Solution

If the Language Pack contains BI Publisher artifacts, the BI Presentation servers must not be running. To resolve this issue, shut down the BI Presentation servers to release locks on the Oracle BI Presentation Catalog. For more information, see Section 4.4.2.1, "fastartstop Syntax".

3.6.10 Resolve JAZN Conflicts Found by Health Checker

This step is performed by Health Checker only if the -DupdateJAZNPolicyStore option is set to true.

Health Checker checks the JAZN Analysis reports for potential conflicts and deletions that are not patched automatically by Language Pack Installer. The reports are located in the following directory:

APPLICATIONS_CONFIG/lcm/admin/11.1.8.0.0/fapatch/JAZN/stripe/delta/report.txt

The stripe is crm, fscm, hcm, obi, soa, ucm or bpm.

Review the Modification section of the report to see the roles that Language Pack Installer did not update. For each conflict that displays in this report, you must evaluate and manually patch the role by using APM. For more information, see Section 5.3.2, "Upgrading Fusion Application Policies."

The following example shows a typical Applications Role conflict that has been modified by both the patch and production, therefore it will not be applied by Language Pack Installer.

MODIFICATION CONFLICTS
Artifact type: Application Role
Artifact Name: OBIA_PARTNER_CHANNEL_ADMINISTRATIVE_ANALYSIS_DUTY
Description: This artifact is modified at attribute level in patch version and also in production.

Note the location of the following files for reference when using APM:

- Location of baseline files, where stripe is crm, fscm, hcm, obi, soa, ucm, or bpm:

FA_ORACLE_HOME/admin/JAZN/stripe/baseline

- Location of patch files for fscm, crm, or hcm stripes:

FA_ORACLE_HOME/stripe/deploy/system-jazn-data.xml

- Location of patch files for the obi, soa, ucm, or bpm stripes:

FA_ORACLE_HOME/com/acr/security/jazn/bip_jazn-data.xml

3.6.11 Installer Requirement Checks Fail

Problem

The installer fails with the following type of errors:

Starting Oracle Universal Installer...
Checking if CPU speed is above 300 MHz.
Checking Temp space: must be greater than 4096 MB. Actual 9177 MB Passed

Checking swap space: 3915 MB available, 4000 MB required. Failed <<<<
Some requirement checks failed. You must fulfill these requirements before
continuing with the installation,

Solution

Manually increase the requirement check that failed, in this example, the swap space. Then restart Language Pack Installer.

3.6.12 Language Pack Installer Fails Due To Thread Calls

Problem

Language Installer fails due to thread calls and reports errors similar to the following example:

"Thread-11" id=29 idx=0x98 tid=25751 prio=5 alive, native_blocked
at java/io/UnixFileSystem.getBooleanAttributes0(Ljava/io/File;)I(Native
Method)
at java/io/UnixFileSystem.getBooleanAttributes(UnixFileSystem.java:228)
at java/io/File.exists(File.java:733)

Solution

Restart Language Pack Installer

3.7 Maintaining Language Content

Oracle Fusion Applications content is translated to different languages and fixes are made available as individual patches. If your environment uses multiple languages, whenever you apply a patch with translatable content, you may choose to also apply the associated translated patch for each of your installed languages. If a patch does not contain any translated content, such as a PL/SQL package, only the English patch is available.

If an Oracle Fusion Applications environment contains languages other than English, the recommended method for applying patches is to apply the English patch first and then apply the translation patch for each installed language.For example, after you install a language pack for another language, such as Korean, whenever you apply a patch that involves translatable content, you must apply the base English patch and also the Korean patch for that fix.

For detailed information about how to apply a patch, see "Applying Patches" in the Oracle Fusion Applications Patching Guide.

4 Performing Routine Administrative Tasks

This chapter describes the common and essential tasks for administering your Oracle Fusion Applications environment.

This chapter contains the following topics:

- Section 4.1, "Introduction to Performing Routine Administrative Tasks"

- Section 4.2, "Running Administration Servers and Managed Servers from Shared and Local Disks"

- Section 4.3, "Viewing and Managing Targets Across Domains (Optional)"

- Section 4.4, "Starting and Stopping"

- Section 4.5, "Viewing and Changing Ports for Components"

- Section 4.6, "Changing Passwords"

- Section 4.7, "Managing the Oracle Database"

- Section 4.8, "Patching"

- Section 4.9, "Managing Oracle Fusion Applications-Specific Labels in the Oracle Metadata Repository"

- Section 4.10, "Modifying Oracle Application Development Framework Connections in Oracle Fusion Applications"

- Section 4.11, "Modifying Oracle Data Integrator Configuration"

- Section 4.12, "Bulk Updating General User Preferences"

4.1 Introduction to Performing Routine Administrative Tasks

An important aspect of system administration of the Oracle Fusion Applications environment is performing a range of maintenance life-cycle and management operations. Section 1.4 provides a roadmap of when to perform these essential administrative tasks. In addition to following this roadmap, if you run into performance or security issues, use the tasks in the chapter to maintain the environment.

In addition to the tasks in this guide, refer the following documentation for tasks that you may need to perform, depending on your business needs:

- Oracle Fusion Applications Installation Guide for configuration tasks to perform after installation

- Oracle Fusion Applications Administrator's Troubleshooting Guide for common issues in the runtime environment

4.2 Running Administration Servers and Managed Servers from Shared and Local Disks

Configuration for domains is stored centrally on a shared disk. This location is accessible to all hosts, so the Administration Servers can run from this shared location. Managed Servers can run from either the shared location or from a local disk, that is, a non-network disk, visible only to the processes running on that host. During provisioning of Oracle Fusion Applications, in the Installation Location page of the Provisioning Wizard, you make this decision with the Enable Local Application Configuration option. When you select this option, provisioning copies the domain configuration from the shared server location to the specified local disk, and you run the Managed Servers from the local disk. If you choose not to select this option, all the Managed Servers are configured to run from the shared disk. For more information about using the Installation Location page, see ”Installation Location” in the Oracle Fusion Applications Installation Guide.

4.3 Viewing and Managing Targets Across Domains (Optional)

In Fusion Applications, certain business process flows or operational requirements can span domains and/or product families. For example, a Customer Relationship Management (CRM) process can rely on the availability of certain Human Capital Management (HCM) components. Out-of-the-box tools (such as Fusion Applications Control) are limited to monitoring the domains within their product family.In addition, administrators might want to monitor by target type across domains. For example, they might want to monitor all of the J2EE application targets across multiple WebLogic Server domains.The only way to accomplish this is through the Group functionality in Oracle Enterprise Manager Cloud Control. (Your system must have Cloud Control installed and configured.)

The following example shows how to create a Dashboard to view Enterprise Scheduling Service (ESS) components that are spread across the Common, HCM, CRM, and Financial Domains in the system. Use the same principles to create a Dashboard that fits your parameters.

1. Log in to Enterprise Manager Cloud Control and select Targets and Groups.

2. Select Create and choose Group from the drop-down menu.

3. On the resulting Create Group page, enter a Name and click Search for Members.
A list of all available Targets is displayed in a Group home page.

4. In the Search field at the top of the page, type ESSAPP to find all the Scheduler-related elements.

5. Choose Select All, or selectively click the results you want to include and click OK.
You see your Group with the chosen Members listed.

6. If it is correct, click OK. The list of all Groups is displayed.

7. Select your newly created Group by Name. The Group Dashboard is displayed.

4.4 Starting and Stopping

You start and stop the Oracle Fusion Applications environment and its components to perform a range of maintenance operations that require process downtime. Understanding the state (that is, up, down, starting, and stopping) of each component in the Oracle Fusion Applications environment is an essential activity when diagnosing and resolving availability and performance issues, and when performing life-cycle and management operations.

A typical Oracle Fusion Applications environment contains the applications, the Oracle Database, and the Oracle Fusion Middleware components. Depending on whether you need to start and stop an individual component or the entire environment, there are many several supported scenarios for performing these operations correctly.

4.4.1 Starting and Stopping Components in the Oracle Fusion Applications Environment

For many of the Oracle Fusion Middleware components, you can start and stop in different ways, depending on your requirements.

The following table describes the Oracle Fusion Applications, Oracle Fusion Middleware, and Oracle Database components you can start and stop, and provides information on where to find related documentation for each component.

The procedures referenced in the Oracle Fusion Middleware guides describe using Fusion Middleware Control. These procedures also apply to Fusion Applications Control.

Table 4-1 Starting and Stopping

Component

Description

Documentation

Oracle Fusion Applications

Oracle Fusion Applications

You can start and stop applications using the WLST command line, Fusion Applications Control, Cloud Control, or WebLogic Server Administration Console.

Section 4.4.9, "Starting and Stopping Specific Applications"

”Start applications and modules” and ”Stop applications and modules” in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help for the WebLogic Server Administration Console

Oracle Fusion Middleware

Administration Server

The Administration Server operates as the central control entity for the configuration of the entire Oracle WebLogic Server domain. It maintains the domain's configuration documents and distributes changes in the configuration documents to Managed Servers. The Administration Server serves as a central location from which to manage and monitor all resources in a domain.

You can use the fastartstop utility to start the Administration Server in one or more domains.

Section 4.4.4.1, "Starting the Administration Servers and Managed Servers"

Section 4.4.4.2, "Stopping the Administration Servers and Managed Servers"

Managed Servers for the Oracle Fusion applications and Oracle Fusion Middleware components

A Managed Server can host Oracle Fusion applications, application components, Web services, and their associated resources. Managed Servers also host applications for the following Oracle Fusion Middleware components:

- Oracle Business Intelligence

- Oracle Data Integrator

- Oracle Enterprise Scheduler

- Oracle Secure Enterprise Search

- Oracle SOA Suite

- Oracle WebCenter Content

- Oracle WebCenter Content: Imaging

- Oracle WebCenter Portal's Discussion Server

- Oracle WebCenter Portal: Spaces

You can use the fastartstop utility to start one or more Managed Servers in one or more domains. Alternatively, you can use Fusion Applications Control or WebLogic Server Administration.

Section 4.4.4.1, "Starting the Administration Servers and Managed Servers"

Section 4.4.4.2, "Stopping the Administration Servers and Managed Servers"

Node Manager

Node Manager is an Oracle WebLogic Server utility that enables you to start, shut down, and restart the Administration Servers and the Managed Server instances.

On Windows, Node Manager is configured to automatically start by default.

Section 4.4.3.1.3, "Task 3: Start Node Manager"

Oracle Business Intelligence Suite

You can use Fusion Applications Control or the opmnctl command to start and stop Oracle Business Intelligence system components.

You can use the fastartstop utility to start and stop the BI Presentation Server component.

Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Enterprise Edition (Oracle Fusion Applications Edition)

Oracle Enterprise Scheduler

You can use Fusion Applications Control to start and stop the Oracle Enterprise Scheduler.

Section 6.7, "Starting and Stopping Oracle Enterprise Scheduler Service Components"

Oracle HTTP Server

You can use Fusion Applications Control or the opmnctl command to start and stop Oracle HTTP Server.

”Starting, Stopping, and Restarting Oracle HTTP Server” section in the Oracle Fusion Middleware Administrator's Guide for Oracle HTTP Server

Oracle SOA Suite

You can use Fusion Applications Control to start and stop the SOA Infrastructure and the Managed Servers for Oracle SOA Suite.

”Stopping and Starting the Managed Server and SOA Infrastructure” section in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite

Oracle WebCenter Portal: Spaces

Always ensure Content Server is running when starting Oracle WebCenter Portal: Spaces. If Content Server is not running when Spaces is started up Spaces will consider the Document service as unavailable. After Content Server is started, a restart of Spaces is needed for it to recheck if the Document service is configured.

”Starting Content Server” section in the Oracle WebCenter Content System Administrator's Guide for Content Server

”Starting and Stopping the Spaces Application” section in the Oracle WebCenter Content System Administrator's Guide for Content Server

Oracle WebLogic Server domain for a product family

When applying a patch that only applies to one product family, stop the Oracle WebLogic Server domain for the product family and restart it after you apply the patch without stopping the entire Oracle Fusion Applications environment.

Use the fastartstop utility for this task. You can alternatively use Fusion Applications Control.

Section 4.4.7, "Starting and Stopping a Product Family Oracle WebLogic Server Domain"

Oracle WebLogic Server cluster for a product family

If you modify the Oracle WebLogic Server configuration, you must stop and restart the cluster for the configuration changes to take effect.

Use the fastartstop utility for this task. You can alternatively use Fusion Applications Control and WebLogic Server Administration Console.

Section 4.4.8, "Starting and Stopping an Oracle WebLogic Server Cluster in a Product Family for a Configuration Change"

Oracle Database

Oracle Database

You can start and stop the Oracle database with the Oracle Enterprise Manager Database Control.

”Accessing the Database Home Page” section in the Oracle Database 2 Day DBA

4.4.2 Understanding Starting and Stopping with the fastartstop Utility

The fastartstop script is installed with the Oracle Fusion Applications patching framework. After installation, the registry file for each product family is populated with Oracle WebLogic Server domain entries for all product families, including the Oracle Fusion Applications Common Domain in the Oracle Fusion Setup product family. You can use this utility to start all the domains or a selected domain. When the fastartstop utility is used to start a domain, all the Managed Servers will be started and the Administration Server of the domain will be stopped after all the Managed Servers have been started. The fastartstop utility uses Node Manager to start and stop servers. fastartstop will fail if Node Manager is not already running.

While the utility starts and stops the domains, it does not start and stop Oracle Identity Management and the Oracle Database. Therefore, you must start these components separately.

4.4.2.1 fastartstop Syntax

If the Oracle Fusion Applications patching framework was installed, the fastartstop utility is available from the following directories:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is the Oracle Fusion Applications home located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications
(Windows) APPLICATIONS_BASE\fusionapps\applications

The fastartstop utility supports the following syntax:

(UNIX) ./fastartstop.sh -Start|-Stop|-Bounce|-componentType|-componentDomain
-all |-domains domain_name,domain_nameN,domain_nameN
|-domains "domain_name(server:all,server:managed_server_
name|AdminServer)","domain_name(server:all,server:managed_server_name|Aderver)"
|-componentType <OHS or BI or GOP>
|-componentDomain <component's domain name>|-iasInstance instance_id|-iasComponent
component_id|-processType component_type
-username <username>
-fa_oracle_home <FA OracleHome>
[-clusters <WebLogic cluster name>]
[-includeServers <ENABLED or DISABLED or ALL>, default is ENABLED]
[-loglevel <log level>]
[-timeout <timeout period for server in seconds>]
[-mode <mode value>]
[-version]
[--help]

(Windows) fastartstop.cmd -Start|-Stop|-Bounce|-componentType|-componentDomain
-all |-domains domain_name,domain_nameN,domain_nameN
|-domains "domain_name(server:all,server:managed_server_
name|AdminServer)","domain_name(server:all,server:managed_server_name|Aderver)"
|-componentType <OHS or BI or GOP>
|-componentDomain <component's domain name>|-iasInstance instance_id|-iasComponent
component_id|-processType component_type
-username <username>
-fa_oracle_home <FA OracleHome>
[-clusters <WebLogic cluster name>]
[-includeServers <ENABLED or DISABLED or ALL>, default is ENABLED]
[-loglevel <log level>]
[-timeout <timeout period for server in seconds>]
[-mode <mode value>]
[-version]
[--help]

Sample command is as follows:

fastartstop.sh -Start -all -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -clusters ESSCluster,UCMCluster

The following table describes the options for the fastartstop script.

Table 4-2 Options for the fastartstop Script

Options

Description

-Start|-Stop|-Bounce|-componentType|-componentDomain

Specify the operation to execute:

- Use -Start to start Managed Servers.

- Use -Stop to stop Managed Servers.

- Use -Bounce to restart Managed Servers.

- Use –componentType to start Oracle Business Intelligence.

- Use -componentDomain to stop Oracle Business Intelligence.

-all|-domains|-componentType

Specify what to start, stop, or restart:

- Use -all for all components in all the domains. Components that are started include the Administration Server, Managed Servers, OPMN-based components Oracle Business Intelligence and Oracle HTTP Server.

- Use -domains for Managed Servers and the Administration Server in specific domains. Delineate the domain names with a comma, (domain_name,domain_name); white space is not allowed in the domain name list. This option does not manage OPMN-based components Oracle Business Intelligence and Oracle HTTP Server.

- Use -componentType BI for Oracle Business Intelligence components. This option is necessary with the –componentType or -componentDomain option.

- Use suboption server to specify the Administration Server or Managed Servers for the domains you want to start, stop, or bounce. When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:all,server:managed_server_name|AdminServer)"

This -domains option is mutually exclusive to the following options:

- -startAdminServer

- -clusters

- -adminServersOnly

You cannot include these options in the same fastartstop command as the -domains options.

If you use the server suboption for one domain, you must use it for all domains. Example 4-21 shows a mix, which would generate an error.

The following are the supported values for -componentType:

- BI

- OHS

- OSN.

-componentType|-componentDomain

Specify the operation to execute:

- Use -componentType to start Oracle HTTP Server. It is a customized form of -componentDomain option.

- Use -componentDomain as an alternative to starting or stopping Oracle HTTP Server managed through Oracle Process Manager and Notification (OPMN) component. You use the -iasInstance, -iasComponent, and -processType suboptions to completely specify a component.

- Use -iasInstance to specify the instance ID. Enter a value of CommonDomain_webtier for Oracle HTTP Server.

- Use -iasComponent to specify the component ID for the component. The value is ohs for Oracle HTTP Server.

- Use -processType to specify the component type. The valid value is OHS for Oracle HTTP Server.

-iasComponent is a child of -iasInstance. Therefore, you cannot issue a fastartstop command using -iasComponent without its hierarchical parent command. You can use -iasInstance independent of -iasComponent commands.

For example, -componentDomain CommonDomain -iasInstance CommonDomain_webtier will act upon all components under the CommonDomain_webtier instance ID. Similarly -componentDomain CommonDomain -iasInstance CommonDomain_webtier -iasComponent ohs1 will act upon all process types under ohs1 component ID. However, -componentDomain CommonDomain -iasComponent ohs1 will result in an error, as the hierarchy is not maintained. The component named ohs1 can be present under any instance, so the hierarchy must be maintained to ensure the correct Oracle HTTP Server.

-clusters

Specify the WebLogic cluster name.

The -clusters option cannot be used in combination with the following options:

- -domains with managed servers

- -adminServersOnly

- -componentType.

-username

Specify a user with Oracle Fusion Middleware administration user privileges.

-fa_oracle_home

Specify the complete directory path to the Oracle Fusion Applications Oracle home. This directory is located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications
(Windows) APPLICATIONS_BASE\fusionapps\applications

-adminServersOnly

Use to start, stop, or restart the Administration Servers only, leaving the Managed Servers untouched.

This option is mutually exclusive to the following options:

- -startAdminServer

- -clusters

- server suboption of the -domains option

You cannot include the -adminServersOnly option in the same fastartstop command as these options.

When used with Bounce, fastartstop performs a restart for Administration Servers. If some Administration Servers fail during the Bounce command, in next run, failed servers will be acted upon. The servers bounced successfully in the previous runs will be skipped in the next run.

-startAdminServer

Specify true to start the Administration Server; specify false to stop the Administration Server. The default is false.

This option is mutually exclusive to the following options:

- -adminServersOnly

- server suboption of the -domains option

You cannot include the -startAdminServer option in the same fastartstop command as these options.

--help

Specify to display the syntax.

-loglevel

Specify the log level for the fastartstop.log file:

- INFO: Provides informational messages.

- FINER: Provides detailed log messages.

- WARNING: Provides messages for potential problems.

INFO is the default.

-timeout

Specify the number of seconds to wait for the start, stop, or restart the domain or a server. When all the servers in the domain are started in parallel, the timeout is associated with the domain. When individual Administration Severs or Managed Severs are started instead of a domain, the timeout is associated with the server.

The default timeout is 40 minutes. In addition, this option has a minimum guard value of 12 minutes. If you provide a value less than 12 minutes, then guard value will be used instead.

-mode

Specify the mode value with which you want to run the fastartstop script. The <mode-value>_fass_control.properties file is located in the following directory (<mode-value> is any name):

(UNIX) <FA INSTANCE>/lcm/admin/FAStartStop
(Windows) <FA INSTANCE>\lcm\admin\FAStartStop

The mode values supported by default are:

- saas

- rup

By default, the following files will be available at the directory specified above:

- saas_fass_control.properties

- rup_fass_control.properties

The fastartstop utility prompts you for password for the user with Oracle Fusion Middleware administrator privileges specified by the -username argument. If you pass this argument to the fastarstop utility on the standard input, the utility will not prompt.

The fastartstop utility generates fastartstop.log in the following subdirectories:

(UNIX) APPLTOP/instance/lcm/logs/11.1.7.0.0/RUP/StartStop
(Windows) APPLTOP\instance\lcm\logs\11.1.7.0.0\RUP\StartStop

FA_ORACLE_HOME is the Oracle Fusion Applications home located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications
(Windows) APPLICATIONS_BASE\fusionapps\applications

4.4.2.2 fastartstop Examples

The following examples provide syntax for common scenarios:

4.4.2.2.1 Starting Examples with fastartstop

The following example shows starting the Administration Server and all the Managed Servers in the SCMDomain domain.

Example 4-1 Syntax Sample to Start the Administration Server and All Managed Servers in a Single Domain

./fastartstop.sh -Start -domains "SCMDomain(server:all)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows starting the Administration Server and the soa_server1 Managed Server in the SCMDomain domain.

Example 4-2 Syntax to Start the Administration Server and Another Managed Server in a Single Domain

./fastartstop.sh -Start -domains "SCMDomain(server:AdminServer,server:soa_server1)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows starting Managed Servers soa_server1 and AdvancedPlanningServer_1 in the SCMDomain domain.

Example 4-3 Syntax to Start Multiple Managed Servers in a Single Domain

./fastartstop.sh -Start -domains "SCMDomain(server:soa_server1,server:AdvancedPlanningServer_1)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows starting Managed Servers soa_server1 and AdvancedPlanningServer_1 in the SCMDomain domain and soa_server from the HCMDomain domain.

Example 4-4 Syntax to Start Multiple Managed Servers in Multiple Domains

./fastartstop.sh -Start -domains "SCMDomain(server:soa_server1,server:AdvancedPlanningServer_1),HCMDomain(server:soa_server)"  -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows starting all the Managed Servers and the Administration Server in the HCMDomain domain.

Example 4-5 Syntax to Start the Managed Servers and Administration Server in the SOA Cluster of a Single Domain

fastartstop.sh -Start -all -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -clusters ESSCluster,UCMCluster

The following example shows starting the CommonDomain domain. Starting a domain includes starting its Administration Server followed by the Managed Servers. When all the Managed Servers are up, the Administration Server is stopped. If you want the Administration Server to continue to run, use -startAdminServer true, as shown in the previous example. This command does not start OPMN-based components Oracle Business Intelligence and Oracle HTTP Server.

Example 4-6 Syntax to Start a Specific Domain

./fastartstop.sh -Start -domains CommonDomain -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /slot/ems7770/oracle/apphome/fusionapps/applications

The following example shows starting all the domains. Starting a domain includes starting its Administration Server followed by the Managed Servers. When all the Managed Servers are up, the Administration Server is stopped. If you want the Administration Servers to continue to run, use -startAdminServer true, as shown in the next example. The -all option also starts OPMN-based components Oracle Business Intelligence and Oracle HTTP Server.

Example 4-7 Syntax to Start All Domains

./fastartstop.sh -Start -all -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /slot/ems7770/oracle/apphome/fusionapps/applications

The following example shows starting multiple domains. Starting domains starts all the Managed Servers and Administration Server for each product family domain.

Example 4-8 Syntax to Start Multiple Domains

./fastartstop.sh -Start -domains HCMDomain,BIDomain,ProjectsDomain -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /scratch/aime/V1HCM/APPTOP/fusionapps/applications -startAdminServer true -clusters soa

4.4.2.2.2 Stopping Examples with fastartstop

The following example shows stopping the Administration Server and all the Managed Servers in the SCMDomain domain.

Example 4-9 Syntax to Stop the Administration Server and All Managed Servers in a Single Domain

./fastartstop.sh -Stop -domains "SCMDomain(server:all)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows stopping Managed Servers soa_server1 and AdvancedPlanningServer_1 in the SCMDomain domain.

Example 4-10 Syntax to Stop Multiple Managed Servers in a Single Domain

./fastartstop.sh - Stop -domains "SCMDomain(server:soa_server1,server:AdvancedPlanningServer_1)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows stopping Managed Servers soa_server1 and AdvancedPlanningServer_1 in the SCMDomain domain and soa_server in the HCMDomain domain.

Example 4-11 Syntax to Stop Multiple Managed Servers in Multiple Domains

./fastartstop.sh - Stop -domains "SCMDomain(server:soa_server1,server:AdvancedPlanningServer_1),HCMDomain(server:soa_server)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows stopping the CommonDomain domain. Stopping a domain stops its Managed Servers and Administration Server.

Example 4-12 Syntax to Stop a Specific Domain

./fastartstop.sh -Stop -domains CommonDomain -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /slot/ems7770/oracle/apphome/fusionapps/applications

The following example shows stopping all the product family domains. Stopping all the domains stops the Managed Servers, Administration Server, and the OPMN-based components Oracle Business Intelligence and Oracle HTTP Server for each domain.

Example 4-13 Syntax to Stop All Domains

./fastartstop.sh -Stop -all -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /slot/ems7770/oracle/apphome/fusionapps/applications

The following example shows stopping multiple domains. Stopping domains stops all the Managed Servers and Administration Server for each product family domain.

Example 4-14 Syntax to Stop Multiple Domains

./fastartstop.sh -Stop -domains HCMDomain,BIDomain,ProjectsDomain -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /scratch/aime/V1HCM/APPTOP/fusionapps/applications -startAdminServer true -clusters soa

4.4.2.2.3 Bouncing Examples with fastartstop

The following example shows restarting the Administration Server and all the Managed Servers in the SCMDomain domain.

Example 4-15 Syntax to Bounce the Administration Server and All Managed Servers in a Single Domain

./fastartstop.sh -Bounce -domains "SCMDomain(server:all)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows restarting Managed Servers soa_server1 and AdvancedPlanningServer_1 in the SCMDomain domain.

Example 4-16 Syntax to Bounce Multiple Managed Servers in a Single Domain

./fastartstop.sh - Bounce -domains "SCMDomain(server:soa_server1,server:AdvancedPlanningServer_1)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows restarting Managed Servers soa_server1 and AdvancedPlanningServer_1 in the SCMDomain domain and soa_server in the HCMDomain domain.

Example 4-17 Syntax to Bounce Multiple Managed Servers in Multiple Domains

./fastartstop.sh - Bounce -domains "SCMDomain(server:soa_server1,server:AdvancedPlanningServer_1),HCMDomain(server:soa_server)"  -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

The following example shows restarting the CommonDomain domain. Restarting a domain restarts the Managed Servers and Administration Server in the domain.

Example 4-18 Syntax to Bounce a Specific Domain

./fastartstop.sh -Bounce -domains CommonDomain -username FUSION_APPS_PROV_PATCH_APPID -fa_oracle_home /slot/ems7770/oracle/apphome/fusionapps/applications

4.4.2.2.4 Using the AdminServersOnly Option with fastartstop

Example 4-19 Syntax to Restart all the Administration Servers

./fastartstop.sh -Bounce -all  -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER -adminServersOnly

4.4.2.2.5 Using Combination Commands with fastartstop

If the server suboption is set to all and another Managed Server or Administration Server with the -domain option, all will take precedence and the start, stop, or restart operation will occur on all servers.

Example 4-20 Syntax with Contradicting server Suboption Settings

./fastartstop.sh -Bounce -domains "SCMDomain(server:all,server:soa_server1)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER

If you use the server suboption for one domain, you must use it for all domains. In addition, you cannot use the server suboption with the -adminServersOnly option. The following example shows server:all for the SCMDomain domain, but not for the HCMDomain domain. It also shows the -adminServersOnly option in combination with the server suboption. This syntax would generate an error.

Example 4-21 Syntax with server Suboption Settings Not Consistently Used

./fastartstop.sh -Start|Stop|Bounce -domains "SCMDomain(server:all),HCMDomain" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER -adminServersOnly

If the server suboption of the -domains option is used, the following options cannot be used:

- -startAdminServer

- -clusters

- -adminServersOnly

The following example shows incorrect combinations of these commands. If these examples are entered, you would see error messages.

Example 4-22 Sample Syntax with Contradicting server Suboption Settings

./fastartstop.sh -Start|Stop|Bounce -domains "SCMDomain(server:all)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER -clusters SOA

./fastartstop.sh -Start|Stop|Bounce -domains "SCMDomain(server:all)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER -startAdminServer true

./fastartstop.sh -Start|Stop|Bounce -domains "SCMDomain(server:all)" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER -adminServersOnly

./fastartstop.sh -Start|Stop|Bounce -domains "SCMDomain(server:all),HCMDomain" -username FAAdmin -fa_oracle_home /scratch/aime/work/APPTOP/fusionapps/applications -loglevel FINER -adminServersOnly

4.4.3 Starting and Stopping the Entire Oracle Fusion Applications Environment

Some components in the Oracle Fusion Applications environment are dependent on one another. Therefore, it is important to start and stop components in the proper order. In the course of normal IT operations, common operations include shutting down computers and starting them back up. Therefore, it is crucial to start and stop Oracle Fusion Applications in a sequential manner.

4.4.3.1 Starting an Oracle Fusion Applications Environment

To perform a complete start of the Oracle Fusion Applications environment, you must start the Oracle WebLogic Server domain for the Oracle Fusion Setup product family before starting the domains for other product families.

Applications may not work correctly until all the Managed Servers in all domains have been started.

The tasks in the following sections describe steps for performing a complete start of the Oracle Fusion Applications environment:

4.4.3.1.1 Task 1: Start the Oracle Database

To start the Oracle database instance using Oracle Database Control:

1. Go to the Database Home page.

2. Click Startup on the Database Home page.
The Startup/Shutdown Credentials page appears.

3. Enter credentials as follows:

1. Enter the host computer credentials of the user who installed Oracle Database, or of any user who is authorized to use SQL*Plus.

2. Enter the database credentials consisting of the user name SYS and the password that you assigned to SYS during the installation.

3. From the Connect As list, select SYSOPER.

4. Click OK.
A confirmation page appears.

5. Click Yes.
The Startup page appears indicating that the database is being started up. When startup is complete, the Login page appears.

6. Log in to the database.
The Database Home page appears indicating that the database instance status is Up.

For information about shutting down and starting up the Oracle database instance, see the ”Shutting Down and Starting Up the Oracle Instance” section in the Oracle Database 2 Day DBA.

4.4.3.1.2 Task 2: Start the Oracle Identity Management Suite

To start the Oracle Identity Management system components:

1. Set the ORACLE_HOME environment variable to Oracle home for the Oracle Identity Management components.

2. Start Oracle Process Manager and Notification Server (OPMN) and all system components:

opmnctl startall

4.4.3.1.3 Task 3: Start Node Manager

Each host has its own copy of the Node Manager and all the Node Managers should be running before attempting to start any Administration Servers or Managed Servers.

Start Node Manager for each of the hosts for which you want to start the Administration Servers:

1. Set the JAVA_OPTIONS environment variable:

setenv JAVA_OPTIONS "${JAVA_OPTIONS} -Dserver.group=AdminServer"

2. Set the WLST_PROPERTIES environment variable:

setenv WLST_PROPERTIES "-Dweblogic.security.SSL.trustedCAKeyStore=APPLICATIONS_CONFIG/keystores/fusion_trust.jks"

where APPLICATIONS_CONFIG is one of the following directories:

(UNIX) APPLICATIONS_BASE/instance
(Windows) APPLICATIONS_BASE\instance

3. Start Node Manager with the startNodeManagerWrapper utility from the following locations:

(UNIX) APPLICATIONS_CONFIG/nodemanager/host_name/startNodeManagerWrapper.sh
(Windows) APPLICATIONS_CONFIG\nodemanager\host_name\startNodeManagerWrapper.cmd

4. For all the hosts, verify that Node Manager is running. For example, on UNIX platforms, enter the following command:

netstat –a|grep 5556

The 5556 port should be in a listening state. If your environment uses a different port, then use the port number in the System Port Allocation page during the creation of a provisioning plan. See the ”System Port Allocation” section in the Oracle Fusion Applications Installation Guide.

4.4.3.1.4 Task 4: Start the Key Oracle Fusion Middleware Components on the Provisioned Environment

To start the Administration Servers, Managed Servers, Oracle HTTP Server, and Oracle Business Intelligence on the provisioned environment:

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is the Oracle Fusion Applications home located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications
(Windows) APPLICATIONS_BASE\fusionapps\applications

2. From the shared host location, run the fastartstop utility with the -all option for all the domains:

fastartstop.sh/fastartstop.cmd -Start -all
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

For more information about the fastartstop syntax, see Table 4-2.

4.4.3.2 Stopping an Oracle Fusion Applications Environment

You can follow these procedures when you need to completely shut down the Oracle Fusion Applications environment. For example, when preparing to perform a complete backup of your environment, or apply a patch.

The tasks in the following sections describe steps for performing a complete stop of the Oracle Fusion Applications environment:

4.4.3.2.1 Task 1: Stop the Key Oracle Fusion Middleware Components on the Provisioned Environment

To start the Administration Servers, Managed Servers, Oracle HTTP Server, and Oracle Business Intelligence on the provisioned environment:

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is the Oracle Fusion Applications home located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications
(Windows) APPLICATIONS_BASE\fusionapps\applications

2. From the shared host location, run the fastartstop utility with the -all option for all the domains:

fastartstop.sh/fastartstop.cmd -Stop -all
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

For more information about the fastartstop syntax, see Table 4-2.

4.4.3.2.2 Task 2: Stop the Oracle Identity Management Suite

To stop the Oracle Identity Management system components:

1. Set the ORACLE_HOME environment variable to Oracle home for the Identity Management components.

2. Stop OPMN and all system components:

opmnctl stopall

4.4.3.2.3 Task 4: Stop the Oracle Database

To stop the Oracle database instance using Oracle Database Control:

1. Go to the Database Home page.

2. In the Database Home page, click Shutdown.
The Startup/Shutdown Credentials page appears.

3. Enter credentials as follows:

1. Enter the host computer credentials of the user who installed Oracle Database, or of any user who is authorized to use SQL*Plus.

2. Enter the database credentials consisting of the user name SYS and the password that you assigned to SYS during the installation.

3. From the Connect As list, select SYSOPER.

4. (Optional) Select the Save as Preferred Credential option if you want these credentials to be automatically filled in for you the next time this page appears.

5. Click OK.
A confirmation page appears.

6. Click Yes to start the SHUTDOWN IMMEDIATE operation on the database.
The Shutdown: Activity Information page appears, informing you that the database is being shut down.

7. After a short period (approximately 2 minutes), click Refresh to return to the Database Home page.
The Database Home page indicates that the database instance status is Down.

4.4.4 Starting and Stopping the Administration Servers and Managed Servers

This section describes how to start and stop Administrations Servers and Managed Servers:

4.4.4.1 Starting the Administration Servers and Managed Servers

You must start the Oracle WebLogic Server Administration Server for the CommonDomain domain in the Oracle Fusion Setup product family from a shared disk. The applications and other product families depend on topology information in the Administration Server in the Oracle Fusion Setup product family. For more information about running the Administration Server and Managed Servers from a shared location, see Section 4.2.

Optionally, if you need to perform administration tasks for other product families, start the Administration Server for those product families.

When you start an Administration Server, you also start the applications that run on the Administration Server, including the WebLogic Server Administration Console and Fusion Applications Control.

To start the Administration Servers and Managed Servers:

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is a directory named applications, located under the fusionapps Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility to start the Administration Servers and the Managed Servers:

- To start only Administration Servers, use the -adminServersOnly option. Use the -startAdminSever option to keep Admin Servers running after starting/stopping Managed Servers. Use the -all option to start the Administration Servers for all the domains or the -domains option to start the Administration Server for specific domains.

fastartstop.sh/fastartstop.cmd -Start
-all|-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
-adminServersOnly
[-loglevel log_level]
[-timeout timeout_period]

fastartstop.sh/fastartstop.cmd -Start
-all|-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
-startAdminServer true
[-loglevel log_level]
[-timeout timeout_period]

fastartstop.sh/fastartstop.cmd -Start
-all|-domains "domain_name(server:AdminServer),domain_name(server:AdminServer)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:AdminServer),domain_name(server:AdminServer)"

- To start only the Managed Servers, use the -domains option with the server suboption to specify the Managed Servers to start:

fastartstop.sh/fastartstop.cmd -Start
-domains "domain_name(server:managed_server_name,server:managed_server_name),domain_name(server:managed_server_name,server:managed_server_name)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:managed_server_name,server:managed_server_name),domain_name(server:managed_server_name,server:managed_server_name)"

- To start the Administration Servers and Managed Servers in one fastartstop command, use the -domains option to specify the domains and the -startAdminServer true, or use the -domains option with the server:all suboption:

fastartstop.sh/fastartstop.cmd -Start
-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
-startAdminServer true
[-loglevel log_level]
[-timeout timeout_period]

fastartstop.sh/fastartstop.cmd -Start
-domains "domain_name(server:all),domain_name(server:all)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:all),domain_name(server:all)"

For more information about the fastartstop syntax, see Table 4-2.

Note:

Do not use the following Oracle WebLogic Server scripts to start the Administration Servers:

(UNIX) DOMAIN_HOME/bin/startWebLogic.sh
(Windows) DOMAIN_HOME\bin\startWebLogic.cmd

Starting Managed Servers with Fusion Applications Control

If you are working on a specific domain in Fusion Applications Control, you can also start the Managed Servers for that domain.

To start the Managed Servers for a specific domain with Fusion Applications Control:

1. From the navigation pane, expand the farm, WebLogic Domain.

2. From the WebLogic Domain menu, choose Control, then Start Up.

Starting Managed Servers with WebLogic Server Administration Console

If you prefer to use the WebLogic Server Administration Console instead of Fusion Applications Control, see ”Start Managed Servers from the Administration Console” and ”Start Managed Servers in a cluster” in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help.

4.4.4.2 Stopping the Administration Servers and Managed Servers

When stopping the Oracle Fusion Applications environment, stop the Administration Server for the product families other than the Oracle Fusion Setup product family first, and then stop the Administration Server for the Oracle Fusion Setup product family. The applications and other product families depend on topology information in the Administration Server in the Oracle Fusion Setup product family. Therefore, you need to stop the Administration Server in the Oracle Fusion Setup product family after other product families. You stop the Administration Servers from a shared disk.

When you stop the Administration Server, you also stop the applications that run on the Administration Server, including the WebLogic Server Administration Console and Fusion Applications Control.

To stop the Administration Servers and Managed Servers:

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is a directory named applications, located under the fusionapps Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility to stop the Administration Servers and the Managed Servers:

- To stop only Administration Servers, use the -adminServersOnly option. Use the -startAdminSever option to keep Admin Servers up after starting/stopping managed servers. Use the -all option to stop the Administration Servers for all the domains or the -domains option to stop the Administration Servers for specific domains.

fastartstop.sh/fastartstop.cmd -Stop
-all|-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
-adminServersOnly
[-loglevel log_level]
[-timeout timeout_period]

fastartstop.sh/fastartstop.cmd -Stop
-all|-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
-startAdminServer false
[-loglevel log_level]
[-timeout timeout_period]

fastartstop.sh/fastartstop.cmd -Stop
-all|-domains "domain_name(server:AdminServer),domain_name(server:AdminServer)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:AdminServer),domain_name(server:AdminServer)"

- To stop only the Managed Servers, use the -domains option with the server suboption to specify the Managed Servers to stop:

fastartstop.sh/fastartstop.cmd -Stop
-domains "domain_name(server:managed_server_name,server:managed_server_name),domain_name(server:managed_server_name,server:managed_server_name)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:managed_server_name,server:managed_server_name),domain_name(server:managed_server_name,server:managed_server_name)"

- To stop the Administration Servers and Managed Servers in one fastartstop command, use the -domains option with the server:all suboption to stop the servers for specific domains.

fastartstop.sh/fastartstop.cmd -Stop
-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

fastartstop.sh/fastartstop.cmd -Stop
-domains "domain_name(server:all),domain_name(server:all)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:all),domain_name(server:all)"

For more information about the fastartstop syntax, see Section 4.4.2.1.

Note:

Do not use the following Oracle WebLogic Server scripts to stop the Administration Servers:

(UNIX) DOMAIN_HOME/bin/stopWebLogic.sh
(Windows) DOMAIN_HOME\bin\stopWebLogic.cmd

Stopping Managed Servers with Fusion Applications Control

If you are working on a specific domain in Fusion Applications Control, you can also stop the Managed Servers for that domain.

To stop the Managed Servers for a specific domain with Fusion Applications Control:

1. From the navigation pane, expand the farm, WebLogic Domain.

2. From the WebLogic Domain menu, choose Control, then Shut Down.

Stopping Managed Servers with WebLogic Server Administration Console

If you prefer to use the WebLogic Server Administration Console, see and ”Shutdown servers in a cluster” in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help.

4.4.5 Starting and Stopping Oracle HTTP Server

The following sections explain how to start and stop the Oracle HTTP Server.

4.4.5.1 Starting the Oracle HTTP Server

To start Oracle HTTP Server:

- fastartstop

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

Note:

OPMN of the OHS instance must be running for fastartstop to start the OHS component.

FA_ORACLE_HOME is a directory named applications and located under the fusionapps directory of Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility with -componentType option:

fastartstop.sh/fastartstop.cmd  -Start -componentType BI -fa_oracle_home /APPTOP/fusionapps/applications/
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

For more information about the fastartstop syntax, see Table 4-2.

- opmnctl

(UNIX) WT_CONFIG_HOME/bin/opmnctl startproc process-type=OHS
(Windows) WT_CONFIG_HOME\bin\opmnctl startproc process-type=OHS

- Fusion Applications Control:

1. From the navigation pane, expand the farm and the Web Tier installation type.

2. Select the Oracle HTTP Server.

3. From the Oracle HTTP Server menu, choose Control and Start Up.

4.4.5.2 Stopping the Oracle HTTP Server

To stop Oracle HTTP Server:

- fastartstop

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is a directory named applications, located under the fusionapps Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility with -componentType option:

fastartstop.sh/fastartstop.cmd -Stop -componentType OHS
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

The -username option is not needed for stopping Oracle HTTP Server.

For more information about the fastartstop syntax, see Table 4-2.

- opmnctl

(UNIX) WT_CONFIG_HOME/bin/opmnctl stopproc process-type=OHS
(Windows) WT_CONFIG_HOME\bin\opmnctl stopproc process-type=OHS

- Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Web Tier installation type.

2. Select the Oracle HTTP Server.

3. From the Oracle HTTP Server menu, choose Control and Shut Down.

4.4.6 Starting and Stopping Oracle Business Intelligence

The following sections explain how to start and stop the Oracle Business Intelligence.

4.4.6.1 Starting Oracle Business Intelligence

To start Oracle Business Intelligence:

- fastartstop

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is a directory named applications, located under the fusionapps Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility with -componentDomain and -componentType BI options:

fastartstop.sh/fastartstop.cmd -componentDomain -componentType BI
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

These options start the BIDomain, including the Administration Server and all the Managed Servers, as well as the following Oracle Business Intelligence components:

- JavaHost

- Oracle BI Presentation Server

- Oracle BI Scheduler

- Oracle BI Server

For more information about the fastartstop syntax, see Table 4-2.

- Other tools
See ”Starting and Stopping Oracle Business Intelligence” in the Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.

4.4.6.2 Stopping Oracle Business Intelligence

To stop Oracle Business Intelligence:

- fastartstop

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is a directory named applications, located under the fusionapps Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility with -componentDomain and -componentType BI options:

fastartstop.sh/fastartstop.cmd -componentDomain -componentType BI
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

These options stop the BIDomain, as well as the following Oracle Business Intelligence components:

- JavaHost

- Oracle BI Presentation Server

- Oracle BI Scheduler

- Oracle BI Server

For more information about the fastartstop syntax, see Table 4-2.

- Other tools
See ”Starting and Stopping Oracle Business Intelligence" in the Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.

4.4.7 Starting and Stopping a Product Family Oracle WebLogic Server Domain

When applying a patch that only applies to a product family, you can stop the Oracle WebLogic Server domain for the product family and restart it after you apply the patch. Your environment may require a restart of a domain for reasons other than a patch.

4.4.7.1 Stopping an Oracle WebLogic Server Domain for a Product Family

You must stop an Oracle WebLogic Server domain for a product family before applying a patch.

Task 1   Stop the Oracle HTTP Server

See Section 4.4.5.2.

Task 2   Stop the Product Family Domain

When you stop an Oracle WebLogic Server domain for a product family, you stop all the applications on the cluster of Managed Servers in the domain. For example, the Oracle Enterprise Scheduler ESSAPP application and the SOA Infrastructure soa-infra application stop running.

To stop a product family domain, use the fastartstop utility with the -domains option.

fastartstop.sh/fastartstop.cmd -Stop
-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

For more information about the fastartstop syntax, see Section 4.4.2.1.

To stop a product family domain using Fusion Applications Control:

1. From the navigation pane, expand the farm, then WebLogic Domain.

2. Select the Oracle WebLogic Server domain.

3. From the WebLogic Domain menu, choose Control, then Shut Down.

4.4.7.2 Starting an Oracle WebLogic Server Domain for a Product Family

You must start an Oracle WebLogic Server domain for a product family after applying a patch.

This section contains the following topics for starting an Oracle WebLogic Server domain for a product family:

- Task 1, "Start the Oracle HTTP Server"

- Task 2, "Start the Product Family Domain"

Task 1   Start the Oracle HTTP Server

See Section 4.4.5.1.

Task 2   Start the Product Family Domain

When you start an Oracle WebLogic Server domain for a product family, you start the cluster of Managed Servers in the domain and all the applications.

To start a product family domain, use the fastartstop utility with the -domains option.

fastartstop.sh/fastartstop.cmd -Start
-domains domain_name,domain_nameN,domain_nameN
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

For more information about the fastartstop syntax, see Section 4.4.2.1.

To start a product family domain using Fusion Applications Control:

1. From the navigation pane, expand the farm, then WebLogic Domain.

2. Select the Oracle WebLogic Server domain.

3. From the WebLogic Domain menu, choose Control, then Start Up.

4.4.8 Starting and Stopping an Oracle WebLogic Server Cluster in a Product Family for a Configuration Change

If you modify the Oracle WebLogic Server configuration, you must stop and restart the cluster for the configuration changes to take effect. Starting and stopping a cluster stops all the Managed Servers within that cluster.

4.4.8.1 Starting and Stopping an Oracle WebLogic Server Cluster Using fastartstop

The fastartstop utility enables you to start or stop a cluster in a product family domain.

To start the Oracle WebLogic Server cluster:

1. At an operating system command prompt, navigate to the location of the fastartstop script:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin
(Windows) FA_ORACLE_HOME\lcm\ad\bin

FA_ORACLE_HOME is a directory named applications and located under the fusionapps directory of Oracle Fusion Applications Middleware home.

2. From the shared host location, run the fastartstop utility.
From the shared host location, run the fastartstop utility with the -domains option with the server suboption to specify all the Managed Servers in the cluster to start:

fastartstop.sh/fastartstop.cmd -Start
-domains "domain_name(server:managed_server_name,server:managed_server_name)"
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

When the server suboption is used, enclose the -domains argument in quotes (applicable for UNIX platforms only):

-domains "domain_name(server:managed_server_name,server:managed_server_name)"

For a SOA cluster, you can start all the Managed Servers in the cluster with the -domains option and the -clusters option. The -clusters option supports only SOA clusters.

fastartstop.sh/fastartstop.cmd -Start
-domains domain_name,domain_nameN,domain_nameN
-clusters soa
-username user_name
-fa_oracle_home FA_ORACLE_HOME
[-loglevel log_level]
[-timeout timeout_period]

For more information about the fastartstop syntax, see Section 4.4.2.1.

4.4.8.2 Starting and Stopping an Oracle WebLogic Server Cluster Using Fusion Applications Control

To stop or restart a cluster using Fusion Applications Control:

1. Modify the Oracle WebLogic Server configuration as required.

2. From the navigation pane, expand the farm, WebLogic Domain and the domain name.

3. Select the Oracle WebLogic Server cluster.

4. Expand the Oracle WebLogic Server cluster to show each target's Managed Server.

5. From the WebLogic Cluster menu, choose Control and Shut Down or Start Up.

4.4.8.3 Starting and Stopping an Oracle WebLogic Server Cluster Using WebLogic Server Administration Console

If you prefer to use the WebLogic Server Administration Console, see ”Start Managed Servers in a cluster” and ”Shutdown servers in a cluster” in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help.

Related Links

The following document provides additional information related to the topics discussed in this section:

- For more information about Using Node Managers see ”Using Node Manager to Start Managed Servers in a WebLogic Domain or Cluster” section in Oracle Fusion Middleware Oracle WebLogic Scripting Tool.

4.4.9 Starting and Stopping Specific Applications

Applications may not work correctly until all Managed Servers in all domains have been started.

4.4.9.1 Starting and Stopping Java EE Applications Using WLST

To start or stop applications with the WebLogic Scripting Tool (WLST):

1. At an operating system command prompt, navigate to the location of the WLST script:

(UNIX) FA_MW_HOME/oracle_common/common/bin
(Windows) FA_MW_HOME\oracle_common\common\bin

FA_MW_HOME is a directory named fusionapps and located under the APPLICATIONS_BASE.

2. Run the wlst script:

(UNIX) wlst.sh
(Windows) wlst.cmd

3. Connect to Oracle WebLogic Server with the following WLST command:

connect([options])

4. Use the following WLST commands:

startApplication(appName, [options])
stopApplication(appName, [options])

The application must be fully configured and available in the domain. The startApplication command returns a WLSTProgress object that you can access to check the status of the command. In the event of an error, the command returns a WLSTException.

Related Links

The following documents provide additional information about the topics discussed in this section:

- For more information about the WLSTProgress object, see ”WLSTProgress Object” in the Oracle Fusion Middleware Oracle WebLogic Scripting Tool.

- For more information about the connect command, see the ”connect” section in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

4.4.9.2 Starting and Stopping an Individual Application Instance for a Cluster Using Fusion Applications Control or Cloud Control

To start or stop an application using Fusion Applications Control or Cloud Control:

1. Navigate to a product family home page:

- From Fusion Applications Control, from the navigation pane, select the product family.

- From Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page displays.

2. In the table on the Fusion Applications target home page, click the appropriate Product Family target.

2. From the navigation pane, expand the product family, then Fusion Applications, and then the cluster application.

3. Select the application instance you want to start or stop.

4. From the Fusion J2EE Application menu, choose Control, then Start Up or Shut Down.

If you prefer to use the WebLogic Server Administration Console, see ”Start applications and modules” and ”Stop applications and modules” in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help.

4.4.9.3 Starting and Stopping All Application Instances for a Cluster Using Fusion Applications Control or Cloud Control

To start or stop all the application instances in a cluster using Fusion Applications Control or Cloud Control.

1. Navigate to a product family home page:

- From Fusion Applications Control, from the navigation pane, select the product family.

- From Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page displays.

2. In the table on the Fusion Applications target home page, click the appropriate Product Family target.

2. From the navigation pane, expand the product family, then Fusion Applications, and then the cluster application.

3. From the Fusion Cluster Application menu, choose Control, then Start Up or Shut Down.

4.5 Viewing and Changing Ports for Components

Oracle Database and Oracle Fusion Middleware components and services use ports. Most numbers are assigned during installation. As an administrator, it is important to know the numbers used by these services, and to ensure that the same number is not used by two services on your host.

For some ports, you can specify a number assignment during installation.

The following table lists the port types and provides information on where to find documentation related to changing ports. The procedures referenced in the Oracle Fusion Middleware guides describe using Fusion Middleware Control. These procedures also apply to Fusion Applications Control.

Table 4-3 Changing Ports

Port Type

Documentation for Changing Ports

Oracle Database

”Changing the Oracle Database Net Listener Port” section in the Oracle Fusion Middleware Administrator's Guide

Oracle Business Intelligence Suite

”Using Fusion Middleware Control to Scale System Components” section in the Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Essbase

”Using Fusion Middleware Control to Scale System Components” section in the Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition

You may also need to modify the port range used by Essbase Applications. These are managed separately from the rest of the ports.

To modify the port range:

1. At an operating system command prompt, navigate to the location of the opmn.xml file:

(UNIX) APPLICATIONS_BASE/instance/BIInstance/config/OPMN/opmn
(Windows) APPLICATIONS_BASE\Instance\BIInstance\config\OPMN\opmn

This is the port range used by Essbase Applications. These are allocated by the Essbase server as required. The Essbase server will use the ports, even if they are explicitly allocated elsewhere to another component. Therefore, it is important to not use the same port range as the rest of the Oracle Business Intelligence domain port range.

2. Modify the port range:

<port id="essbase-port-range" range="9500-9599"/>

3. Ensure that the OPMN server re-reads its configuration after changing the contents of opmn.xml:

(UNIX) APPLICATIONS_BASE/instance/BIInstance/bin/opmnctl reload
(Windows) APPLICATIONS_BASE\instance\BIInstance\bin\opmnctl reload

4. Restart the Essbase server:

(UNIX) APPLICATIONS_BASE/instance/BIInstance/bin/opmnctl restartproc process-type=Essbase
(Windows) APPLICATIONS_BASE\instance\BIInstance\bin\opmnctl restartproc process-type=Essbase

Oracle HTTP Server

"Manage Ports" section in the Oracle Fusion Middleware Administrator's Guide for Oracle HTTP Server

Oracle Enterprise Content Management Suite

”Modifying Server Configuration Parameters for Content Server” section in the Oracle Fusion Middleware Administrator's Guide for Oracle Internet Directory for information about changing the Oracle WebCenter Content Server

Oracle Internet Directory

”Configuring Server Properties” section or the ”Setting System Configuration Attributes by Using ldapmodify” section in the Oracle Fusion Middleware Administrator's Guide for Oracle Internet Directory

Oracle Virtual Directory

”Configuring Oracle Virtual Directory to Listen on Privileged Ports” section in the Oracle Fusion Middleware Administrator's Guide for Oracle Virtual Directory

Node Manager

”Overview of Node Manager Configuration” section in the Oracle Fusion Middleware Node Manager Administrator's Guide for Oracle WebLogic Server

4.6 Changing Passwords

Before you begin configuration, change the passwords for the various accounts to secure passwords. The following example describes the accounts. The procedures referenced in the Oracle Fusion Middleware guides describe using Fusion Middleware Control. These procedures also apply to Fusion Applications Control.

Table 4-4 Changing Passwords

Password Account

Description

Oracle Fusion Middleware administration for the Oracle WebLogic Server domain

During the Oracle Fusion Applications installation, you must provide a password for the Oracle Fusion Middleware administration user. By default, this administrator takes the Super User value you specified on the Identity Management page when creating the provisioning plan. The super user is described in the next row of this table.

Super User

The super user has the following privileges:

- Administrative privileges for all Oracle WebLogic Server domains and all middleware.

- Functional setup privileges for all Oracle Fusion applications.

- Administrative privileges to Oracle Fusion applications. These do not include transactional privileges. You use this username and password to access the Fusion Applications Control and the Oracle WebLogic Server Administration Console.

You can change the credentials using Fusion Applications Control or Oracle Platform Security Services (OPSS) scripts.

This user is specified on the Identity and Policy Management page of the Provisioning Wizard during installation. See ”Identity the Management Configuration” section in the Oracle Fusion Applications Installation Guide for information about this page. Installation establishes the same username and password for all the domains.

Oracle Identity Management

The password-reset-tool utility enables you to modify the passwords for the FAAdmin, IDROUser, IDRWUser, PolicyRWUser, and oamadminuser users.

Oracle Metadata Repository schema

Oracle Metadata Services (MDS) repository contains metadata for the Oracle Fusion Applications and some Oracle Fusion Middleware component applications. The schema passwords are stored in the Oracle database.

App IDs

Oracle Fusion Applications must rely on a type of credential known as the App ID. Each application has its own App ID which is initially provisioned for the application.

Node Manager

The Node Manager account authenticates the connection between a client (for example, the Administration Server) and Node Manager.

In an Oracle Fusion Applications installation, this user is specified on the Installation Location page of the Provisioning Wizard. See the ”Installation Location” section in the Oracle Fusion Applications Installation Guide for information about using this page.

BISystemUser

The BISystemUser account provides access to the Oracle Business Intelligence system components.

Related Links

The following documents provide additional information about the topics discussed in this section:

- For more information about Credential Store, see ”Managing the Credential Store” section in the Oracle Fusion Middleware Application Security Guide.

- For more information about changing schema passwords, see ”Changing Metadata Repository Schema Passwords” section in the Oracle Fusion Middleware Application Security Guide.

- For more information about Node Manager, see ”Specify Node Manager Username and Password” section in the Oracle Fusion Middleware Node Manager Administrator's Guide for Oracle WebLogic Server.

- For more information about default users, see ”Default Users and Passwords” section in the Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Enterprise Edition.

4.6.1 Changing Oracle Fusion Applications Passwords in the Oracle Database

As part of routine maintenance, it is security best-practice to reset the schema passwords in an environment according to a schedule. Use the Password Change Utility (PCU) for this purpose.

The PCU changes the passwords for critical schemas in the Fusion Applications Database. It also updates schema passwords stored outside of the database to match the new schema passwords in the database. Database schema passwords are stored outside the database in the Credential Store, in WLS data sources, and in other configuration files/repositories used by Fusion Middleware.

The PCU changes the passwords for all critical schemas at once. It cannot change the password for only a subset of schemas. However, it allows you to specify the existing password for a schema, so you can change the password for only one schema by specifying the existing passwords for all other schemas in the tool's input file and specifying a new password for the schema you want to modify.

The PCU can be run interactively or non-interactively. The steps required for running interactively and non-interactively are different and are explained in the following sections. Running the PCU interactively is simple, but may require more user input. Running the PCU non-interactively is more suitable for routine tasks and requires less user input.

The PCU can be run in a special mode in which it only ensures that all critical schemas are registered in the credential store. This special mode is called CSF-only mode. The CSF-only mode is not documented in detail in this document, because it is mainly used to ensure that the credential store is up-to-date before running the RUP Installer to upgrade to a new Fusion Applications release level. Running the PCU in CSF mode is documented in detail in the ”Register Database Schema Information” section of the Upgrade Guide. Running the PCU non-interactively in CSF-only mode is possible, but is not currently documented.

For most configurations, you can run the PCU on any Fusion Applications Middle Tier host. You must run the PCU on BI host also.

Run the PCU to change the database schema passwords and update other artifacts/repositories to reflect the new schema passwords. The PCU prompts you for the password for decrypting the input file. Password can also be passed in a non-interactive way.

The PCU can be used to update DB, WLS data sources, and IDM data sources individually using different targets. In the default mode, only FAMW and IDM targets are run.

At a high level, running the PCU consists of the following six steps described in the sections that follow.

4.6.1.1 Step 1: Start/Stop the Oracle Fusion Applications Environment

To start/stop the environment before running the PCU:

1. Start/stop all incoming user requests by stopping the Oracle HTTP server. See Section 4.4.5.1 and Section 4.4.5.2.

2. Start up only Admin Servers. See Section 4.4.4.1.

4.6.1.2 Step 2: Create a template input file using the templateGen utility

Run the templateGen utility to create template input files appropriate for your current Fusion Applications Release version. The templateGen utility auto-fills most of the values from a process called auto-discovery of environment variables and the database wherever possible.

The templateGen utility generates template input files for both STANDARD mode and CSF mode, but only the STANDARD-mode template file is used for changing database schema passwords.

The usage for templateGen utility is as follows:

./templateGen.sh -appbase <APPTOP>

The template files are generated under $APPLICATION_CONFIG/lcm/admin/pcu directory.

Note:

In local domain configurations, the BIDomain section is not auto-populated. The users must manually input this section because the BIInstance directory is not available in $APPLICATION_CONFIG directory, as this can reside in a different machine altogether.

4.6.1.3 Step 3: Create an input file using the iniGen utility

The generation of INI file is a pre-requisite for PCU, as the PCU accepts only encrypted INI file as input. You can generate encrypted INI file, which can be later fed to the PCU in different modes.

The INI file can be generated in two ways: interactive and non-interactive modes. In interactive mode, you provide the input over the standard console. In non-interactive mode, you prepare a clear text INI file and encrypt it using some standard encryption tool. This process generates a security-compliant encrypted INI file.

Note:

The generated INI file is located in the $APPTOP/instance/lcm/admin/pcu directory.

The PCU relies on an input configuration file that specifies the new database schema passwords and other important information about your Fusion Applications installation. This input file is generated by the iniGen utility using template files produced by the templateGen utility. The iniGen utility writes password values to the input configuration file in encrypted format. It writes other values in plain text.

As part of running the PCU non-interactively, a temporary plain text file is created and is encrypted immediately. The file is later decrypted and the contents are provided as input to iniGen. Oracle provides a tool named lcmcrypt to perform encryption and decryption on all platforms. You can use an alternative encryption tool if you prefer. If you use an alternative encryption tool (like gpg provided by Linux), you are responsible for using it properly. This document explains how to perform the required encryption/decryption using lcmcrypt.

During encryption, the lcmcrypt tool reads the file passed to it and encrypts the file contents using the password supplied. It generates an encrypted file (.enc extension) in the same directory as that of the input file and deletes the text file (provided as input).

During decryption, the lcmcrypt tool reads the supplied encrypted file and decrypts the file contents using the password supplied. The decrypted text is output through STDOUT and a text file is not generated.

The password complexity validation rules can also be applied to the passwords provided for encryption and decryption using the lcmcrypt tool. The validation rules are similar to that of the rules used for schema passwords. For more information, see Section 4.6.2.

The iniGen utility creates an Oracle Wallet file in addition to the encrypted input file. The Oracle Wallet file contains the same set of schemas and schema passwords as the encrypted input file. The Oracle Wallet file is used internally by Oracle in hosted environments. The wallet is stored at:

<APPTOP>/instance/lcm/admin/pcu/wallets/<templatetype>/ewallet.p12

The templatetype is derived from the templatefile argument passed while running iniGen.

The argument -validatefile is passed to iniGen to validate the encrypted INI file generated by the iniGen utility. If this argument is passed, the script accepts a master password.

The following checks are performed to validate the INI file:

1. Verify that all the sections in the INI file and all the fields in each section match the corresponding template file.

2. Verify that all the password fields in the INI file are decryptable with the master password provided.

For example, in Interactive mode:

(UNIX) ./iniGen.sh -appbase /APPTOP/ - validatefile standard_encrypted.ini

(Windows)iniGen.cmd -appbase c:\AT -validatefile standard_encrypted.ini -program

For example, in nonInteractive mode:

(UNIX) echo password | ./iniGen.sh -appbase /APPTOP/ - validatefile standard_encrypted.ini

(Windows) echo password | iniGen.cmd -appbase c:\AT -validatefile standard_encrypted.ini

The following are the steps to run Password Change Utility in non Interactive mode:

Note:

All these commands must be run from APPLICATIONS_BASE/fusionapps/applications/lcm/util/bin.

1. Run templateGen.cmd.
templateGen.cmd -appbase APPLICATIONS_BASE

2. Make a copy of csf_template.ini from the APPLICATIONS_CONFIG/lcm/admin/pcu directory.

3. Manually edit csf_plain.ini as follows:
Set the master_password property to the Master Orchestration Password.

For each line that contains #text# or #password#, replace #text# or #password# with the correct value for your environment. This password must be a minimum of 8 characters long and it must contain at least one alphabetic character and at least one numeric or special character.

Note:

To prevent incorrect results, do not alter csf_plain.ini beyond these changes.

4. Encrypt the text file.
echo welcome1 | lcmcrypt.cmd -nonInteractive -encrypt -inputfile complete_directory_path\csf_plain.ini

5. Decrypt the text file.
echo welcome1| lcmcrypt.cmd -nonInteractive -decrypt -inputfile

4.6.1.4 Step 4: Use Password Change Utility with DB Target

When you run the PCU with the DB target, the utility does not update the WLS data sources. The DB updates include opening the profile and changing the schema passwords.

The following is the command to use this utility:

schemaPasswordChangeTool.sh -appbase <location of appltop> -inputfile <path of input file> -target <target from jobs.xml>

For example,

(UNIX) ./schemaPasswordChangeTool.sh -appbase /scratch/aime/work/APPTOP -inputfile $APPTOP/instance/lcm/admin/pcu/config/input1335820380736.ini -target DB

(Windows) schemaPasswordChangeTool.cmd -appbase c:\at -inputfile %APPTOP%\instance\lcm\admin\pcu\config\input1335829380736.ini -target DB

4.6.1.5 Step 5: Use Password Change Utility with VALIDATE_SCHEMAS Target

When you run the PCU with the VALIDATE_SCHEMAS target, the utility finds the status of all the schemas. This target acts as a health checker before and after running the PCU.

Currently, the following statuses are supported:

- lock_outs

- wrong_passwords

- schema_not_exists.

The following is the command to use this utility:

schemaPasswordChangeTool.sh -appbase <location of appltop> -inputfile <path of input file> -target <target from jobs.xml>

For example,

(UNIX) ./schemaPasswordChangeTool.sh -appbase /scratch/aime/work/APPTOP -inputfile $APPTOP/instance/lcm/admin/pcu/config/input1335820380736.ini -target VALIDATE_SCHEMAS

(Windows) schemaPasswordChangeTool.cmd -appbase c:\at -inputfile %APPTOP%\instance\lcm\admin\pcu\config\input1335829380736.ini -target VALIDATE_SCHEMAS

4.6.1.6 Step 5: Use Password Change Utility in STANDARD Mode

When you run the PCU in the default mode, it runs all the updaters defined in the jobs.xml file for IDM and FAMW targets.

The following is the command to use this utility:

(UNIX) schemaPasswordChangeTool.sh -appbase <location of appltop> -inputfile <path of input file>

(Windows) schemaPasswordChangeTool.cmd -appbase <location of appltop> -inputfile <path of input file>

For example, in Interactive Mode:

(UNIX) ./schemaPasswordChangeTool.sh -appbase /scratch/aime/work/APPTOP -inputfile $APPTOP/instance/lcm/admin/pcu/config/input1335820380736.ini

(Windows) schemaPasswordChangeTool.cmd -appbase c:\at -inputfile %APPTOP%\instance\lcm\admin\pcu\config\input1335820380736.ini

For example, in nonInteractive Mode:

(UNIX) echo pa55w0Rd | ./schemaPasswordChangeTool.sh -appbase /scratch/aime/work/APPTOP -inputfile  $APPTOP/instance/lcm/admin/pcu/config/input1335820380736.ini -nonInteractive

(Windows) echo pa55w0Rd | schemaPasswordChangeTool.cmd -appbase c:\at -inputfile %APPTOP%\instance\lcm\admin\pcu\config\input1335820380736.ini -nonInteractive

4.6.1.7 Step 6: Use Password Change Utility with RESET_PROF Target

When you run the PCU with RESET_PROF target, the database profile modifications done to loosen the profile after running the DB target are restored.

The following is the command to run this utility:

schemaPasswordChangeTool.sh -appbase <location of appltop> -inputfile <path of input file> -target <target from jobs.xml>

For example:

(UNIX) ./schemaPasswordChangeTool.sh -appbase /scratch/aime/work/APPTOP -inputfile  $APPTOP/instance/lcm/admin/pcu/config/input1335820380736.ini -target RESET_PROF

(Windows) schemaPasswordChangeTool.cmd -appbase \scratch\aime\work\APPTOP -inputfile $APPTOP\instance\lcm\admin\pcu\config\input1335820380736.ini -target RESET_PROF

4.6.2 Validating Password Complexity

The password complexity validation enables you to set schema passwords which comply with the pre-defined password complexity policies. Password complexity policies define the characteristics with which a password must be defined. For example, the password must contain a combination of at least two numeric characters, two alphabetic characters, and two special characters can be a password complexity policy.

Password complexity validation function must be defined for each schema.

For password complexity validation to be enabled, the password complexity functions along with the helper functions must be installed in the Fusion Applications environment. When the password complexity validation is enabled, each schema password is validated. If a password complexity validation function is not defined for a specific schema, the PCU uses the existing Java logic to validate the schema password.

To verify if a password complexity validation function is defined for a given schema:

select p.limit
from dba_users u, dba_profiles p
where u.profile=p.profile
and u.username = <valid_schema_name>
and p.resource_name= 'PASSWORD_VERIFY_FUNCTION';

If limit is ”NULL”, no validation function is defined.

If limit is ”DEFAULT”, run the following SQL query to get the validation function from the DEFAULT profile:

select p.limit
from dba_profiles p
where p.profile = 'DEFAULT'
and p.resource_name= 'PASSWORD_VERIFY_FUNCTION';

p.limit is not set to a null value in dba_profiles if no validation function is defined. Instead, it is set to ”NULL” string.

The return value of p.limit SQL statement specifies the name of the password complexity validation function. For example,
adm_dba_verify_function.

To use the password complexity validation function:

You must install a helper function named adm_dba_validate_pw. The helper function takes the following parameters as input:

- Name of the password complexity validation function

- The schema name

- The proposed new schema password to validate

- The existing schema password.

The helper function invokes the password complexity validation function and returns the string 'TRUE' if the new schema password complies with the password complexity rules, or returns the string 'FALSE' if the new password does not comply with the complexity rules.

Note:

The password complexity validation function works standalone, because if no validation function is defined at the DB level, the PCU falls back to the existing password complexity validation rules implemented in Java.

4.6.3 Running PCU from any Directory Outside APPTOP

The Password Change Utility has the capability to run outside of APPTOP. It can be run from any directory outside the PCU installation.

The -codebase argument enables you to run the PCU from any directory. This is an optional argument that can be passed to the PCU. If this argument is provided, the required binaries and configuration files are loaded from the temporary directory. If this argument is not provided, the codebase defaults to APPTOP.

Note:

When you run PCU from any directory other than its home directory, the only mode supported is CSF mode; STANDARD mode is not supported.

Note:

Even when you run the PCU from a directory other than its home directory, it still needs to be run from a machine on which APPTOP is mounted, because all the dependencies are fetched from APPTOP machine.

You must first set the following:

setenv CODE_BASE "/scratch/aime/pcu"
setenv APP_BASE "/scratch/aime/work/APPTOP"
setenv JAVA_HOME "$APP_BASE/fusionapps/jdk6"

Dependencies:

Apart from the PCU jar file, you need to depend on the following binaries to run PCU from any directory. If one of the dependent jar files needs an update, it must be applied before running the schemaPasswordChangeTool. The following are the dependent jar files:

- $APP_BASE/webtier_mwhome/oracle_common/modules/oracle.pki_11.1.1/oraclepki.jar

- $APP_BASE/fusionapps/odi/oracledi.sdk/lib/ant.jar

- $APP_BASE/fusionapps/odi/oracledi.sdk/lib/commons-lang-2.2.jar

- $APP_BASE/fusionapps/odi/oracledi.sdk/lib/ojdl.jar

- $APP_BASE/fusionapps/applications/lcm/util/lib/oracle-provisioning-anttasks.jar

- $APP_BASE/fusionapps/wlserver_10.3/server/lib/ojdbc6.jar

- $APP_BASE/fusionapps/odi/oracledi.sdk/lib/spring-core.jar

- $APP_BASE/fusionapps/odi/oracledi.sdk/lib/odi-core.jar

- $APP_BASE/fusionapps/oracle_common/modules/oracle.jps_11.1.1/jps-manifest.jar

- $APP_BASE/fusionapps/oracle_common/modules/oracle.jps_11.1.1/jps-api.jar

- $APP_BASE/fusionapps/oracle_common/modules/oracle.pwdgen_11.1.1/pwdgen.jar

- $APP_BASE/fusionapps/applications/lcm/credstoreutil/lib/credstoreutil.jar

- /u01/lcm/schemaextension/credstoreutil_extension.jar

When you run PCU with -codebase, templates are generated in the following directory:

$CODE_BASE/fusionapps/applications/lcm/util/config/

When you run PCU with -codebase option, logs are generated in the following directory:

$CODE_BASE/fusionapps/applications/lcm/util/logs/

templateGen:

./templateGen.sh -appbase $APP_BASE -codebase $CODE_BASE

iniGen Interactive:

./iniGen.sh -appbase $APP_BASE -codebase $CODE_BASE

iniGen nonInteractive:

cat /APPTOP/instance/lcm/admin/pcu/standard_plain.ini | ./iniGen.sh -appbase $APP_BASE -nonInteractive -outputfile /APPTOP/instance/lcm/admin/pcu/standard_encrypted.ini -codebase $CODE_BASE

schemaPasswordChangeTool:

echo welcome1 | ./schemaPasswordChangeTool.sh -appbase $APP_BASE -inputfile /APPTOP/instance/lcm/admin/pcu/standard_encrypted.ini -codebase $CODE_BASE

echo welcome1 | ./schemaPasswordChangeTool.sh -appbase $APP_BASE -inputfile /APPTOP/instance/lcm/admin/pcu/csf_encrypted.ini -codebase $CODE_BASE

echo welcome1 | ./schemaPasswordChangeTool.sh -appbase $APP_BASE -inputfile /APPTOP/instance/lcm/admin/pcu/system_user_encrypted.ini -codebase $CODE_BASE

4.6.4 Rendering PCU Offline

You can also run the PCU in offline mode. Running PCU in offline mode enables you to run offline updates when necessary. The steps to invoke PCU in offline mode are explained in the following steps.

Prerequisites:

1. Shut down all the Admin and Managed servers of Fusion Applications and IDM except IDM Admin Server.

Note:

LDAP and DB need to be up and running while running the PCU.

2. (Optional): Run PCU in validate_schemas mode so that the existing system in its current shape is good.

./schemaPasswordChangeTool.sh -appbase /APPTOP/ -inputfile std_enc.ini -target VALIDATE_SCHEMAS

You can also run SQL queries against Fusion Applications and IDM to perform the same operation.

Executing PCU in Offline Mode:

When you execute PCU in offline mode, it runs the jobs in the following order:

1. echo <master_pwd> | ./schemaPasswordChangeTool.sh -appbase <applications_base> -inputfile <enc_inp_file> -target OFFLINE

2. Change default profile to unlimited.

3. Change DB passwords.

4. Change LDAP passwords.

5. Change data sources of IDM online and shutdown the IDM Admin server.

6. Change data sources of FA offline.

7. Change ESSWallet password.

8. Run ESSBase updater (one of BI component which do not need BI to be up).

9. Generate BI RPD file.

10. Using FASS bring the BI admin server up.

11. Deploy the rpd generated in above step to the Admin Server.

12. Using FASS stop the BI Admin Server.

13. Change ODI password.

14. Run IIR Updater.

15. Use FASS to bring up the search server(search_server1).

16. Update the search schema FUSION_DISCUSSIONS_CRAWLER in the search database using the search admin api.

17. Use FASS to bring down the search server(search_server1).

After invoking PCU in Offline mode:

1. Start all the managed and admin servers of FA and IDM.

2. (Optional): Run PCU in validate_schemas mode so that the system modified with new schema passwords is assured to be in a good shape.

./schemaPasswordChangeTool.sh -appbase /APPTOP/ -inputfile std_enc.ini -target VALIDATE_SCHEMAS

4.7 Managing the Oracle Database

To manage your Oracle database:

1. Start the Oracle database instance, if not already started. See Section 4.4.3.

2. Review database initialization parameters. Modify initialization parameters as needed. See Section 4.7.1.

3. Review your database storage structures: tablespaces and data files, online redo log files, and control files. Create or modify storage structures as needed. See Section 4.7.2.

4. Review memory allocation and adjust as needed. See Section 4.7.3.

5. Review, unlock, and reset passwords for predefined database users as needed. Create new users, and assign privileges and roles to them as needed. See Section 4.7.4.

6. Create or review the backup strategy for the database and back up the database. See Chapter 15, "Backing Up and Recovering Oracle Fusion Applications.".

4.7.1 Viewing and Modifying Initialization Parameters

Managing an Oracle instance includes configuring parameters that affect the basic operation of the Oracle instance. These parameters are called initialization parameters. The Oracle instance reads initialization parameters from a file at startup.

After being read from a file, initialization parameters are retained in memory, where the values for many of them can be changed dynamically. There are two types of parameter files. The type of file used to start the instance determines if dynamic initialization parameter changes persist across database shutdown and startup. The parameter file types are:

- Server parameter file
The server parameter file is a binary file that can be written to and read by the database. It must not be edited manually. It is stored on the host system on which Oracle Database is running. Changes are made when you use Database Control to modify one or more initialization parameters, or when Oracle Database itself makes changes for self-tuning purposes. Any changes to it persist across database shutdown and startup operations.

- Text initialization parameter file
A text initialization parameter file is a text file that can be read by the Oracle instance, but it is not written to by the instance. You can change a text initialization parameter file with a text editor, but changes do not take effect until you restart the Oracle instance. When you start the instance with this type of file, you can still change many initialization parameters dynamically with Database Control, but only for the current instance. Unless you also edit the text initialization parameter file and make the same change, the change is lost when you restart the database instance.

As the number of database users increases and the workload increases, you might have to alter some initialization parameters. You can make these changes using the Initialization Parameter page in Oracle Enterprise Manager Database Control, accessible from the Database Configuration section of the Server tab.

The following table lists specific initialization parameters that you should set and their recommended values.

Table 4-5 Initialization Parameters

Parameter

Recommended Values

CONTROL_MANAGEMENT_PACK_ACCESS

Set this parameter to DIAGNOSTIC+TUNING (default) or DIAGNOSTIC to enable Automatic Database Diagnostic Monitor (ADDM).

STATISTICS_LEVEL

Set this parameter to TYPICAL (default) to enable the automatic performance tuning features of Oracle Database, including Automatic Workload Repository (AWR) and ADDM.

Related Links

The following document provides additional information about the topics discussed in this section:

- For more information about viewing and modifying initialization parameters, see the ”Viewing and Modifying Initialization Parameters” section in the Oracle Database 2 Day DBA.

4.7.2 Managing Database Storage Structures

Oracle Database is made up of physical and logical structures. Physical structures can be seen and operated on from the operating system, such as the physical files that store data on a disk.

Logical structures are created and recognized by Oracle Database and are not known to the operating system. The primary logical structure in a database, a tablespace, contains physical files. The applications developer or administrator may be aware of the logical structure, but may not be aware of the physical structure. The database administrator (DBA), however, must understand the relationship between the physical and logical structures of a database.

Oracle Database can automate much of the management of its structure. To view a database storage structure using Oracle Enterprise Manager Database Control, go to the Storage section of the Server tab, where you can access the following storage options:

- Control files

- Tablespaces

- Temporary tablespace groups

- Datafiles

- Rollback segments

- Redo log groups

- Archive legs

- Disk groups

- Other storage structures

Related Links

The following document provides additional information about the topics discussed in this section:

- For more information about managing database storage structures, see the ”Managing Database Storage Structures” chapter in the Oracle Database 2 Day DBA.

4.7.3 Managing Memory

Memory management involves maintaining optimal sizes for the Oracle instance memory structures as demands on the database change. The memory that must be managed are the System Global Area (SGA) memory and the instance Program Global Area (PGA) memory. The instance PGA memory is the collection of memory allocations for all individual PGAs.

Oracle Database can manage the SGA memory and instance PGA memory automatically. You designate only the total memory size to be used by the instance, and Oracle Database dynamically exchanges memory between the SGA and the instance PGA as needed to meet processing demands. This capability is referred to as automatic memory management. In this memory management mode, the database also dynamically tunes the sizes of the individual SGA components and the sizes of the individual PGAs.

To have more direct control over the sizes of the SGA and instance PGA, use the Memory Advisors page of Oracle Enterprise Manager Database Control to disable automatic memory management and enable automatic shared memory management. With automatic shared memory management, you set target and maximum sizes for the SGA. Oracle Database then tunes the total size of the SGA to your designated target, and dynamically tunes the sizes of all SGA components. In this memory management mode, you also implicitly enable automatic PGA memory management. With automatic PGA memory management you set a target size for the instance PGA. The database then tunes the size of the instance PGA to your target, and dynamically tunes the sizes of individual PGAs.

If you want complete control of individual SGA component sizes, then use the Memory Advisors page of Oracle Enterprise Manager Database Control to disable both automatic memory management and automatic shared memory management. This is called manual shared memory management. In this mode, you set the sizes of several individual SGA components, thereby determining the overall SGA size. You then manually tune these individual SGA components on an ongoing basis. Manual shared memory management mode is intended for experienced DBAs only. Note that in this mode, automatic PGA memory management remains enabled.

To manage memory, use the Memory Advisor page in Database Control, accessible from the Database Configuration section of the Server tab.

Related Links

The following document provides additional information about the topics discussed in this section:

- For more information about memory management, see the ”Managing Memory” section in the Oracle Database 2 Day DBA.

4.7.4 Administering User Accounts

For users to access your database, you must create user accounts and grant appropriate database access privileges to those accounts. A user account is identified by a user name and defines the attributes of the user, including the following:

- Authentication method

- Password for database authentication

- Default tablespaces for permanent and temporary data storage

- Tablespace quotas

- Account status (locked or unlocked)

- Password status (expired or not)

When you create a user account, you must not only assign a user name, a password, and default tablespaces for the account, but you must also do the following:

- Grant the appropriate system privileges, object privileges, and roles to the account.

- If the user will be creating database objects, then give the user account a space usage quota on each tablespace in which the objects will be created.

In addition, you may want to create user accounts that are used by applications only, such as Fusion Applications. Users do not log in with these accounts; instead, applications use these accounts to connect to the database, and users log in to the applications. This type of user account avoids giving application users the ability to log in to the database directly, where they could unintentionally cause damage.

To administer user accounts using Oracle Enterprise Manager Database Control, go to the Security section of the Server tab, where you can access users and roles.

Related Links

The following document provides additional information about the topics discussed in this section:

- For more information about administering user accounts, see the ”Administering User Accounts and Security” chapter in the Oracle Database 2 Day DBA.

4.8 Patching

It is necessary to perform various maintenance actions on your applications, their middleware dependencies, and their database components. Maintenance actions include fixing issues that affect the way the applications perform, adding new functionality and features, updating to a higher maintenance level, or providing interoperability to new technology stacks. Patches may be required for maintenance of middleware artifacts, database artifacts, or both. The following table describes the types of patching and provides information on where to find related documentation.

Table 4-6 Patching

Type of Patching

Description

Documentation for Patching

Oracle Fusion Applications

The Oracle Fusion Applications Patching Framework provides the tools needed to apply updates to Oracle Fusion Applications software between major or patch set releases. These tools manage the processes for applying individual patches, patch sets, and release update packs.

Oracle Fusion Applications Patching Guide

Oracle Fusion Middleware

OPatch patches any Oracle Fusion Middleware component, except Oracle WebLogic Server. For Oracle WebLogic Server, use Smart Update.

See Related links

Oracle Database

Oracle Universal Installer and OPatch manage the patching for Oracle database and third-party software.

See Related Links

Related Links

The following documents provide additional information about the topics discussed in this section:

- For more information about patching middleware artifacts, see Oracle Fusion Middleware Patching Guide.

- For information about managing patching for Oracle database, see Oracle Universal Installer and OPatch User's Guide for Windows and UNIX.

4.9 Managing Oracle Fusion Applications-Specific Labels in the Oracle Metadata Repository

The Oracle Metadata Repository (MDS Repository) contains metadata for Oracle Fusion Middleware components. It can also contain metadata about the configuration of Oracle Fusion Middleware and metadata for your applications. For general instructions on managing the metadata for Oracle Fusion Middleware components in the Oracle Metadata Repository, see the ”Managing the Metadata Repository” chapter in the Oracle Fusion Middleware Administrator's Guide.

As a part of MDS Repository management, you work with metadata labels. You select a version for the repository to select a particular version of each object from a metadata repository partition. Also, if you take actions that affect the MDS Repository, such as deploying, patching, or doing some customizations, you can potentially put the repository into a broken state. When this happens, you can rollback to a previous label. For example, when you roll back to a label, all objects within that repository move to that state. To manage labels, note the following prefixes for Oracle Fusion Applications in the MDS Repository:

- postDeployLabel_ for labels created by MDS Repository at deployment time

- Creation_ for labels created by Oracle Fusion Middleware Extensions for Applications (Applications Core) in the MDS Repository

- PreMerge_ for labels created by Applications Core in the MDS Repository during sandbox creation.

- composer_PostMerge_ for labels created by Applications Core in the MDS Repository during a sandbox publish operation

- mds_ for labels created during Flexfield changes applied during a patch

- soa_ for labels created during SOA deployments

- composer_ for labels created by Oracle Composer when using the Save and Label button.

Related Links

The following documents provide additional information about the topics discussed in this section:

- For more information about Save and Label button, see ”Create Labels On Saving Application Customizations” in the Oracle Fusion Middleware Developer's Guide for Oracle WebCenter Portal.

- For more information about managing labels, see the ”Managing the Metadata Repository” section in the Oracle Fusion Middleware Administrator's Guide.

4.10 Modifying Oracle Application Development Framework Connections in Oracle Fusion Applications

A connection configuration (connections.xml) contains information that a client application uses to identify the Oracle Application Development Framework (Oracle ADF) application module's deployment scenario. For more information about modifying the configuration of a single application, see the following sections in the Oracle Fusion Middleware Administrator's Guide for Oracle Application Development Framework:

- How to Modify Connection Configurations

- How to Modify ADF Connections Using MBeanConfiguring Application Properties Using the MBean Browser

In an Oracle Fusion Applications environment, you may need to change the internal and external settings for several applications. For example, if there was an outage of the Oracle Fusion Customer Relationship Management (Oracle Fusion CRM) applications due to a lost Oracle HTTP Server host, then you would need update all the applications that depend on the Oracle Fusion CRM-provided web services. If all the applications in an Oracle WebLogic Server domain use the same connections.xml, which is the default behavior after provisioning, you can make this edit in one place using Fusion Applications Control.

To modify the connections for all the applications in an Oracle WebLogic Server domain using Fusion Applications Control:

1. From the navigation pane, expand the farm and then WebLogic Domain.

2. Click the domain.
The Oracle WebLogic Server Domain home page displays.

3. From the WebLogic Domain menu, choose ADF Domain Configuration.
The ADF Common Properties page displays.

4. In the Property Sets table, click the property set to modify, and in the Details for Property Set table, modify the property values.
These property sets and properties reside in the adf-domain-config.xml file, and are used in the ELs in the connections.xml file.

5. Click Save.

4.11 Modifying Oracle Data Integrator Configuration

Oracle Data Integrator (ODI) is installed with the following product families:

- Oracle Fusion Customer Relationship Management

- Oracle Fusion Human Capital Management

- Oracle Fusion Supply Chain Management

The Oracle Fusion applications use Oracle Application Development Framework and Oracle SOA Suite, which in turn use ODI for bulk data movement requirements. This section describes how to modify key aspects of ODI configuration without interrupting the service of the applications.

4.11.1 Editing the Oracle Data Integrator Topology for Database Endpoint Changes

ODI moves data between two databases. In some cases, a database endpoint changes or the JDBC password changes for security reasons. When these types of changes occur, you must modify the configuration of the database topology.

To modify the database topology:

1. Log into Oracle Data Integrator Console.

http://product_familyinternal.domain:port/odiconsole

where product_familyinternal.domain. port is the host and domain of the Oracle HTTP Server or a Load Balancer.

2. From the Browse pane, expand Topology and then Data Servers.

3. Select the database server and click the Edit icon ().
The Edit Data Server page displays.

4. Scroll to the JDBC Details section at the bottom of the page.

5. Modify the JDBC fields for the endpoint:

Field

Description

JDBC Driver

The JDBC driver for the data source connection. The value in this field must conform to the database specifications.

JDBC URL

The JDBC URL for the data source connection in the format of jdbc:oracle:thin:@//DB_host_name.domain/sid.

User

The Oracle Database schema name (user name) to log into the database.

JDBC Password

The password for the user.

6. Click Save.

4.11.2 Modifying ODI Agent Host and Port Configuration

The ODI agent connects to a master repository and connects to different technologies to move data. If the ODI agent host or port configuration has been modified in Oracle WebLogic Server, then you reflect those changes in ODI.

To modify the configuration of an agent:

1. Log into Oracle Data Integrator Console.

http://product_familyinternal.domain:port/odiconsole

where product_familyinternal.domain. port is the host and domain of the Oracle HTTP Server or a Load Balancer.

2. From the Browse pane, expand Topologies, Agents, and then Physical Agents.

3. Select an agent click the Edit icon ().
The Edit Physical Agent page displays.

4. In the Definition section, modify the Host Name and Port Number fields.

5. Click Save.

4.12 Bulk Updating General User Preferences

Using the Functional Setup Manager UI, a system administrator can update general User Preference settings for all users in the system. Only the attributes that the administrator chooses to update will be written to the user profiles; values that will not be changed will be marked as ”default.”

1. Access the Functional Setup Manager. (On any page where you have appropriate access, the following options will appear: Navigator > Tools > Setup and Maintenance or Administrator > Setup and Maintenance.)
Search for ”Set User General Preferences.”

2. Click the Go to Task icon. The Global Admin Preferences settings screen is displayed as shown below.

3. Adjust any of the settings that should apply to all current users in the system, and click Save.

Note:

If new users are subsequently added to the system, the default settings must be applied again to include them.

The general settings available are:

- Fusion Applications Language and Display Language

- Date Format

- Time Format

- Number Format

- Currency,

- Time Zone

For more User Preferences information, see ”How to Use the Most Common Preferences” in the Oracle Fusion Applications Developer's Guide.

Note:

Users will still be able to change their settings from the Personalization menu.

5 Securing Oracle Fusion Applications

This chapter explains the security features available to all Oracle Fusion applications. It explains the enterprise identity store, identity provisioning, authorization policies, roles, data masking, securing Web services, and customizing security.

This chapter contains the following topics:

- Section 5.1, "Introduction to Security"

- Section 5.2, "Provisioning Identities"

- Section 5.3, "Managing Authorization Policies"

- Section 5.4, "Masking Data"

- Section 5.5, "Securing Web Services"

- Section 5.6, "Hardening Tasks"

- Section 5.7, "Security Store Management"

- Section 5.8, "Password and Certificate Management"

- Section 5.9, "Related Links"

The high-level information presented in this chapter includes links to other documents where the topic is explained in detail.

For additional information about application security, see the Oracle Fusion Applications security guides.

5.1 Introduction to Security

Oracle Fusion Applications use the services of the Oracle Platform Security Services (OPSS) to secure applications.

OPSS is a security platform that provides enterprise product development teams, systems integrators, and independent software vendors with a standards-based enterprise-grade security framework for Java SE and Java EE applications. Using OPSS, Oracle Fusion Applications benefit from the same, uniform security, identity management, and audit services across the enterprise.

The intended audience for this chapter are application security administrators and system security administrators.

Oracle Fusion Applications provisioning sets up the security infrastructure, including:

- the identity store

- authorization policies

- enterprise roles

- data masking

- setting protected URIs for the infrastructure to work as expected

For details about security tasks, including creating and managing users and roles, function and data security, audit, and compliance tasks, see the Oracle Fusion Applications security guides.

5.2 Provisioning Identities

Provisioning as a whole encompasses all the operations required to install, configure, and deploy applications product offerings. Identity provisioning is a subset of this process which populates the users and groups needed for deployment and ongoing administration.

This section contains the following topics:

- Section 5.2.1, "Identity Provisioning Concepts"

- Section 5.2.2, "WebLogic Authenticators and the Primary Identity Store"

- Section 5.2.3, "Provisioning Steps"

- Section 5.2.4, "Best Practices for the Administrator Groups"

- Section 5.2.5, "Managing Identities after Deployment"

5.2.1 Identity Provisioning Concepts

During the identity provisioning stage of installation, Oracle Fusion Applications require the existence of certain users with specific privileges. These administrative users reside in a secure, central repository called the identity store. This section explains the phases of identity provisioning, what users or groups are needed for provisioning, and the users and groups that exist at the end of the process.

This section contains the following topics:

- Section 5.2.1.1, "Administrators For Fusion Applications"

- Section 5.2.1.2, "Two Types of Users During Provisioning"

5.2.1.1 Administrators For Fusion Applications

The application provisioning process bootstraps the provisioned environment with two administrator groups for each application family.

These two administrator groups are:

- A system administrator
A directory group representing the WebLogic Server domain administrators for all the domains.

- An application administrator
A directory group with an assigned enterprise role reflecting all the application roles and delegation privileges for all the applications in a given family.

The purpose of creating these "Super Administrators" during provisioning is to enable ongoing administration and/or delegation privileges.

The above process facilitates separation of duties between system administration and application administration responsibilities, but you are free to assign the same user to both hierarchies ("system admin" and "application admin").

Table 5-1 shows the groups that are created for each application family:

Table 5-1 Provisioned Administrator Groups

Product Family/Product

System Administrator Group

Application Administrator Group

Oracle Fusion Supply Chain Management

FSCMSysAdmin

FSCMAppAdmin

Oracle Fusion Customer Relationship Management

CRMSysAdmin

CRMAppAdmin

Oracle Fusion Human Capital Management

HCMSysAdmin

HCMAppAdmin

Oracle Fusion Financials

FINSysAdmin

FINAppAdmin

Oracle Fusion Procurement

PRCSysAdmin

PRCAppAdmin

Oracle Fusion Project

PRJSysAdmin

PRJAppAdmin

Oracle Fusion Incentive Compensation

OICSysAdmin

OICAppAdmin

In addition a single user, known as the super user, is set up to belong to all the administrator groups. That user becomes the administrator for all middleware and the application administrator for all product families.

Figure 5-1 shows the relationship between these groups.

Figure 5-1 Super-User and Administrators

5.2.1.2 Two Types of Users During Provisioning

It is important to distinguish between the two types of super-administrators that exist in the provisioning process.

- Pre-seeded bootstrap user

- Designated super-user

In the context of the pre-seeded user, provisioning employs an identity known as the App ID that is required to bootstrap the WebLogic domains. The pre-configuration phase of provisioning automatically generates the credential needed for this App ID user.

In the context of the designated super user, during the interview phase of provisioning, you are asked to specify the user ID of the designated "real" user who will be set up as the Middleware Administrator and Functional Setup Manager.

For example, if you want a "real" user such as "cn=john.doe,cn=users,cn=acme,cn=com" to be the super user, provide "john.doe" as the user ID during provisioning. This user will be set up as the super user in the identity store.

Note:

It should be emphasized that the identity seed data that is used in the LDIF file to configure the WebLogic domains does not use real user DNs.

5.2.2 WebLogic Authenticators and the Primary Identity Store

When Oracle WebLogic Server is installed, the default authenticator is based on an embedded LDAP store.

As part of Oracle Fusion Applications provisioning, the default authenticator based on the embedded LDAP is deleted. Upon completion of Oracle Fusion Applications provisioning, the primary and only identity store will be your external LDAP store. The bootstrap identity used to configure the domains during the provisioning process will be pre-seeded in the external LDAP through the LDIF file, as explained in Section 5.2.1.2.

5.2.3 Provisioning Steps

The identity provisioning process consists of distinct phases.

In the interview phase, Provisioning Wizard collects the following information:

- The DN of the user designated as the super user. This user must already exist in the identity store.

- Whether the system administrators group exists or must be created.

- If the group exists, the DN of the group.

- The LDAP authenticator, either Oracle Internet Directory (OIDAuthenticator) or Oracle Virtual Directory (OVDAuthenticator) that will serve as the LDAP identity store.

The next step of the process verifies that the designated super-user exists in the identity store.

The system administrator group is created if needed, and the super user is made a member of the group.

Next, the application domains are created, the LDAP authenticator is enabled, and the WebLogic domain is started up.

Following configuration, the system administrator groups are assigned the appropriate family-level enterprise roles.

At the end of this process, the super user has:

- Administrator privileges for all WebLogic domains and all middleware.

- Function setup privileges for all Oracle Fusion applications.

- Administration privileges to Oracle Fusion Applications. These do not include transactional privileges.

For more information about identity provisioning and using the interview wizard to create a provisioning plan, see the Oracle Fusion Applications Installation Guide.

5.2.4 Best Practices for the Administrator Groups

While there are logical sets of "super" administrative groups (a set of two per application family, consisting of the super-user administrator and the application administrator) you can choose to distribute these functions among fewer individuals. The recommended best practice is to carefully plan the separation of duties, taking into account the real-world operational needs of your site.

5.2.5 Managing Identities after Deployment

Oracle Identity Manager is the best-in-class user provisioning and administration component in Oracle Fusion Middleware.

Oracle Identity Manager automates the process of adding, updating, and deleting user accounts from applications and directories.

Identities can be created and managed when user records are created through activities such as employee hiring and creation of contacts through Oracle Fusion CRM.

In addition, identities can also be created and managed administratively through the Oracle Identity Manager Administrative Console.

For more information about provisioning and managing identities, see:

- Oracle Fusion Middleware User's Guide for Oracle Identity Manager

- Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager

5.3 Managing Authorization Policies

An authorization policy defines the criteria that control access to an organization's protected resources. By default, all access to a protected resource is denied until an authorization policy that explicitly grants access to it is written and distributed. If the authorization policy only grants access to a role, the requesting user must be statically assigned to it.

This section contains the following topics:

- Section 5.3.1, "Setting Loggers"

- Section 5.3.2, "Upgrading Fusion Application Policies"

5.3.1 Setting Loggers

Oracle Authorization Policy Manager has one logger: oracle.security.apm. For more information about log file management, see Chapter 13.

5.3.2 Upgrading Fusion Application Policies

This section describes how to upgrade application policies in an LDAP-based domain Security Store with the changes introduced by a new release of the application.

This sections contains the following topics:

- Section 5.3.2.1, "Overview"

- Section 5.3.2.2, "Prerequisites to Patching Policies"

- Section 5.3.2.3, "Patching Policies"

- Section 5.3.2.4, "Analyzing Patch Differences"

- Section 5.3.2.5, "Resolving Patch Differences"

- Section 5.3.2.6, "Applying a Patch"

5.3.2.1 Overview

First we introduce some terms used throughout this chapter, and then an overview of the process of upgrading the Security Store.

- Section 5.3.2.1.1, "Terminology"

- Section 5.3.2.1.2, "Upgrading Process Overview"

5.3.2.1.1 Terminology

The following terms refer to the three Security Stores involved in an application policy upgrading. They are also used in the Authorization Policy Manager user-interface.

Baseline - The original Security Store, represented by the XML file jazn-data.xml and available with the application out-of-the-box. Presumably, this Security Store was migrated to the domain Security Store when the application was first deployed.

Production - The domain Security Store, where the current state of application policies reside. This store is assumed LDAP-based. Presumably, policies in the application stripe in this store has undergone modifications since the application was first deployed.

Patch - The Security Store of the new version of the application, represented by the XML file jazn-data.xml and available with the new application out-of-the-box.

5.3.2.1.2 Upgrading Process Overview

Application policy upgrading allows security administrators to solve the following problem, with which they are faced every time a new version of an application is released.

Out-of-the-box, an application typically includes the file jazn-data.xml (baseline Security Store) that describes the application policies for that particular version of the application. Typically, at application deployment the baseline Security Store is migrated to the domain Security Store (production Security Store) for the first time.

Thereafter, application policies in the production store may undergo modifications to accommodate evolving requirements; these changes include adding, deleting, or modifying any application-specific security artifact such as roles, grants, resource types, resources, and entitlements.

When a new version of the application is available and before that new version is deployed, a security administrator needs to:

- Identify the customization that has been introduced since the migration of the old application version, that is, the delta between the baseline and the production stores.

- Identify the differences between the customized application policies and the policies in the new application version, that is, the delta between the production and patch stores.

- Decide, for each difference, which artifact to use.

Authorization Policy Manager facilitates the resolution of each of the above tasks by providing a security administrator with a user interface that allows him to:

- Analyze a new patch, that is, generate all differences.

- Inspect and decide, for each difference reported by the analysis, which specification to use.

- Apply the patch.

Important:

Before patching application policies, make sure that you backup the Security Store as explained in Section 5.3.2.2.

5.3.2.2 Prerequisites to Patching Policies

The analysis must be performed first. The resolution of changes and conflicts is performed next. These tasks do not have any particular requirements and can be accomplished at different times during one Authorization Policy Manager session or even across different sessions.

Before applying a patch, however, proceed as follows:

1. Take off line any WebLogic domain that uses the Security Store where the application policies to be patched reside.

2. Backup the Security Store by using either of the following tools:

1. Oracle Internet Directory ldifwrite to obtain an LDIF file for the Security Store.

2. Oracle Platform Security Services migrateSecurityStore to export the Security Store into a replica of it.

Now you can apply the patch.

If for any reason the Security Store needs to be restored, proceed as follows:

1. If you have saved the Security Store in an LDIF file, use bulkload to restore it.

2. If you have exported the Security Store, use Oracle Platform Security Services migrateSecurityStore to restore it.

5.3.2.3 Patching Policies

The Policy Upgrade Management tab, partially illustrated in Figure 5-2, contains the tab Home, where the upgrading process begins and which succinctly describes the steps you follow to upgrade application policies. The first step is to select the application whose policies to upgrade.

Figure 5-2 The Policy Upgrade Management Tab

To select application policies to patch, proceed as follows:

1. In the Home tab of the Policy Upgrade Management page, click the button Patch Application at the top left corner of the page to bring up the Patch Application dialog illustrated in Figure 5-3.

Figure 5-3 Patch Application Dialog

2. Select the application to patch from the pull-down Application list.
This list displays only applications that are currently deployed in the domain. After selecting the application, the dialog takes a different form according to whether or not the application selected has a patching in progress.

- If the application has a patching in progress, you can continue with it or abort it.

- If the application does not have a patching in progress, select the Baseline file (specifies the location of the baseline Security Store) and the Patch file (specifies the location of the patch Security Store) and click OK. The only Patch Method available in this release is a 3-way DIFF which considers differences between the baseline, the production, and the patch stores

The rest of this procedure assumes a new patching process. Authorization Policy Manager displays an indicator showing the progress of the analysis phase in the Patch Application dialog. Once this phase is completed, the Patch Application dialog displays the statistics of the analysis as illustrated in Figure 5-4.

Figure 5-4 Statistics of a Patch Analysis

3. Check the box Launch Patch Resolution (checked by default) and click OK to launch the patch resolution phase.
Authorization Policy Manager creates a new tab (named after the application display name) that contains the details of the results, that is, the conflicts and differences encountered, in two sub-tabs:

- General - This tab displays the files you have specified at the start of the patching and a chart showing the number changes and conflicts found, per artifacts, between the baseline and the patch stores. For details about these terms, see Section 5.3.2.5.1. Figure 5-5 illustrates the General tab.

Figure 5-5 The General Tab

To terminate the current patching process and to delete the analysis data gathered thus far, click the button Discard; once the patch is discarded, the tab for the application is deleted from the Patching tab.

- Patch Details - This tab displays the proposed changes and conflicts encountered per security artifact. The details of this tab are explained in the next section.

5.3.2.4 Analyzing Patch Differences

The Patch Details tab, illustrated partially in Figure 5-6, contains two major areas: the left area displays a hierarchical overview of changes and conflicts per artifact that resulted from the comparisons; the right area displays the details of changes and conflicts for an artifact selected from the left area.

Figure 5-6 Patch Details Tab

To display the specifics of an object's differences in the right area, click Changes or Conflicts under the object. Each row in the table has a type icon that indicates whether the difference is a change (double arrow icon) or a conflict (exclamation mark icon). (For details, see Section 5.3.2.5.1.)

To view a change or conflict for a specific artifact, select the corresponding icon. All changes or conflicts are displayed in a table at the top of the page. The Status column shows whether a change or a conflict has been resolved (green check icon) or not (gray square icon). The Related Issues column shows whether a change or conflict has implied dependencies; click the icon in this column to display the Patch Artifact Dependencies dialog and see, among other details, the reasons why other artifacts would be affected when resolving a difference for this artifact. Figure 5-7 partially illustrates this page.

Figure 5-7 Viewing Artifact Conflicts

To view conflict details for a specific item in the table, select the item to display the different specifications found in the 3-Way DIFF Details area. Figure 5-8 illustrates the differences for a role.

Figure 5-8 Displaying Difference Details

Figure 5-9 partially illustrates the dependencies implied by differences in a pair of roles. Specifically, it illustrates a baseline role App_Z that is not modified in the production store but modified in the patch store as follows:

1. The display name and the role description are changed.

2. The new role App_Znew is a child of the role App_Z.

Figure 5-9 Viewing Dependencies Implied by a Conflict or Change

5.3.2.5 Resolving Patch Differences

A patch difference identifies a disparity between the specifications of a security artifact in the some of the Security Stores involved in the analysis. Oracle Authorization Policy Manager lists patch differences as changes or conflicts. These terms and how to resolve them are explained in the following sections:

- Section 5.3.2.5.1, "Changes and Conflicts"

- Section 5.3.2.5.2, "Resolving Changes and Conflicts"

5.3.2.5.1 Changes and Conflicts

To better explain the terminology used, assume that Abase, Aprod, and Apatch denote the states of an artifact in the baseline, production, and patch stores, respectively.

A patch difference is called a change when Abase and Apatch are equal, and Aprod is different to Apatch.

A patch difference is called a conflict when Abase and Apatch are different, and Aprod is different from Apatch.

5.3.2.5.2 Resolving Changes and Conflicts

Resolving an artifact change or conflict means choosing which specification to use: the one in the production store or the one in the patch store.

Even though there is a default resolution for each artifact change or conflict, it is recommended that all changes and conflicts be resolved manually before you proceed forward to applying the patch.

To resolve a change or conflict for an artifact, proceed as follows:

1. Select the artifact in the Conflicts table, to display the specifications for the artifact found in each of the three stores at the bottom of the page.

2. Inspect specification differences and decide which one to use; to use the production store, click the button Use Production; to use the specification in the patch store, click the button Use Patch.

Important Note:

The decision that you make in this step may imply necessary changes to other artifacts. These changes, necessary to preserve data consistency, are called dependencies.

Oracle Authorization Policy Manager displays the dependencies that a decision implies and requests your confirmation before setting the value.

The decision value set for a change or conflict can be reset at any time. To any change or conflict left unresolved, Oracle Authorization Policy Manager sets one of the following default values:

- For a change, Use Patch.

- For a conflict, Use Production.

5.3.2.6 Applying a Patch

The procedure in this section assumes that:

- All changes and conflicts reported in the Patch Checklist of the Patch Details tab have been resolved (manually or by default).

- The prerequisites stated in Section 5.3.2.2 are met.

To apply a patch, proceed as follows:

1. Click the button Apply Patch in the application's patching tab to initiate the patching process, which will modify the application policy stripe in the domain LDAP store.

2. Once the application of the patch is completed, you are ready to deploy the new version of the application.
Make sure that when deploying it, the automatic migration of policies is turned off so that the just patched application policies are not modified when the application is deployed.

5.4 Masking Data

Data masking is the ability to replace sensitive data with realistic but false data on test and development databases. Features include:

- the ability to keep data properties (data type, width, and so on) intact and provide realistic data sets for analysis and testing.

- ensuring various constraints like (Primary Keys, Uniqueness, Foreign keys) are maintained, preserving relational integrity.

- using user specified formatting rules that ensure custom and packaged applications continue to work after the data is masked.

To learn more about data masking concepts, see "Overview of Oracle Data Masking" in the Oracle Database Real Application Testing User's Guide, which is part of the Oracle Database documentation library.

Data masking is an on-going activity for the Oracle Fusion Applications administrator. This chapter explains how data masks and masking definitions are created and managed with Oracle Enterprise Manager Cloud Control, how to generate a masked database, and related administration tasks

This section contains the following topics:

- Section 5.4.1, "Data Masking in Oracle Fusion Applications"

- Section 5.4.2, "Managing the Masking Templates"

- Section 5.4.3, "Viewing and Modifying Data Masking Definitions"

- Section 5.4.4, "Generating and Submitting the Masking Script"

- Section 5.4.5, "Customizing Mask Formats"

- Section 5.4.6, "Best Practices when Masking Test Databases"

- Section 5.4.7, "Masking References"

5.4.1 Data Masking in Oracle Fusion Applications

The Oracle Fusion Applications administrator must take certain considerations into account when implementing data masking for an application. For example, free space requirements must be evaluated to ensure that adequate resources are available to the masking job. The following instructions provide guidelines:

- Section 5.4.1.1, "Requirements for Data Masking"

- Section 5.4.1.2, "Sensitive Data in Oracle Fusion Applications"

- Section 5.4.1.3, "Masking Definitions"

5.4.1.1 Requirements for Data Masking

You should be aware of certain background information, prerequisites, and requirements before undertaking data masking operations in your environment.

This section contains the following topics:

- Section 5.4.1.1.1, "Data Model Descriptions"

- Section 5.4.1.1.2, "Required Versions"

- Section 5.4.1.1.3, "Preliminary Steps"

- Section 5.4.1.1.4, "Temporary Space Requirements"

- Section 5.4.1.1.5, "Database Free Space Requirements"

- Section 5.4.1.1.6, "Database and Operating System Parameters"

- Section 5.4.1.1.7, "Role Requirements"

- Section 5.4.1.1.8, "Custom Field Masks"

- Section 5.4.1.1.9, "Production-to-Test Requirement"

5.4.1.1.1 Data Model Descriptions

You must understand the data model for your application data when deciding how and what to mask. For data model descriptions, see the product-specific documentation from Oracle Enterprise Repository for Oracle Fusion Applications.

5.4.1.1.2 Required Versions

Data masking requires the following:

- Oracle Database 10g Release 2 or Oracle Database 11g Release 1

- Oracle Enterprise Manager Grid Control 10g Release 4 or Oracle Enterprise Manager Cloud Control 12c

- The Oracle Data Masking Pack

5.4.1.1.3 Preliminary Steps

You must perform certain steps before using data masking in an Oracle Fusion Applications environment.

Install Masking Format Library

Take these steps to install a format library and configure temp spaces:

1. Install the FMTLIB package, which contains functions needed to perform data masking.

1. Locate these scripts in your Oracle Enterprise Manager installation:

$PLUGIN_HOME/sql/db/latest/masking/dm_fmtlib_pkgdef.sql
$PLUGIN_HOME/sql/db/latest/masking/dm_fmtlib_pkgbody.sql

You can get the plugin home location from the repository by running this SQL as sysman:

select PLUGIN_HOME from
gc_current_deployed_plugin where
plugin_id='oracle.sysman.db' and
destination_type='OMS';

2. Copy these scripts to a directory in your target database installation.

3. Execute the scripts using SQL*Plus, connected as a user that can create packages in the DBSNMP schema (SYSTEM or SYS).

2. Apply any required patches. Data masking requires a specific Oracle Database version and patch set. See Section 4.8.

3. Install the agent on the database host using Oracle Enterprise Manager.

4. Discover the database using Oracle Enterprise Manager.

5. Change the temp spaces used for data masking to "Auto Extend" from Cloud Control Console:

1. Click Targets, then Databases.

2. Select the database and log in.

3. Navigate to Administration, then Storage, then Datafiles.

4. On the Datafiles page, enter temp in the Object Name search box. Press Go. The temp spaces are displayed:

When configured correctly for masking, as in this example, auto-extend is enabled for the temp spaces.

5. If you need to set auto-extend, edit each temp space in turn by selecting its radio button and clicking Edit. Change the value for each space as shown here:

5.4.1.1.4 Temporary Space Requirements

As shown in Step 3 of Section 5.4.1.1.3 it is recommended that you auto extend your temp files as masking requires additional space for processing. The amount of additional space you need depends on your data. Broadly speaking, masking takes up approximately two times the size of the largest table being masked.

The temp space is needed for two reasons:

- To perform sort and join operations during masking.
The space requirement is not straightforward to estimate as it depends on whether sorts and joins go to disk, which in turn depends on how much memory is available on the machine. Try to keep at least as much space as the size of your biggest masked table for sort and join processing.

- For space taken up in the default user tablespace for temporary masking tables.
The size of the temp tables is twice the size of all the columns being masked. Since these tables are dropped after processing, the space is released after masking completes.

5.4.1.1.5 Database Free Space Requirements

Ensure that sufficient free space is available to the database before executing the masking job.

Calculate the free space requirements as follows:

largest table being masked +
total size of mapping tables for all columns in that table +
temporary tablespace (roughly twice the size of the largest mapping table, as
stated under Temporary Space Requirements above)

5.4.1.1.6 Database and Operating System Parameters

The following database configuration is recommended:

memory_target = 26G
pga_aggregate_target = 6G
sga_max_size = 26G
sga_target = 0

Operating System Configuration (All Platforms)

The following operating system configuration is recommended:

- Memory Address Space: Unlimited. For example, in the /etc/security/limits.conf file:

oracle soft memlock unlimited
oracle hard memlock unlimited

- Memory Map Areas: 200000. For example,

[my@host ~/rhe]$ /usr/local/packages/aime/ias/run_as_root su[root@host rhe]# echo 200000 > /proc/sys/vm/max_map_count

Operating System Configuration (AIX Database Hosts)

The following operating system configuration is recommended:

core file size        (blocks, -c) unlimited
data seg size         (kbytes, -d) unlimited
file size             (blocks, -f) unlimited
max memory size       (kbytes, -m) unlimited
open files                    (-n) unlimited
pipe size          (512 bytes, -p) 64
stack size            (kbytes, -s) unlimited
cpu time             (seconds, -t) unlimited
max user processes            (-u) 16384
virtual memory        (kbytes, -v) unlimited

5.4.1.1.7 Role Requirements

The user executing the data masking script must have the dba role. If Virtual Private Database (VPD) security policies are used or Oracle Database Vault is enabled for the database, the user must be SYS.

Additionally, the user may need to have direct grants to objects for any PL/SQL objects provided to user-defined functions or post-processing scripts.

Optionally, you can grant EXEMPT ACCESS POLICY privilege to the masking user to bypass all VPD policies.

5.4.1.1.8 Custom Field Masks

Oracle Fusion Applications include a set of out-of-the-box masking definitions to mask common sensitive data like employee information and credit card numbers. However, these default mask templates cannot account for custom data such as flex fields since these are specific to your application.

You can update the standard masking definitions to include additional flex fields and custom data. For details about viewing and updating masking templates, see Section 5.4.3.

Note:

Be aware that certain sensitive custom attributes may depend on tables in other product families. For example, Procurement masking is dependent on Oracle Fusion CRM (for Suppliers and related entities, and for Procurement Contract terms and deliverables), on Oracle Fusion Supply Chain Management (for Items), on Oracle Fusion HCM (for Workers and Organizations), on Oracle Fusion Financials (for Ledgers), and on Oracle Fusion Project (for Projects and related entities).

5.4.1.1.9 Production-to-Test Requirement

During the production-to-test process, you must replace the production user names with dummy user names. This mandatory step is needed to avoid breaking anonymization.

5.4.1.2 Sensitive Data in Oracle Fusion Applications

Oracle Fusion Applications identify the common sensitive data types for each product family.

You can use Oracle Enterprise Manager Cloud Control to view the sensitive attributes specified in the masking definitions. You can update the definitions with any additional desired sensitive attributes, such as flex fields or other customized fields.

For details about how to view and update masking templates, see Section 5.4.3.

5.4.1.3 Masking Definitions

A masking definition specifies the columns to be masked and the format of the masked data. Out-of-the-box "template" masking definitions are provided for each family of Oracle Fusion Applications.

Masking definitions in XML format masks enable the data masking utility to identify the database tables, columns, and column formats of the data being masked.

5.4.2 Managing the Masking Templates

The Software Library contains a collection of common masking templates for Oracle Fusion Applications which you can import for use in your environment and modify as needed.

The following sections explain how to obtain and manage the data masking templates:

- Section 5.4.2.1, "Using Self Update to Obtain the Masking Templates"

- Section 5.4.2.2, "Importing Masking Templates from the Library"

- Section 5.4.2.3, "Exporting Masking Templates from the Library"

5.4.2.1 Using Self Update to Obtain the Masking Templates

With auto-download enabled in the Self Update feature, the latest templates appear in the Software Library as they become available.

Otherwise, you can access them manually as follows:

Note:

This procedure requires database plug-in 12.1.0.3.

1. Log in to Oracle Enterprise Manager Cloud Control.

2. Navigate to Enterprise, then Provisioning and Patching, then Patches and Updates, and sign in to My Oracle Support.

3. From the Setup menu, select Extensibility, then select Self Update.

4. On the Self Update page, scroll down and select Test Data Management templates. and click Check Updates.

5. In the Available Updates table, select the templates you want to download and select Download from the Actions menu.
This action downloads the templates to the Software Library from where you can import them into your environment or save them locally for editing. Click the Readme to understand about the templates.

5.4.2.2 Importing Masking Templates from the Library

You must import the templates from the software library before you can use them in your environment. Take these steps to import a template:

1. Log in to Oracle Enterprise Manager Cloud Control.

2. Navigate to Enterprise Menu, then Quality Management, then Data Masking Definitions.

3. Click Import from the Software Library.

4. Select the required template and specify appropriate values for the input parameters.

5. Click Import. Template definitions are imported into the respective tables.

5.4.2.3 Exporting Masking Templates from the Library

You can also export a template from the software library (for local editing or other tasks) using these steps:

1. Log in to Oracle Enterprise Manager Cloud Control.

2. Navigate to Enterprise Menu, then Quality Management, then Data Masking Definitions.

3. Click Export from the Software Library.

4. Select the required template and click Save. Specify a location to which the XML file is saved.

5.4.3 Viewing and Modifying Data Masking Definitions

You can modify the default masks provided with Oracle Fusion Applications, and create your own masking definitions. Use Oracle Enterprise Manager Cloud Control Console to manage and maintain the data masking definitions.

Note:

The procedure in this section assumes that the masking template file has been imported. If you have not done so already, see Section 5.4.2.

Note:

You must follow the instructions in Section 5.4.1.1 before you can perform the operations described here.

You can view and modify out-of-the-box data masking definitions as follows with Cloud Control Console:

1. Ensure that the masking template file has been imported. For details about this task, see Section 5.4.2.

2. In Cloud Control, select the Targets drop-down.

3. Select the Databases option.

4. Select the database whose mask definition you are configuring from the list of databases.

5. In the Security drop-down, select Data Masking. The Data Masking Definitions page lists the current masks for the database:

6. Select the mask definition you wish to view or update and click Edit.

7. Log in to the database.

8. The Edit Masking Definition page appears. It lists the columns included in the mask definition.

9. Several operations are available on this page:

- To add another column to the definition, click Add.

- To modify a column format, click the Format icon.

- To refine the list of columns, use the Enable, Disable and Search filter options. For example, to remove a column from the mask definition, check the box and click Remove.

10. To introduce a new column into the definition, for example, click Add. The Add Columns page appears.

11. To locate the column, enter the schema and table name and click Search.
In this example, we search the MOO_REVN table in the FUSION schema:

12. Select the checkbox for the MARGIN_AMT column and click Add.
The Edit Masking Definition page reappears, with MARGIN_AMT added to the column list.

Unlike the other columns, the format toolbox icon for MARGIN_AMT is displayed in red, which means that no mask format has yet been defined for the column. You must specify a format for this column to complete the definition.

13. Click on the toolbox icon. The Define Column Mask page appears.

14. You can now specify a mask format entry for MARGIN_AMT using the drop-down box. Click Add to complete the process.
In this example we select a random number format and specify the start and end lengths. To see how the masked data will appear in this format, click the Sample icon.

Note:

You can use the Import Format button to import an existing format entry.

15. Click OK. Cloud Control checks that the entry is valid for the column's data type. The Edit Masking Definition page reappears, and the MARGIN_AMT column now has a valid mask format.
Click OK to save the masking definition.

Likewise, starting at the Edit Masking Definition page (Step 8 above), you can modify the definition of an existing column by clicking its Format icon. This is useful, for example, when you wish to customize the properties of a column's format entry, or specify a different format entry for the column.

5.4.4 Generating and Submitting the Masking Script

When you modify a data masking definition by adding or removing columns, or by modifying an existing column's mask format, you must regenerate the SQL masking script to incorporate your changes.

Create Required Table in Target Database

In the 11g database environment, launching script generation may throw the error: "ORA-00942: table or view does not exist". To correct the problem, a table must be created in the target database. Run the following SQL in that database prior to script generation:

CREATE TABLE fusion.po_masked_values (val VARCHAR2(5));

Generate the Masking Script

To generate the script:

1. Follow Steps 1 through 5 of Section 5.4.3 to display the data masking definitions for the database.

2. After you create or modify a masking definition, its status is listed as Script Not Generated."
Select the definition and click Generate Script.

3. The Schedule Script Generation page appears. Here you specify generation options, login credentials, and a start time. Specify the necessary values and click Submit.
You are returned to the Data Masking Definitions page; the Status column lists the job in progress.

4. After processing is complete, the job status changes to Script Generated. Click the entry for Most Recent Job Completed to view the job details:

From this page, you can also check the details of intermediate steps by clicking their Status entry.

5. After processing is complete, you can:

- Integrate the masking script with the clone database process

- Schedule execution of the script to perform the masking operation.

5.4.5 Customizing Mask Formats

The format library is a collection of common, ready-to-use masking formats you can use in masking definitions. Oracle Data Masking enables you to extend the default mask format library by tailoring the existing formats, or creating new formats to meet your own business needs.

Take these steps to add a new format:

1. Follow steps 1 through 3 of Section 5.4.3 to select the database instance.

2. Under Related Links, select Data Masking Format Library.

3. When adding a new format, you can take an existing format as a starting point. For example, to create a new format for credit card number fields, you can select an existing credit card format and click Create Like.

4. Enter a descriptive name for the new format, and use the drop-down list under format entries to select a masking format. You may also specify a different post-processing function if desired.

Similarly, you can modify existing formats or create new formats on the Format Library page.

5.4.6 Best Practices when Masking Test Databases

Identity data can reside in several repositories: the Oracle Database, the production identity store (an LDAP store), and the Oracle Identity Manager database.

In the current release, when you implement data masking, the identity attributes are only masked (anonymized) in the Oracle Fusion Applications database. To preserve masked values, ensure that these best practices are followed when using the masked data for a test database:

1. Do not run the Enterprise Scheduler Service (ESS) job to synchronize the LDAP identity store and the Oracle Fusion Applications database, since doing so would reset the identity attributes in the database to their unmasked values.

2. Set up "dummy" test users to perform the testing.

3. Do not:

- Log in to the test database as a real user.

- Update a user's attributes in either the LDAP identity store or the Oracle Identity Manager database.

Doing so will reset that user's attributes to their unmasked values, allowing them to see their own masked record in employee self-service, deduce other people's identities by following the hierarchy, and so on.

In short, it is essential that you maintain close access control to databases holding live cloned data, and make testers aware of their obligations and responsibilities regarding the data. As far as is possible, the processes around test data based on live data should mirror the processes around the live data itself. In particular, testers must not use privileged access to look beyond what they need to perform the required tests. For example, they must not try to work out to whom the data pertains, or try and find private information to satisfy their own curiosity.

5.4.7 Masking References

For a detailed tutorial of data masking:

1. Go to http://www.oracle.com/technetwork/tutorials/index.html.

2. Click the link to access the learning library.

3. In the search field, enter Replacing Sensitive Data Using the Data Masking Pack and press Return.

4. Select a lesson by clicking the link, then click Begin Tutorial.

For additional information about securing sensitive data, Oracle Fusion Applications data security policies, and related topics, see the Oracle Fusion Applications security guides. The Privacy chapter explains how Personally identifiable information (PII) is defined and protected.

5.5 Securing Web Services

Oracle Web Services Manager (WSM) provides a policy framework to manage and secure Web services consistently across your organization. Oracle WSM is available to the following users:

- Developers, at design time through Oracle JDeveloper

- System administrators in production environments with Fusion Middleware Control and command-line tools

The Oracle WSM policy framework secures Web services with policies, which describe capabilities and requirements such as whether and how a message must be secured, whether and how a message must be delivered reliably, and so on.

This section contains the following topics:

- Section 5.5.1, "Configuring and Managing Local Policies"

- Section 5.5.2, "Configuring and Managing Global Policies"

- Section 5.5.3, "Web Services Security Profiles"

- Section 5.5.4, "Key Exchange with the Domain Hosting Oracle Identity Manager"

5.5.1 Configuring and Managing Local Policies

A policy subject is the target resource to which the policies are attached. Examples include Web services endpoints, Web service clients, SOA service endpoints, SOA clients, and SOA components.

Directly attaching one or more policies to a policy subject is referred to as Local Policy Attachment (LPA). The key tasks related to LPAs include:

- Attaching policies to a single Web service endpoint

- Managing and disabling policies at an endpoint

- Removing (detaching) policies from a Web service endpoint

- Troubleshooting Web service security

See "Attaching Policies Locally" in the Oracle Fusion Applications Developer's Guide to locate the procedures for these tasks.

5.5.2 Configuring and Managing Global Policies

A policy set, which can contain multiple policy references, enables you to attach policies globally to a range of endpoints of the same type. By attaching policies globally in this way, referred to as Global Policy Attachment (GPA), you can ensure that all subjects are secured by default.

The key tasks related to GPAs include:

- Creating and managing policy sets

- Validating policy sets

- Enabling and disabling policy sets globally and for specific endpoints

- Determining what policies are enforced when both LPA and GPA are defined

- Viewing policies attached to a Web service

- Troubleshooting Web service security

See "Attaching Policies Globally" in the Oracle Fusion Applications Developer's Guide to locate the procedures for these tasks.

5.5.3 Web Services Security Profiles

Oracle Web Services Manager supports three Web services security profiles:

- AuthN Profile

- SSL Profile - provides transport-level security

- Message Security Profile - provides message-level security

Out-of-the box, Oracle Fusion applications are provisioned with the AuthN profile. You can move your deployment to a different profile if needed.

5.5.4 Key Exchange with the Domain Hosting Oracle Identity Manager

During provisioning, all Oracle Fusion Applications domains are set up to use a common keystore and credential store, whereas the Oracle Identity Management domain (which includes Oracle Identity Manager) uses a separate keystore, and stores credentials in a logical domain. Provisioning does not set up trust between these keystores. This section explains how to exchange trust with the Oracle Identity Manager domain, enabling Web services security when this domain is involved.

Exporting a Keystore Alias from Application Domain

Take these steps to export the keystore alias:

1. Navigate to the DOMAIN_HOME/config/fmwconfig directory of the domain.

2. Run the keytool command to export the alias into a file called orakey.cert using syntax like in this example:

JAVAHOME/bin/keytool -exportcert -alias orakey -file orakey.cert -keystore default-keystore.jks -storepass keystore-password

This command creates a file called orakey.cert containing the exported orakey alias.

When using this command, specify the alias name and keystore password applicable to your environment.

Importing a Keystore Alias into Oracle Identity Manager Domain

Take these steps to import the keystore alias:

1. Copy the file generated by the export procedure (orakey.cert in the export example) into the DOMAIN_HOME/config/fmwconfig directory of the Oracle Identity Manager domain where you wish to import the alias.

2. Run the keytool command using the following syntax to import the certificate:

JAVA_HOME/bin/keytool -importcert -alias orakey -file orakey.cert -keystore default-keystore.jks -storepass keystore-password

This command imports the alias into the Oracle Identity Manager domain's keystore.

Similar steps are used to export the Oracle Identity Manager key and import it into the other domain.

5.6 Hardening Tasks

This section describes a variety of measures you can take to secure your Oracle Fusion Applications environment. Topics include:

- Section 5.6.1, "Securing Database Network Traffic"

- Section 5.6.2, "Disabling Unused Components to Minimize Risks"

- Section 5.6.3, "Configuring External Clients with Externally-Facing Web Services"

- Section 5.6.4, "Hardening Web Services"

- Section 5.6.5, "More Secure Keys and Certificates"

5.6.1 Securing Database Network Traffic

To enhance security for network traffic to the database, Oracle Advanced Security supports data encryption and integrity for both servers and clients.

Oracle Database supports industry-standard algorithms for protecting the confidentiality of Oracle Net Services traffic. These algorithms:

- Encrypt network data provides data privacy so that unauthorized parties are not able to view plaintext data as it passes over the network.

- Ensure data integrity so that unauthorized parties are not able to modify data as it passes over the network. Integrity protects against two forms of active attack: Data modification attack and Replay attack.

Oracle Fusion Applications deploys with the following settings for client and server in the sqlnet.ora file:

Encryption Type: REQUIRED

Checksum Level: REQUIRED

These settings mean that the encryption and integrity services are enabled.

The following instructions provide an example of how you can confirm that Oracle Advanced Security is enabled so that only encrypted data is transferred between your database server and other sources:

1. On the server, locate the sqlnet.ora configuration file in the following directory of the database Oracle Home:

ORACLE_HOME/network/admin

2. Using a text editor, look for the following entries (or similar entries) in the sqlnet.ora file:

SQLNET.ENCRYPTION_SERVER = REQUIRED

To avoid weak protocols and add more seed, include the following lines:

SQLNET.ENCRYPTION_TYPES_SERVER= (AES256, AES192, 3DES168)
SQLNET.CRYPTO_SEED = <randomstring_for_this_deployment_up_to_70_characters>

3. Repeat this procedure to configure encryption on the other system.

The sqlnet.ora file on the two systems should contain the following entries:

On the Server

SQLNET.ENCRYPTION_SERVER = [accepted | rejected | requested | required]
SQLNET.ENCRYPTION_TYPES_SERVER = (valid_encryption_algorithm )
SQLNET.CRYPTO_SEED = <randomstring_for_this_deployment_up_to_70_characters>

On the Client

SQLNET.ENCRYPTION_CLIENT = [accepted | rejected | requested | required]
SQLNET.ENCRYPTION_TYPES_CLIENT = (valid_encryption_algorithm )

5.6.2 Disabling Unused Components to Minimize Risks

Components not in use in a deployment can represent unnecessary security risks. This section explains how to remove or disable such components.

Debug Utilities in a Workspace Web Application

For troubleshooting purposes, Enterprise Performance Manager (EPM) Workspace is delivered with uncrunched JavaScript files. For security, use these steps to remove these JavaScript files from your production environment:

1. Create a backup copy of the following directory:

Oracle_BI1/common/epmstatic/wspace/js/directory

2. Delete all the .js files except DIRECTORY_NAME from each subdirectory of Oracle_BI1/common/epmstatic/wspace/js.

Each subdirectory contains a .js file that bears the name of the directory. For example, Oracle_BI1/common/epmstatic/wspace/js/com/hyperion/bpm/web/common contains Common.js. Remove all .js files except the one that bears the name of the directory, in this case, Common.js.

Operating System Services

Both Linux and Windows platforms provide a variety of operating system services, many of which are not necessary for most deployments. Examples of such services include FTP, TFTP, TELNET and so on.

Be sure to close both the UDP and TCP ports for each service that is being disabled. Disabling one type of port and not the other does not make the operating system more secure.

5.6.3 Configuring External Clients with Externally-Facing Web Services

This section explains the Web services policies that external clients can use to further secure communication. The first step is to choose the appropriate mechanism for your client application; the second one is to configure the chosen mechanism.

The policy oracle/wss11_saml_or_username_token_with_message_protection_service_policy contains the following assertions:

- oracle/wss11_saml_token_with_message_protection_service_template: a SAML-based authentication for inbound SOAP requests in accordance with the WS-Security 1.1 standard.

- oracle/wss11_username_token_with_message_protection_service_template: a username token authentication for inbound SOAP requests in accordance with the WS-Security 1.1 standard.

- oracle/wss_saml_token_bearer_over_ssl_service_template: a SAML-based authentication using credentials provided in SAML tokens with confirmation method 'Bearer' in the WS-Security SOAP header; it verifies that the transport protocol provides SSL message protection.

- oracle/wss_username_token_over_ssl_service_template: a username token authentication using the credentials in the UsernameToken WS-Security SOAP header to authenticate users against the configured identity store; it verifies that the transport protocol provides SSL message protection.

- oracle/wss_http_token_over_ssl_service_template: HTTP authentication using credentials extracted from the HTTP header to authenticate users against the configured identity store; it verifies that the transport protocol is HTTPS.

5.6.3.1 Choosing a Mechanism

To determine the mechanism to use with your client application, consider the following cases:

1. If your client application provisions user passwords along with user identities, then it can use one of the following three username/password mechanisms along with user identities:

- If it supports basic WS-security and uses SSL, use oracle/wss_username_token_over_ssl_service_template . In this case, the transport channel is secured with SSL and the SOAP message carries a WS-Security header with a UsernameToken and TimeStamp.

- If it does not support basic WS-security and uses SSL, use oracle/wss_http_token_over_ssl_service_template. In this case, the transport channel is secured with SSL and the username/password is passed with the standard Http Authorization header for basic authorization.

- If it does not use SSL, then use oracle/wss11_username_token_with_message_protection_service_template.

2. Otherwise, if it does not provision user passwords along with user identities but users need be authenticated locally, then it can use one of the following SAML-based mechanisms:

- If SSL is used to secure the transport channel, then use oracle/wss_saml_token_bearer_over_ssl_service_template.

- Otherwise, if SSL is not used, then use oracle/wss11_saml_token_with_message_protection_service_template.

5.6.3.2 Setting Up Policy Assertions and Configuring Mechanisms

To set up policy assertions, several configurations are needed, as explained in the following sections:

- Setting Up the Policy Assertions

- Configuring the Message Encryption Certificate (Client Side)

- Configuring the Token Issuer Trust (Server Side)

5.6.3.2.1 Setting Up the Policy Assertions

To set up each of the policy assertions, proceed as follows:

- oracle/wss11_saml_token_with_message_protection_service_template:

- Import the service message encryption certificate on the client side, by following the task in Configuring the Message Encryption Certificate (Client Side).

- Configure the SAML token issuer on the service side, by following the task in Configuring the Token Issuer Trust (Server Side) with trusted SAML clients.

- oracle/wss11_username_token_with_message_protection_service_template:

- Import the service message encryption certificate on the client side, by following the task in Configuring the Message Encryption Certificate (Client Side).

- oracle/wss_saml_token_bearer_over_ssl_service_template:

- Configure the SAML token issuer on the service side, by following the task Configuring the Token Issuer Trust (Server Side) with trusted STS servers.

- oracle/wss_username_token_over_ssl_service_template

- oracle/wss_http_token_over_ssl_service_template

5.6.3.2.2 Configuring the Message Encryption Certificate (Client Side)

To configure the message encryption certificate, an external client must get the certificate of the service, which is described in the Web Services Description Language (WSDL).

To extract the certificate from the WSDL, proceed as follows:

1. Save the WSDL to a local file.

2. In the saved file, sSearch for the string "X509Certificate" to locate the certificate within the file; the following snippet illustrates this search:

<dsig:X509Certificate> MIICHTCCAYagAwIBAgIETBwVYjA ... </dsig:X509Certificate>

3. Copy the long string within the tag <dsig:X509Certificate> into a new text file.

4. Rename or edit the text file as follows:

- If this certificate is used within a Microsoft client, rename this file with .cer file extension and use it as a certificate file.

- If this certificate is used within a Java client, change the text file so that the certificate is framed by BEGIN and END, as illustrated in the following sample:

-----BEGIN
MIICHTCCAYagAwIBAgIETBwVYjA ...
-----END

5. Import the certificate into your client's trust store.

5.6.3.2.3 Configuring the Token Issuer Trust (Server Side)

If the client application uses ID propagation or federated authentication, the client must authenticate with a SAML assertion from a SAML toke issuer.

To configure trust for the token issuer on the service side, proceed as follows:

1. Import the SAML token signing certificates into the domain trust store of the service with the use of the utility keytool, as illustrated in the following sample invocation:

keytool -importcert -file <sts-signing-cert-file> -trustedcacert -alias  <alias>  -keystore default-keystore.jks

I f the SAML token signing certificate is issued from a CA, all the certificates in the certification chain must be imported.

2. Add SAML Issuer to the list of trusted issuers. Specifically, one needs to add the DN (Distinguished Name) of the signing certificate of the SAML Issuer to the list of trusted DNs.
To define a list trusted DNs using EM Fusion Middelware Control, proceed as follows:

1. Select WebLogic Domain> Web Services > Platform Policy Configuration

2. In that page, select the tab Trusted STS servers if you are configuring oracle/wss_saml_token_bearer_over_ssl_service_template, or the tab Trusted SAML clients, if you are configuring oracle/wss11_saml_token_with_message_protection_service_template.

3. Add the SAML issuer to the Trusted Issuers section of the page.

4. Select the trusted issuer for which you want to define a DN list and then add the trusted DN in the Trusted STS server's area of the page.

5.6.4 Hardening Web Services

To further the security of Web Services, keep in mind the following adjustments and recommendations:

- Choose a more secure policy appropriate for all your internal Web services; you may choose to not distinguish between internal and external, and use the same policy for all Web services.

- When changing the attachment of security policies, note that:

- The client policy must be changed accordingly.

- The client and callback policies must be compatible with the service that you are invoking; otherwise the Web service invocation will not work.

- In case of exporting setup data, the corresponding Service and Callback policies for all Setup Data services must match the Functional Setup Manager (FSM) Processing Service (MigratorService) and FSM Migrator Callback Service (MigratorCallbackService) policies; these must be the same in all the domains so that FSM export and import are fully functional.

- Use the same GPA policy across all the domains if you change the domain-wide GPA policy.

- If you use a secure sockets layer (SSL) policy, verify the following that:

- You have set the Oracle HTTP Server (OHS) options to propagate the SSL client certificate and settings to the Weblogic Server (WLS) if your SSL terminates at the OHS.

- You have set the SSL variables and client to go to OHS and then load balancer (LBR) if your SSL terminates at the LBR level.

- You have configured the policies for SAML Token (Sender Vouches) Over SSL for two-way SSL. Other authentication tokens such as username token, and SAML bearer token require only one-way SSL.

5.6.5 More Secure Keys and Certificates

Oracle Fusion Applications provisioning sets up the keystore with self-signed certificates that you can choose to replace your own keys and certificates. For example, if you have an enterprise CA, you can use that to generate keys and certificates, but you must:

- Configure your Web services to accept only a configured list of SAML signers by configuring the trusted distinguished names (DN) list for SAML signing certificates in every domain. The private key that you configure for Oracle Web Services Manager (OWSM) is used for signing SAML Sender Vouches assertions. The certificates that you place in the OWSM keystore are for verifying SAML assertions.
If you put your enterprise CA in the OWSM keystore, every certificate issued by your enterprise is acceptable for verifying assertion unless Web services is configured to accept only your list of SAML signers. For detailed information, see Section 5.6.3.2.3, "Configuring the Token Issuer Trust (Server Side)."

- Enable hostname verification by setting the value of wsm.ignore.hostname.verification to false. By default, host name verification is turned off in OWSM.

5.7 Security Store Management

This section includes several administrator's tasks in the following topics:

- Extracting Data from an OID Store to a File

- Reconciling GUIDs

5.7.1 Extracting Data from an OID Store to a File

This section describes the use of the OPSS script migrateSecurityStore to extract the contents of one stripe and save it in an XML file.

To extract the policies in a given application stripe from an OID store, proceed as follows:

1. Create a file with the following content and save it as, for example, exported-jazn-data.xml in the same directory where your jps-config.xml file is located:

<?xml version = '1.0' encoding = 'UTF-8' standalone = 'yes'?>
<jazn-data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://xmlns.oracle.com/oracleas/schema/jazn-data-11_0.xsd">
<jazn-realm default="jazn.com">
<realm>
<name>jazn.com</name>
</realm>
</jazn-realm>
</jazn-data>

2. Copy of your jps-config.xml file to, for example, copy-jps-config.xml.

3. Edit the file copy-jps-config.xml to contain an instance and two contexts like the following:

<serviceInstance location="./exported-jazn-data.xml"
provider="policystore.xml.provider"
name="export.xml"/>

<jpsContext name="ldap_source">
<serviceInstanceRef ref="policystore.ldap"/>
</jpsContext>

<jpsContext name="xml_target">
<serviceInstanceRef ref="export.xml"/>
</jpsContext>

4. Run the script migrateSecurityStore as in the following invocation (the arguments are written in separate lines for the sake of clarity only):

migrateSecurityStore(type="appPolicies",
configFile="./copy-jps-config.xml",
src="ldap_source",
dst="xml_target",
srcApp="hcm")

The above illustrates the extraction of the contents of the application stripe hcm to the XML file exported-jazn-data.xml. To extract the contents of any other stripe, specify the appropriate stripe name in the argument srcApp. No more than one stripe can be extracted at a time.

Note that in the above example, both copy-jps-config.xml and exported-jazn-data.xml are assumed to be located in the same directory.

5.7.2 Reconciling GUIDs

The recipient of a grant can be either an application role or an enterprise role. In Oracle Fusion Data Security and policy grants this recipient is identified by a GUID, and it is crucial for the security system to work as expected that these GUIDs be consistent. Since GUIDs are not preserved by migration, the GUIDs in the Oracle Fusion Data Security policies and in the policy store policies must be reconciled when, for instance, migrating to a staging or a production environment.

The java utility program DSDataMigrator reconciles GUIDs by modifying GUIDs in Oracle Fusion Data Security so that the GUIDs of the role entries in the identity and policy stores are consistent with those in Oracle Fusion Data Security.

DSDataMigrator needs not be run when:

- The user interface is used to create new policies or to modify existing ones.

- The system is provisioned for the first time (GUID reconciliation happens automatically in this case).

- A patch containing Grants Seed Data is applied to the environment (GUID reconciliation happens automatically in this case).

DSDataMigrator must be run when:

- A policy stripe was dropped or recreated.

- A role was dropped or recreated.

- An SQL script was used to upload grants data.

- Patching the infrastructure fails, such as, when the OID server went down.

- The OID server was swapped out.

- FndGrantsSD.xml data was loaded to the database using SDF programs directly bypassing the patching infrastructure.

- The file jps-config-jse.xml contains invalid or incorrect configurations.

- Security data was migrated to a staging or to a production environment.

- Enterprise roles in the identity store were dropped and imported again using a migration tool.

This section includes the following topics:

- Section 5.7.2.1, "Prerequisites to Running DSDataMigrator"

- Section 5.7.2.2, "DSDataMigrator Syntax"

5.7.2.1 Prerequisites to Running DSDataMigrator

Before an administrator runs this command, it is assumed that:

- The Fusion Application has been installed (so that Oracle Fusion Data Security has been loaded).

- The XML policies (jazn-data.xml) have been migrated to an Oracle Internet Directory server.

- The FND_GRANTS table has been backed up, as illustrated in the following invocation:

>sqlplus sys as sysdba
create table FUSION.FND_GRANTS_OLD as select * from FUSION.FND_GRANTS;

- The classpath in the shell where the command is to be run contains the following JAR files:

- MW_HOME/atgpf/atgpf/modules/oracle.applcore.model_11.1.1/Common-Model.jar.

- MW_HOME/atgpf/atgpf/modules/oracle.applcore.model_11.1.1/DataSecurity-Model.jar.

- MW_HOME/oracle_common/modules/oracle.adf.model_11.1.1/adfm.jar.

- MW_HOME/oracle_common/modules/oracle.adf.share_11.1.1/adf-share-support.jar.

- MW_HOME/oracle_common/modules/oracle.adf.share.ca_11.1.1/adf-share-ca.jar.

- MW_HOME/oracle_common/modules/oracle.adf.share.ca_11.1.1/adf-share-base.jar.

- MW_HOME/oracle_common/modules/oracle.adf.share_11.1.1/jsp-el-api.jar.

- MW_HOME/oracle_common/modules/oracle.adf.businesseditor_11.1.1/adf-businesseditor.jar.

- MW_HOME/oracle_common/modules/oracle.adf.share_11.1.1/adflogginghandler.jar.

- MW_HOME/oracle_common/modules/oracle.jps_11.1.1/jps-manifest.jar.

- MW_HOME/modules/javax.jsp_1.3.0.0_2-1.jar.

- MW_HOME/oracle_common/modules/oracle.mds_11.1.1/mdsrt.jar.

- MW_HOME/oracle_common/modules/oracle.javatools_11.1.1/resourcebundle.jar.

- MW_HOME/oracle_common/modules/oracle.javatools_11.1.1/javatools-nodeps.jar.

- MW_HOME/wlserver_10.3/server/ext/jdbc/oracle/11g/ojdbc5.jar.

- Optionally, the identity store has been seeded.

Notes:

The files Common-Model.jar and DataSecurity-Model.jar are expected to be in the paths indicated above, but, depending on the environment, the could be installed in some other location. To find out the location of those files in your environment, invoke the following commands at the top of the MW_HOME directory:

>find . -name "Common-Model.jar"
>find . -name "DataSecurity-Model.jar"

DSDataMigrator is executed automatically when (and only when) a patch containing the data security grants seed data file FndGrantsSD.xml is applied to the environment. In particular, the script is not executed automatically if the seed data file is applied manually.

5.7.2.2 DSDataMigrator Syntax

DSDataMigrator is located in the directory oracle.apps.fnd.applcore.dataSecurity.util, and it has the following syntax (arguments are written in separate lines for the sake of clarity only):

java -classpath $CLASSPATH
-Doracle.security.jps.config=path to the jps-config-jse.xml file
-DFND_DS_GUID_RECON_LOG_DIR=path to the log output directory
DSDataMigrator -dsdburl dsdbURL
-dsdbuser dsdbUser
-silentMode <true_or_false>
-forceProcessAllRows true|false
-policyStripe FA policy stripe name
-idStoreOnly true|false
-validationMode true|false

When run and before processing security data, the command prompts the administrator for the database password.

The meaning of the arguments is as follows:

- oracle.security.jps.config specifies the location of the configuration file jps-config-jse.xml where the policy store and identity store are configured. This file must include the appropriate bootstrap credentials to access the policy store. The following fragment of a configuration file illustrates the specification of credentials for a policy store instance:

<serviceInstance provider="ldap.policystore.provider" name="policystore.ldap">
<property value="OID" name="policystore.type"/>
<property value="bootstrap_123456" name="bootstrap.security.principal.key"/>
<property value="cn=myFarm123" name="oracle.security.jps.farm.name"/>
<property value="cn=FusionAppsPolicies" name="oracle.security.jps.ldap.root.name"/>
<property value="ldap://example.com:33060" name="ldap.url"/>
</serviceInstance>

<serviceInstance location="./bootstrap" provider="credstoressp" name="bootstrap.cred">
<property value="./bootstrap" name="location"/>
</serviceInstance>

Typically, the file jps-config-se.xml is located in the directory DOMAIN_HOME/servers/server_name/CommonDomain/config/fmwconfig. If this file is moved to a different location, the bootstrap directory (which contains the file cwallet.sso) must also be moved to that new location.

- dsdburl specifies the URL of the data base where Oracle Fusion Data Security is stored.

- dsdbuser specifies the name of the user that can access the data base.

- silentMode specifies whether the command should raise exceptions when an entry is not found in the OID server. Set to TRUE to prevent raising these kind of exceptions; otherwise, set to FALSE. Default value: FALSE.

- forceProcessAllRows specifies whether all rows in the FND_GRANTS table should be processed. Set to TRUE to process all rows in that table; otherwise, set to FALSE. The default behavior is FALSE and processes just those rows with the compile_flag is set to Y.

- policyStripe specifies the name of the Oracle Fusion application stripe in the policy store. Typical values are fscm, crm, and hcm.

- idStoreOnly specifies whether only data security grants granting to enterprise roles should be processed. Set to TRUE to process only grants granting to enterprise roles; otherwise, set to FALSE to process all grants. When set to TRUE, the value of the argument policyStripe is ignored. Default value: FALSE.

- validationMode specifies to run the script in read only mode (validation mode). Set to TRUE to run the script without updating the database data. Set to FALSE to run the script and update database data. Default value: FALSE. A validation run of the script is useful to find out if any reconciliation is needed between the database and the OID store.

5.7.2.3 Examples of Use

Running the program without any arguments prints out the usage instructions; a sample invocation (in a non-multi-tenant environment) is the following:

java -classpath $CLASSPATH
-Doracle.security.jps.config=/home/sayarram/work/jps/jps-config-jse.xml
oracle.apps.fnd.applcore.dataSecurity.util.DSDataMigrator
-dsdburl myURL -dsdbuser fusion -silentMode true
-forceProcessAllRows true -policyStripe fscm

When run, the program generates a log file with the details of records processed, warnings, errors, and a summary of what has been processed.

A sample invocation in a multi-tenant environment is the following:

java -classpath $CLASSPATH -Doracle.security.jps.config=/home/sayarram/work/jps/jps-config-jse.xml
oracle.apps.fnd.applcore.dataSecurity.util.DSDataMigrator
-dsdburl myURL -dsdbuser fusion -silentMode true -forceProcessAllRows true
-policyStripe fscm

5.8 Password and Certificate Management

This section explains how to set certain user passwords and manage self-signed certificates, and contains the following topics:

- Section 5.8.1, "Changing the Oracle Fusion Middleware Administrative User Password"

- Section 5.8.2, "Changing OIM Passwords"

- Section 5.8.3, "Updating Certificates with the Certificate Renewal Utility"

5.8.1 Changing the Oracle Fusion Middleware Administrative User Password

During the Oracle Fusion Applications installation, you must provide a password for the Oracle Fusion Middleware administration user. By default, this administrator takes the Super User value you specified on the Identity Management page when creating the provisioning plan. The password is the one specified when adding the user to the identity store.

Then, you can use this account to log in to Fusion Applications Control and the Oracle WebLogic Server Administration Console for the first time. You can create additional administrative accounts using the WLST command line or the Oracle WebLogic Server Administration Console.

You can change the password of the administrative user using the Oracle WebLogic Server Administration Console or the WLST command line, as explained in the following topics:

- Section 5.8.1.1, "Changing the Oracle Fusion Middleware Administrative User Password Using the Command Line"

- Section 5.8.1.2, "Changing the Oracle Fusion Middleware Administrative User Password Using the Administration Console"

If your configuration uses FAAdmin as the Oracle Fusion Middleware administrative user, you can also use the password-reset-tool script to change the password.

5.8.1.1 Changing the Oracle Fusion Middleware Administrative User Password Using the Command Line

To change the Oracle Fusion Middleware administrative user password or other user passwords using the command line, you invoke the method UserPasswordEditorMBean.changeUserPassword, which is extended by the security realm's AuthenticationProvider MBean.

5.8.1.2 Changing the Oracle Fusion Middleware Administrative User Password Using the Administration Console

To change the password of the Oracle Fusion Middleware administrative user using the Oracle WebLogic Server Administration Console, proceed as follows:

1. Navigate to the Oracle WebLogic Server Administration Console.

2. From the target navigation pane, select Security Realms. The Summary of Security Realms page is displayed.

3. Select a realm, such as myrealm. The Settings for the realm page is displayed.

4. Select the Users and Groups tab, then the Users tab. Select the user. The Settings for user page is displayed.

5. Select the Passwords tab.

6. Enter the new password twice.

7. Click Save.

5.8.2 Changing OIM Passwords

In production environments, certain passwords are required to be reset periodically. For UNIX environments, the password-reset-tool utility provides a way to reset passwords of bind users.

Specifically, this tool can be used to reset passwords of the following users: FAAdmin, IDROUser, IDRWUser, PolicyRWUser, and oamadminuser. For a configuration that does not use FAAdmin as the administrative user, use one of the methods described in Section 4.6.

Note:

Typically, a system outage is scheduled and expected while the password-reset-tool utility is running. Make a note of the new passwords you submit to the tool (those passwords cannot be retrieved in plain text and may need to be provided later on).

5.8.2.1 Syntax and Example of Use

To use the password-reset-tool utility:

1. Prepare the Oracle Fusion Applications environment for the password-reset-tool utility by ensuring the following prerequisites are fulfilled:

- Java is installed on the system and inserted in the path.

- ANT is installed on the system and inserted in the path.

- Ensure the provisioning plan is available at APPLICATIONS_BASE/provisioning/plan/provisioning.plan.

- You know the password for cn=orcladmin (the administrative user for Oracle Identity Management).

2. Ensure the Administration Servers for all domains are up.

3. At an operating system command prompt for the CommonDomain domain, navigate to the location of the password-reset-tool utility:

(UNIX) FA_ORACLE_HOME/lcm/idmpasswordreset/bin

FA_ORACLE_HOME is the Oracle Fusion Applications Oracle home located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications

The password-reset-tool utility is not available on Windows.

4. Run the password-reset-tool utility as illustrated in the following sample invocation:

password-reset-tool.sh APPLICATIONS_BASE/provisioning/plan/provisioning.plan

5. When prompted, enter the password for cn=orcladmin.

6. When prompted, enter Y for the password of the users you want to change, and enter N for all other users.
If you are not using faadmin for the Oracle Fusion Middleware administrative user, then answer N for that user.

7. Enter the new passwords.

8. Let the utility run to completion (without interruption).

9. Stop and restart all the Administration Servers.

5.8.3 Updating Certificates with the Certificate Renewal Utility

The Certificate Renewal Utility enables updating self-signed certificates. You must run this utility on pre-Release 5 environments to keep those environments working.

The utility details are explained in the following sections:

- Section 5.8.3.1, "About the Certificate Renewal Utility"

- Section 5.8.3.2, "Locating the Certificate Renewal Utility"

- Section 5.8.3.3, "Before Using the Certificate Renewal Utility"

- Section 5.8.3.4, "Using the Certificate Renewal Utility"

- Section 5.8.3.5, "After Using the Certificate Renewal Utility"

5.8.3.1 About the Certificate Renewal Utility

The certificate renewal utility updates and replaces old self-signed certificates with new self-signed certificates that have a three-year life span. The utility updates the following keystores:

- OWSM keystore default-keystore.jks for all available domains under every host, that is, under:

(UNIX) APPLICATIONS_CONFIG/domains/host_name/domain_home/config/fmwconfig
(Windows) APPLICATIONS_CONFIG\domains\host_name\domain_home\config\fmwconfig

- OWSM keystore owc_discussions.jks for the CommonDomain domain only.

- fusion_trust.jks and host_fusion_identity.jks located in either WL_HOME/server/lib or APPLICATIONS_CONFIG/keystores.

- Oracle wallet cwallet.sso file present under WL_HOME/server/lib.

Note:

In a multi-host environment, there are as many host_fusion_identity.jks files as there are hosts.

5.8.3.2 Locating the Certificate Renewal Utility

The certificate renewal utility is located at:

(UNIX) APPLICATIONS_BASE/fusionapps/applications/lcm/facertsutil
(Windows) APPLICATIONS_BASE\fusionapps\applications\lcm\facertsutil

The utility uses a properties file with path definitions. A reference properties file is located at:

(UNIX)
APPLICATIONS_BASE/fusionapps/applications/lcm/facertsutil/config/crutil.properties
(Windows)
APPLICATIONS_BASE\fusionapps\applications\lcm\facertsutil\config\crutil.properties

5.8.3.3 Before Using the Certificate Renewal Utility

Before using the certificate renewal utility, proceed as follows:

1. If SSL is not enabled:

1. Stop all the Administration Servers, either manually or using the fastartstop utility.

2. Stop the Node Manager.

2. If SSL is enabled:

1. Stop all the Administration Servers.

2. Stop middle tier components; however, the database and identity management components can continue running.

3. Navigate to the location of fusion_trust.jks, either:

(UNIX) APPLICATIONS_CONFIG/keystores
(Windows) APPLICATIONS_CONFIG\keystores

or

(UNIX) WL_HOME/server/lib
(Windows) WL_HOME\server\lib

4. Run keytool to check the validity of current certificates in the keystore as illustrated in the following sample invocation:

keytool -list -keystore fusion_trust.jks
-alias fa-internal.example.com_fusion -v

keytool will prompt for the store password.

5. Ensure that the properties file is configured with the correct paths required during utility execution.
Here is an example properties file:

# For all the paths append _path as suffix so that the validation
# will be done at the time of loading the properties

# Best practice to use '/' as path separator

# fusion trust, cwallet_sso and *_fusion identity keystore locations
# Old path
#wlks_path=/scratch/aime/work/APPTOP/fusionapps/wlserver_10.3/server/lib
# New path with flex clone changes
wlks_path=%appnconfig_path%/keystores

# Instance specific files FUSION_env and FUSION_prov properties files
# Old path
#fusion_props_path=/scratch/aime/work/APPTOP/fusionapps/applications/admin
# New path with flex clone changes
fusion_props_path=%appnconfig_path%/fapatch

# path to get list of all domains configured on different hosts
# for default and owc_discussions keystore files
domainks_domains_path=%appnconfig_path%/domains
domainks_nm_path=%appnconfig_path%/nodemanager

# Certificate validity period configured for 3 years by default.
# This value can be changed as per the renewal requirement
validity_period=1095

# location of faInst.loc file
fainst_loc_path=%appbase%/fusionapps/faInst.loc

# Path of intermediate config property file generated by this utility
# which stores information of all the domains that needs to be updated
# generated with name "domains.properties"
config_prop_path=%appnconfig_path%/lcm/admin/certsutil/

# hosts for which nodemanager.domains do not exist
# delimiter is ':'
skip_hosts_for_nm=appohs.oracleoutsourcing.com

# Domains for which domain certs do not exist
# delimiter is ':'
skip_domains_for_domain_certs=OSNDomain

# This is the host from which we consider default_keystore.jks
# Note: It is just a standard to always pick default_keystore.jks from admin host
# This is optional and can be left empty if no standard host should be considered for default keystore
admin_host=

Note the following points:

- appbase and appconfig_path are the variables used to replace the actual paths implicitly.

- Paths can be hard coded explicitly if they do not match the requirement.

5.8.3.4 Using the Certificate Renewal Utility

To execute the utility, proceed as follows:

1. Navigate to:

(UNIX) APPLICATIONS_BASE/fusionapps/applications/lcm/facertsutil/bin
(Windows) APPLICATIONS_BASE\fusionapps\applications\lcm\facertsutil\bin

2. Set the JAVA_HOME environment variable to:

(UNIX) APPLICATIONS_BASE/fusionapps/jdk6
(Windows) APPLICATIONS_BASE\fusionapps\jdk6

3. Run the certificate renewal utility using this syntax:

(UNIX)
./facertsutil.sh -inputfile path_to_properties_file -appbase APPLICATIONS_BASE

(Windows)
facertsutil.cmd -inputfile path_to_properties_file -appbase APPLICATIONS_BASE

For example:

./facertsutil.sh -inputfile ../config/crutil.properties -appbase APPLICATIONS_BASE

5.8.3.5 After Using the Certificate Renewal Utility

After using the certificate renewal utility, proceed as follows:

1. Navigate to the location of fusion_trust.jks, either:

(UNIX) APPLICATIONS_CONFIG/keystores
(Windows) APPLICATIONS_CONFIG\keystores

or

(UNIX) WL_HOME/server/lib
(Windows) WL_HOME\server\lib

2. Run keytool to check that certificate validity was extended by the period specified in the properties file:

keytool -list -keystore fusion_trust.jks
-alias fa-internal.example.com_fusion -v

keytool will prompt for the store password.

3. If SSL is not enabled:

1. Start the Node Manager.

2. Start all the Administration Servers either manually or using the fastartstop utility.

4. If SSL is enabled:

1. Start all middle tier components.

2. Start all the Administration Servers.

5.9 Related Links

Security concepts are also discussed in the Fusion Applications online help and in the following book:

- Oracle® Fusion Applications Understanding Security

6 Managing Oracle Enterprise Scheduler Service and Jobs

This chapter describes how to configure and manage Oracle Enterprise Scheduler and Oracle Enterprise Scheduler jobs. Oracle Enterprise Scheduler enables scheduling and running jobs within a particular time frame, or "workshift," using rules to create work assignments. Oracle Enterprise Manager Fusion Applications Control enables you to define, control and manage Oracle Enterprise Scheduler job metadata. The job metadata includes job definitions, job requests, job sets (a collection of job requests), incompatibilities (job definitions and job sets that cannot run at the same time for a given application), and schedules governing the execution of job requests. Oracle Enterprise Manager Cloud Control (Cloud Control) enables you to manage a subset of Oracle Enterprise Scheduler components, including job requests, schedules, alerts, and the starting and stopping of request processors and dispatchers.

This chapter includes the following topics:

- Section 6.1, "Introduction to Managing Oracle Enterprise Scheduler"

- Section 6.2, "Viewing the Oracle Enterprise Scheduler Administration Pages"

- Section 6.3, "The Scheduling Service Home Page"

- Section 6.4, "Configuring Oracle Enterprise Scheduler"

- Section 6.5, "Searching for Configuration Changes to Oracle Enterprise Scheduler in Cloud Control"

- Section 6.6, "Viewing General Oracle Enterprise Scheduler Instance Information"

- Section 6.7, "Starting and Stopping Oracle Enterprise Scheduler Service Components"

- Section 6.8, "Managing Oracle Enterprise Scheduler Requests"

- Section 6.9, "Monitoring Oracle Enterprise Scheduler Service Activity"

- Section 6.10, "Managing Purge Policies in Fusion Applications Control"

- Section 6.11, "Managing Job Metadata"

- Section 6.12, "Managing Work Assignments and Workshifts"

- Section 6.13, "Managing Oracle ADF Connections"

- Section 6.14, "Managing Application Properties"

- Section 6.15, "Managing Application and Role Policies"

- Section 6.16, "Managing Oracle Enterprise Scheduler Web Services"

- Section 6.17, "Managing Logging for Oracle Enterprise Scheduler"

- Section 6.18, "Managing Alerts for Oracle Enterprise Scheduler in Cloud Control"

- Section 6.19, "Managing Oracle Enterprise Scheduler Using Oracle WebLogic Scripting Tool Commands"

6.1 Introduction to Managing Oracle Enterprise Scheduler

Oracle Enterprise Scheduler provides the ability to define, schedule, and run different types of jobs, including Java, PL/SQL, spawned jobs, and binary scripts. You can run jobs on demand, or schedule them to run in the future.

Oracle Enterprise Scheduler provides scheduling services for the following purposes:

- Distributing job request processing across a grid of application servers

- Running Java, PL/SQL, spawned, and binary script jobs

- Processing multiple jobs concurrently

Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) enables you to start and stop, monitor, configure, and manage Oracle Enterprise Scheduler services, components, and job requests.

The main Oracle Enterprise Scheduler page provides an overview of the status of the scheduler components, the top running, and completed scheduled job requests, and a performance summary of scheduled job requests. You can further monitor activity and diagnose problems by examining Oracle Enterprise Scheduler logs and comparing current to historical performance data.

Drilling down to the main components of Oracle Enterprise Scheduler, you can configure job request processors and dispatchers. A job request processor is bound to a particular Oracle Enterprise Scheduler server, and is responsible for allocating threads for job requests. A job request dispatcher polls for job requests.

After the Oracle Enterprise Scheduler components are configured, you can define work allocation and purge policies. Work allocation definitions enable you to configure windows of time during which jobs can run (workshifts), rules that govern their execution and bindings to a particular server and request processor (work assignments). Purge policies enable you to define for a particular request processor the conditions for retaining and purging job requests associated with that request processor. You can define a schedule for managing the execution of work assignments, workshifts, and purge policies.

6.2 Viewing the Oracle Enterprise Scheduler Administration Pages

To view the Oracle Enterprise Scheduler administrative tasks in Fusion Applications Control or Cloud Control:

1. From the navigation pane, expand the farm name and then Scheduling Services, and select the Oracle Enterprise Scheduler component.

The Scheduling Service home page appears. For more information about the contents of the home page, see Section 6.3.

2. Select the Scheduling Service menu.

The Scheduling Service menu displays the following options.

Menu Option

Description

Home

Displays the Scheduling Service home page. For more information about the contents of this page, see Section 6.3.

Control

Displays the following options:

- Start Up: This option runs the Oracle Enterprise Scheduler server. For more information, see Section 6.7.

- Shut Down: This option shuts down the Oracle Enterprise Scheduler server. For more information, see Section 6.7.

Logs

The View Log Message option displays the Log Messages page for viewing the contents of event log files. For more information, see Section 6.17.

The log files are stored in the following directories:

- DOMAIN_HOME/servers/SERVER_HOME/logs

- DOMAIN_HOME/servers/SERVER_HOME/logs/apps

- DOMAIN_HOME/servers/SERVER_HOME/logs/owsm/msglogging/diagnostic.log

- DOMAIN_HOME/servers/SERVER_HOME/sysman/log/emoms.log

Job Requests

Displays the following options:

- Search Job Requests: This option enables you to search for job requests according to particular parameters. For more information, see Section 6.8.2.

- Submit Job Request: This option enables you to submit an execution request for a particular job. For more information, see Section 6.8.1.

- Define Schedules: This option enables you to create a schedule for submitting job requests. For more information, see Section 6.8.1.2.

Performance

Displays the following options:

- Service Summary: This option displays a brief overview of the service performance. For more information, see Section 11.4.2.1.

- Current Activity: This option displays the current Oracle Enterprise Scheduler activity. For more information, see Section 11.4.2.2.

- Historical Reports: This option displays a chart or table depicting previous Oracle Enterprise Scheduler data. For more information, see Section 11.4.2.4.

Request Processor

Displays the following options:

- Start/Stop: This option causes the request processor to start or stop running. For more information, see Section 6.7.

- Configure: This option displays the Configure Request Processor page, which enables the request processor, creates work assignment bindings, and so on. For more information, see Section 6.4.

Request Dispatcher

Displays the following options:

- Start/Stop: This option causes the request dispatcher to start or stop running. For more information, see Section 6.7.

- Configure: This option displays the Configure Request Dispatcher page, which enables the request dispatcher, manages polling intervals, and so on. For more information, see Section 6.4.

Purge Policies

This option enables you to configure and manage job request purge policies including job request purge criteria, retention criteria and purge policy schedules. For more information, see Section 6.10. Available in Fusion Applications Control only.

Work Allocation

Displays the following options:

- Work Assignments: This option displays the Work Assignments page which enables you to create, edit, and delete work assignments. For more information, see Section 6.12.

- Workshifts: This option displays the Workshifts page which enables you to create, edit, and delete workshifts. For more information, see Section 6.12.

- Schedules: This option displays the Schedules page which enables you to create, edit, and delete schedules for work assignments, workshifts, and job request purge policies. For more information, see Section 6.12.

Available in Fusion Applications Control only.

Job Metadata

Displays the following options:

- Job Definitions: This option displays the Job Definitions page, which enables you to manage job definitions. For more information, see Section 6.11.1.

- Job Sets: This option displays the Job Sets page, which enables you to create and edit job sets for a given application. For more information, see Section 6.11.2.

- Incompatibilities: This option displays the Incompatibilities page, which enables you to create and edit incompatibilities for a given application. For more information, see Section 6.11.3.

Available in Fusion Applications Control only.

ESS Connections

Displays a page that enables defining connections to Oracle ADF. For more information, see Section 6.13.

Available in Fusion Applications Control only.

Web Services

Displays a page that provides an overview of the web services in the application including web service endpoints and application-level metrics. For more information, see Section 6.16.

Available in Fusion Applications Control only.

Security

Displays the following options:

- Application Policies: This option displays the authorization policies that an application relies upon for controlling access to its resources. For more information, see Section 6.15.

- Application Roles: This option displays the roles used by security aware applications specific to the application. For more information, see Section 6.15.

Available in Fusion Applications Control only.

General Information

Target Information

Displays general details about the Oracle Enterprise Scheduler instance. Known as Target Information in Cloud Control. For more information, see Section 6.6.

6.3 The Scheduling Service Home Page

The Scheduling Service home page provides an overview of the performance of Oracle Enterprise Scheduler components and jobs, including the component status, the number of completed job requests in the last hour, and the processing times for running jobs.

You can use this page as a starting point for monitoring and administering Oracle Enterprise Scheduler. Figure 6-1 shows a portion of the Scheduling Service home page.

Figure 6-1 Scheduling Service Home Page

This page contains the following regions:

- Section 6.3.1, "Top 10 Long Running Requests and Top 10 Ready Job Requests Regions"

- Section 6.3.2, "Scheduler Components Region"

- Section 6.3.3, "Completed Requests Region"

- Section 6.3.4, "Response and Load Region"

- Section 6.3.5, "Performance Region"

- Section 10.4.1.1, "Monitoring and Diagnostics Region" (Cloud Control only)

6.3.1 Top 10 Long Running Requests and Top 10 Ready Job Requests Regions

The Top 10 Long Running Requests region displays the top 10 long running scheduled job requests, including request ID, job runtime, job definition used, executing application, job execution type, and description. You can set the scope of the top 10 long running requests displayed to the current scheduling service only, or all scheduling services sharing the Oracle Enterprise Scheduler repository.

The Top 10 Ready Job Requests tab displays the top 10 scheduled job requests that await execution. The tab displays the same information as the Top 10 Long Running Requests tab, except the wait time is shown for each job rather than the runtime.

6.3.2 Scheduler Components Region

The Scheduler Components region displays the components of Oracle Enterprise Scheduler, including the job request processor and dispatcher. The tab shows the status of each component, the name of the server to which it is deployed, and whether the component is enabled. You can start and stop each component as required.

6.3.3 Completed Requests Region

The Completed Requests region displays the scheduled jobs completed within the last hour.

6.3.4 Response and Load Region

The Response and Load region displays performance monitoring statistics regarding the time required to process job requests.

Table 6-1 describes the performance monitoring statistics in the Response and Load region.

Table 6-1 Response and Load Statistics

Statistic

Description

Average processing time for last hour

This metric specifies the average time required to process jobs during the last hour.

Requests completed per hour

This metric specifies the number of scheduled job requests completed within the last hour.

6.3.5 Performance Region

The Performance region displays performance data for job requests, such as processing times and wait times.

Table 6-2 describes the performance monitoring statistics in the Performance region.

Table 6-2 Performance Statistics

Statistic

Description

Maximum processing time

This metric specifies maximum amount of time required to process a scheduled job.

Average processing time

This metric specifies average amount of time required to process a scheduled job.

Maximum wait time

This metric specifies maximum amount of time during which a scheduled job waits before running.

Average wait time

This metric specifies the average amount of time during which a scheduled job waits before running.

6.4 Configuring Oracle Enterprise Scheduler

You can run Oracle Enterprise Scheduler as a single instance or as a cluster of servers. Each Oracle Enterprise Scheduler server includes a request processor and dispatcher, both of which must be configured.

Configuring Oracle Enterprise Scheduler involves the following main steps:

1. (Optional). Configure a cluster. Configure a cluster of Oracle Enterprise Scheduler servers. For more information about configuring a cluster, see the section "Expanding an Oracle Enterprise Scheduling Service Cluster" in the chapter "Performing Basic Administration Tasks" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

2. Configure the request processor. Configure the Oracle Enterprise Scheduler component that receives and manages job requests. For more information about configuring the request processor, see the section "Configuring a Request Processor" in the chapter "Performing Basic Administration Tasks" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

3. Configure the request dispatcher. Configure the Oracle Enterprise Scheduler component that polls the request processor for job requests and dispatches jobs. For more information about configuring the request dispatcher, see the section "Configuring a Request Dispatcher" in the chapter "Performing Basic Administration Tasks" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

6.5 Searching for Configuration Changes to Oracle Enterprise Scheduler in Cloud Control

You can search for changes made to configurations using the search page in Cloud Control.

To search for changes to configurations to Oracle Enterprise Scheduler in Cloud Control:

1. Display the alerts for Oracle Enterprise Scheduler as described in Section 6.18.2.

2. In the Monitoring and Diagnostics pane, click the number of configuration changes to display on the search page for configuration changes to Oracle Enterprise Scheduler alerts.

3. Configure your search.

- Target Type: Select the Scheduler Service or Scheduler Service Group.

- Target Name: Search for or enter the name of the target. From the dropdown list, select the criterion by which you want to search for the target name: contains, is, is not, does not contain, starts with, ends with.

- Type of Change: From the dropdown list, select the type of configuration change for which you want to search.

- Show History Records: From the dropdown list, select the way you want the records to display, Grouped or Show All.

- Include Member Target Changes: Select to display configuration changes made to members of the target.

- Changes Discovered in Last: Select to search for changes discovered within a given number of days, weeks, or months.

- Changes Discovered: Select to search for changes discovered within a particular time period. Use the After and Before fields to enter the relevant time period.

4. Click Search to search for the changes.

6.6 Viewing General Oracle Enterprise Scheduler Instance Information

Oracle Fusion Applications Control enables viewing information regarding the particular instance of Oracle Enterprise Scheduler. The general information popup window displays the locations of Oracle Fusion Middleware, the domain and the target application, and the version of Oracle Fusion Middleware currently running and the URI of the hosting server also are displayed.

To view general information about Oracle Enterprise Scheduler:

1. From the Scheduling Service menu, select one of the following:

- In Fusion Applications Control, select General Information.

- In Cloud Control, select Target Information.

2. Oracle Fusion Applications Control displays the following information:

- Target Name: The location of the target application, in this case, Oracle Enterprise Scheduler, running on the domain.

- Version: The version number of Oracle Fusion Middleware.

- Middleware Home: The location of the Oracle Fusion Middleware directory.

- Domain Home: The full path of the domain.

- Host: The URI of the hosting server.

6.7 Starting and Stopping Oracle Enterprise Scheduler Service Components

You can start and stop an instance of Oracle Enterprise Scheduler from Oracle Fusion Applications Control.

The following components can be started and stopped:

- Oracle Enterprise Scheduler instance.

- Job request processor and dispatcher.

Note:

Stopping an Oracle Enterprise Scheduler instance or component is not recommended. Stopping an Oracle Enterprise Scheduler component does not stop job requests from accumulating in the queue.

For more information about starting and stopping Oracle Enterprise Scheduler components, see the section " Starting and Stopping Oracle Enterprise Scheduling Service Components" in the chapter "Performing Basic Administration Tasks" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

6.8 Managing Oracle Enterprise Scheduler Requests

A job request is a request sent from a deployed application to Oracle Enterprise Scheduler to execute a job. Jobs are configured using job definitions, which specify the parameters of the job and associate them with a particular application. A job set is a collection of job requests that is grouped together.

This section contains the following topics:

- Section 6.8.1, "Submitting an Oracle Enterprise Scheduler Job Request"

- Section 6.8.2, "Searching for Oracle Enterprise Scheduler Job Requests"

For more information about searching for jobs, viewing job request details, and holding and canceling jobs, see the section "Searching for Oracle Enterprise Scheduling Service Job Requests" in the chapter "Managing Oracle Enterprise Scheduler Requests" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

6.8.1 Submitting an Oracle Enterprise Scheduler Job Request

You can submit a job request for a particular application using a job definition and a schedule by which you want the job to run.

This section contains the following topics:

- Section 6.8.1.1, "Creating a Job Request"

- Section 6.8.1.2, "Specifying a Job Request Schedule"

6.8.1.1 Creating a Job Request

To create a job request, select a job definition for the job request, then select or create a schedule.

You may want to configure system properties for the job request, such as the number of retries to attempt in the event of an execution error and a time out value for the job.

To submit a job request:

1. Use a pre-existing job definition, or create a new job definition, as described in Section 6.11.1.2.

2. Go to the Submit job request page by clicking the Scheduling Service menu and selecting Job Requests. Then, select Submit Job Request.

3. Select the application for which you want to submit the job request.
From the application dropdown list, select the Java EE application deployment name.

4. Under Job Request Details, enter information about the job request in the Details field.

5. Select a job definition.

1. Under Job Definition, click the search button next to the Job Definition field.

2. Search for the required job definition.
In the Job Definition Name field, enter the name of the job definition you want to find.

Click the arrow next to the field to search for the job definition.

3. From the search results table, select the job definition name.

6. In the Parameters region, define any parameters you want to use with the scheduled job request.

1. In the Parameters region, click Add to add a parameter.
Enter a name and value for the parameter.

2. You can set a value for any of the system properties available. Table 6-3 lists the names and descriptions of system properties.
For example, you may want to configure the number of permissible retries for the job (SYS_retries) or a time out value (SYS_request_timeout).

7. Select a schedule by which the job is to run.

- Once: Select a single date and time by clicking the calendar icon.

- Use existing schedule: Click the search button to search for and select an existing schedule.

- Specify schedule: Create your own schedule as you need it. Follow the instructions in Section 6.8.1.2.

6.8.1.2 Specifying a Job Request Schedule

In the Submit Job Request page, select Specify a Schedule to enable configuring your own schedule for a job request. You can configure a recurring job request using a job request schedule. Alternatively, you can configure a job request to run immediately or before a specified end date. Use a pre-existing job definition, or create a new job definition, as described in Section 6.11.1.2.

To specify a schedule:

1. In the Start section, select the starting date and time for the job request.
Select Immediately to submit the job request right away.

Select Later to select a subsequent start date.

2. In the Repeating section, select the desired frequency of the job request submission schedule.
From the Repeat dropdown list, select Every N minutes, Every N hours, Every N days or Every N weeks.

In the Frequency field, enter the number of minutes, hours, days, or weeks.

3. In the End Date section, select the date and time at which the schedule job is to end.

- No End Date: Select to specify a continuous schedule for the job request.

- Specified End Date: Select to specify a particular end date for the schedule. Click the calendar icon next to the Date field and select a date and time. You can save the schedule by selecting the Save Schedule checkbox and entering a name for the schedule in the Name field. You can also enter the package name and description.

6.8.2 Searching for Oracle Enterprise Scheduler Job Requests

The Request Search page enables searching for job requests. Using the Request Search page, you can:

- Conduct a simple search that returns a list of job request details, including job request ID, executing application, job request status, and so on.

- Conduct an advanced search that returns the same information as the simple search, and the date and time of execution, the runtime or wait time of the job request, the number of retries, and any error type that may have occurred during execution.

- Modify the column display in the search results table.

This section contains the following topics:

- Section 6.8.2.1, "Searching for a Job Request Using Simple Search"

- Section 6.8.2.2, "Searching for a Job Request Using the Advanced Search Feature"

- Section 6.8.2.3, "Configuring the Display of Columns in the Search Results Table"

6.8.2.1 Searching for a Job Request Using Simple Search

A simple search enables you to find a job request according to particular criteria such as job request ID, related application, job request status, and so on, or by any one of several preconfigured quick searches.

To search for a job request:

1. Go to the Request Search page by clicking the Scheduling Service menu and selecting Job Requests. Then select Search Job Requests.

2. Select the scope of the job request search by selecting one of the following options:

- Current Scheduling Service: Select this option to search for job requests submitted only to the scheduling service with which you are currently working.

- All Scheduling Services sharing the ESS repository: Select this option to search for job requests submitted to all scheduling services sharing the repository, for example all scheduling services in a cluster of scheduling services.

3. To run a fast search, from the Quick Search dropdown list, select a pre-configured search option as shown in the following list:

- Requests submitted in the last hour

- Pending requests submitted in the last 24 hours

- Errored requests submitted in the last 24 hours

- All running requests

- All pending requests

- Requests currently being retried

- Requests retried in the last 24 hours

- Requests that resulted in a system error in the last 24 hours

- Requests that resulted in a business error in the last 24 hours

To run a regular job request search, skip this step.

4. Select the criteria by which to search for job requests:

- Request ID: Enter the ID of the job request for which you want to search.

- Application: From the Application dropdown list, select the name of the application related to the job request for which you want to search. Alternatively, select All to search for job requests in all applications.

- Status: Select the status of the job request for which you want to search. Alternatively, select All to search for job requests with all statuses. Statuses are listed here.

- WAIT

- READY

- PENDING_VALIDATION

- EXPIRED

- WARNING

- VALIDATION_FAILED

- RUNNING

- BLOCKED

- SCHEDULE_ENDED

- Execution Type: Select JAVA_TYPE, SQL_TYPE, or PROCESS_TYPE.

- Submitted: From the dropdown list, select the time period in which the job request to be searched has been submitted. Options include Last Hour, Last 24 Hours, Last 7 Days, and Last 31 Days.

- Submitted By: In the field, enter the name of the user who submitted the job request you want to find.

- Job Definition: Click the Search button next to the field and select the relevant job definition name.

- Work Assignment: Click the Search button next to the field and select a work assignment from the list.

5. (Optional). Conduct an advanced search by clicking the Advanced button.

6. Click Search to submit the job request search.

6.8.2.2 Searching for a Job Request Using the Advanced Search Feature

You can perform an advanced search in the Request Search page by clicking the Advanced button.

To search for a job request:

1. Enter a basic search for a job request. Go to the Request Search page by clicking the Scheduling Service menu and selecting Job Requests. Then Select Search Job Requests.

2. Select the scope of the job request search by selecting one of the following options:

- Current Scheduling Service: Select this option to search for job requests submitted only to the scheduling service with which you are currently working.

- All Scheduling Services sharing the ESS repository: Select this option to search for job requests submitted to all scheduling services sharing the repository, for example all scheduling services in a cluster of scheduling services.

3. Select your basic search criteria. For more information, see Section 6.8.2.1.

4. Click Advanced to display the fields for the advanced search.

5. In the Date Range section, configure the date range in which to search for job requests. The date on the left is the beginning date and the date on the right is the end date. For each date, click the calendar icon to the right of the field to select the date and time.

- Submitted between: Enter the start and end dates during which the job request was submitted.

- Scheduled between: Enter the start and end dates during which the job request is scheduled to run.

- Completed between: Enter the start and end dates during which the job request finished running.

6. In the Run Time/Wait Time section, select the run time or wait time of the job request for which you are searching, such as long or short running requests.

- None: Select if no run time or wait time is to be specified.

- Long running requests: Select to search for requests running longer than a specified number of seconds, minutes, hours, or days.
In the Minimum Run Time field, enter the lower limit of the time period for which the job request runs. From the dropdown list, select the required unit of time.

- Short running requests that waited: Select to search for job requests running longer than a specified period and waiting less than a specified period.
In the Maximum Run Time field, enter the upper limit of the time period for which the job request runs. From the dropdown list, select Seconds, Minutes, Hours, or Days.

In the Minimum Wait Time field, enter the lower limit of the time period during which the job request waits to run. From the dropdown list, select Seconds, Minutes, Hours, or Days.

- Waiting requests by time: Select to search for job requests waiting to run for a specified time period.
In the Minimum Wait Time field, enter the lower limit of the time period during which the job request waits to run. From the dropdown list, select Seconds, Minutes, Hours, or Days.

In the Maximum Wait Time field, enter the upper limit of the time period during which the job request waits to run. From the dropdown list, select Seconds, Minutes, Hours, or Days.

7. In the Retry of Failed Runs section, use the Number of Retries dropdown list to select an operator such as equal to, greater than, greater than or equal to, and so on.
In the field, enter the number of retries.

8. In the Error Type section, use the dropdown list to select the type of error:

- Business: A job ends in a business error when it must stop prematurely due to unforeseen conditions, but the job is otherwise able to exit with its data in a consistent state. A job request might end in a business error due to an application setup or configuration condition, a functional conflict that requires an early exit or corrupt or inconsistent data. You cannot retry running a job request that ends in a business error.

- System: A job ends in a system error when a technical problem occurs from which the job cannot recover, but the job otherwise exits on its own. Alternatively, the computer running the job fails. Examples include table space issues and unhandled runtime exceptions. You can retry running a job request that ends in a system error.

9. Click Search to submit the job request search.

6.8.2.3 Configuring the Display of Columns in the Search Results Table

After running a search for job requests, you can configure how the columns are displayed in the search results table.

To configure job request search results table display columns:

1. Display the main Oracle Enterprise Scheduler Request search page and display the search interface.

2. Display the list of available column names.
Click the View dropdown list and select Columns, then Show More Columns.

3. Use the arrows between the columns to move the column names from the Visible to the Hidden column, or vice versa.

4. (Optional). Reorder the columns by selecting the relevant column names and using the vertical arrows on the right to move them up or down.

5. Alternatively, display all columns by clicking the View dropdown list and select Columns, then Show All.

6.9 Monitoring Oracle Enterprise Scheduler Service Activity

The main Oracle Enterprise Scheduler page displays information regarding the top 10 long running scheduled jobs and the top 10 job requests awaiting execution in two different tabs. By default, only the job requests within the current scheduling service appear. However, you can change the scope such that all relevant scheduled jobs running on all scheduling services sharing the Oracle Enterprise Scheduler repository appear in the tabs.

Each of the Oracle Enterprise Scheduler tabs includes a table that displays a short list of top 10 long running and waiting job requests, respectively. The Show All Ready or Show All Running link at the bottom of the region goes to a search page in which it is possible to search for a more comprehensive list of relevant job requests.

Each tab displays the following information about scheduled job requests:

- Request ID: The ID associated with the job request.

- Run Time/Wait Time: The period during which the job request has been running or awaiting execution, respectively.

- Job Definition: The job definition associated with the job request.

- Submitted by: The name of the user who submitted the job request.

- Application: The name of the application with which the job request is associated.

- Execution Type: The category of job being executed—Java, SQL, or process job.

- Description: An optional description of the scheduled job request.

You can also monitor Oracle Enterprise Scheduler job requests related to a product. For more information about viewing the top scheduled job requests related to a product, see Section 10.2.3.

This section contains the following topics:

- Section 6.9.1, "Viewing Top 10 Long Running Oracle Enterprise Scheduler Requests"

- Section 6.9.2, "Viewing Top 10 Oracle Enterprise Scheduler Jobs Ready to Be Executed"

6.9.1 Viewing Top 10 Long Running Oracle Enterprise Scheduler Requests

Use the Top 10 Long Running Job Requests tab to view the job requests that have been running for the longest period on the Oracle Enterprise Scheduler service. You can alternatively change the scope of the region to display the top 10 long running job requests on all scheduling services sharing the same repository.

The job requests that are displayed will all have a status of RUNNING.

To view the top 10 long running requests:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. At the top of the Oracle Enterprise Scheduler page, click the Top 10 Long Running Requests tab to display the 10 job requests that have been running the longest.

3. To display all running job requests, click Show All Running at the bottom of the chart. This displays a search form that searches for all requests that are currently running. Click Search to display the requests.

6.9.2 Viewing Top 10 Oracle Enterprise Scheduler Jobs Ready to Be Executed

Use the Top 10 Ready Job Requests tab to view the job requests that are awaiting execution on the Oracle Enterprise Scheduler service. You can alternatively change the scope of the region to display the top 10 ready job requests on all scheduling services sharing the same repository.

The job requests that are displayed will have a status of READY.

To view the top 10 ready job requests:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. At the top of the Oracle Enterprise Scheduler page, click the Top 10 Ready Requests tab to display the 10 job requests with the status READY.

3. To display all ready job requests, click Show All Ready at the bottom of the chart. This displays a search form that searches for all requests with the status READY. Click Search to display the requests.

6.10 Managing Purge Policies in Fusion Applications Control

Purge policies enable the scheduling service to remove scheduled jobs according to specified criteria. For example, a purge policy might specify the retention of all Java job requests using a particular job definition submitted by an application for 3 days. Another purge policy might retain a particular type of job request, for example, all SQL job requests in a successful state, for only 1 day. You can also specify the frequency at which the purge policy is to run.

For more information about managing purge policies, see the section "Managing Purge Policies" in the chapter "Managing Oracle Enterprise Scheduler Requests" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

6.11 Managing Job Metadata

Oracle Enterprise Scheduler job metadata refers to the components that form the basis of scheduled job requests.

These include the following:

- Job definition: A job definition is the smallest unit of work performed in the context of the application that executes the job. A job definition is defined by a job type, such as a Java or SQL job type.

- Job set: A job set is a sequential or parallel set of job steps; a job step can be a single job or another job set. A job set and each of its job set steps can have additional parameters, the values for which are provided when the job or job set is submitted as a job request.

- Incompatibility: An incompatibility enables you to specify job definitions and job sets that cannot run concurrently.

This section contains the following topics:

- Section 6.11.1, "Managing Job Definitions"

- Section 6.11.2, "Managing Job Sets"

- Section 6.11.3, "Managing Incompatibilities"

You can manage job metadata only in Fusion Applications Control.

6.11.1 Managing Job Definitions

The Job Definitions page in Oracle Enterprise Manager Fusion Applications Control enables you to view, create, edit, duplicate, delete, and search for job definitions. Figure 6-2 shows the Manage Job Definitions tab in the Job Definitions page. The tab displays a table of job definitions and their attributes, including name, description, location, execution type, and job type.

Figure 6-2 Manage Job Definitions Tab

The Job Definitions page in Oracle Enterprise Manager Fusion Applications Control also enables you to register sources for lists of values related to job definitions and the applications that run job definitions. Figure 6-3 shows the Manage List of Values Sources tab in the Job Definitions page.

Figure 6-3 Manage List of Values Sources Tab

This section contains the following topics:

- Section 6.11.1.1, "Viewing Job Definitions"

- Section 6.11.1.2, "Creating Job Definitions"

6.11.1.1 Viewing Job Definitions

You can view the job definitions created for an application. The table of job definitions displays information about the jobs related to an application such as the job definition name, the full path to which it is saved, the job type, and so on.

Note:

In the Job Definitions page, an asterisk appears next to those jobs in the list that were seeded, and are not custom jobs. The asterisk also appears next to seeded jobs that you have customized.

To display job definitions:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Job Metadata and then select Job Definitions.
The Job Definitions page appears.

3. From the Applications dropdown list, select the name of the UI application whose job definitions you want to view.
The job definitions for that application appear in a table below the application dropdown list.

Column Name

Description

Name

This column displays the name of the job definition.

Display Name

This column displays the name of the job definition as it is shown.

Description

This column displays a description of the job definition.

Path

This column displays the full directory path to which the job definition is saved.

Execution Technology

This column displays the type of job request that you can create using the given job definition, such as a Java, C, PL/SQL, Perl, or hosted script job.

Job Type Name

This column displays the name of the job type upon which the job definition is based.

Note:

If there are applications with similar names, be sure to select the UI application. For example, you have applications called ProjectFinancialsApp and ProjectFinancialsESSApp. Select ProjectFinancialsApp as this is the UI application.

4. To view the details of a specific job definition, click the name of the relevant job definition.

6.11.1.2 Creating Job Definitions

You can create a new job definition, which you can then use to create a job request for a particular application. The job definition includes the directory path of the job to be run, the name of the application with which the job definition is associated and the job type used for the job definition.

Additional properties can be defined for a job definition as follows:

- Parameters: You can configure editable or read-only parameters to be submitted to the job request.

- Application Defined properties: You can configure properties to be filled in by users at runtime, such as Boolean, number, and string values. Application defined properties associate parameter view objects and parameter taskflows with a particular job definition or job set. For example, you can create an application defined property called parameterVO and define as its value the full name of the view object to be used in conjunction with the job definition. Alternatively, you can create an application defined property called ParameterTaskFlow with the task flow ID as its value. When the job definition runs, the application defined property defined for the job definition connects the relevant view object or task flow to the job request.

- Lists of Values: You can search for and register sources for lists of values to be used for parameters.

To create a job definition:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Job Metadata and then select Job Definitions.
The Job Definitions page displays.

3. From the Applications dropdown list, select the name of the UI application for which you want to create a job definition.

Note:

If there are applications with similar names, be sure to select the UI application. For example, you have applications called ProjectFinancialsApp and ProjectFinancialsESSApp. Select ProjectFinancialsApp as this is the UI application.

4. Click Create to create a new job definition.

5. For the new job definition, configure the following required properties:

- Name: Enter a name for the job definition.

- Display Name: Enter the name to be shown for the job definition.

- Path: Enter the path of the job to be run.

- Application Name: From the dropdown list, select the name of the application with which you want to associate the job definition.

- Job Type Name: From the dropdown list, select the job type you want to use for the job definition.

- Enable submission from Enterprise Manager: Select this checkbox to allow the job definition to be submitted from Fusion Applications Control. When selecting this option, the Parameters tab is removed for the job definition. Any parameters for the job definition will need to be defined within EM, not in the 'create job definition' flow. [Within EM? Does this mean at run time? Or should this note go in the developer's guide?]

Additional properties may appear, depending on the job type selected.

6. (Optional). Configure parameters, application defined properties, system preferences, and access control. For more information, see Section 6.11.1.2.1, Section 6.11.1.2.2, Section 6.11.1.2.3, and Section 6.11.1.2.4.

7. Click Save and Close.

This section contains the following topics:

- Section 6.11.1.2.1, "Configuring Parameters for a Job Definition"

- Section 6.11.1.2.2, "Configuring Application Defined Properties for a Job Definition"

- Section 6.11.1.2.3, "Registering Sources for Lists of Values"

- Section 6.11.1.2.4, "Searching for List of Value Sources"

6.11.1.2.1 Configuring Parameters for a Job Definition

A parameter enables passing data of type string, Boolean, number, or date time to the job request. Parameters can be passed using several display controls, such as a text box, date-time editor, choice list, or list of values.

To configure parameters for a job definition:

1. In the job definition creation user interface, click the Parameters tab.

2. Select Actions and then select New or click the New icon.
The Create Parameter dialog box appears.

3. In the Create Parameter dialog box, enter the following information:

- Prompt: Enter the text to be shown at the prompt that appears during runtime.

- Data Type: From the dropdown list, select a data type for the parameter: String Numeric, DateTime, Number, or Boolean. This is required.

- Field Type: Select Editable or Read Only.

- Value: Enter a value for the parameter. This field appears for String type parameters. This is required.

- Default Value: Enter a default value for the parameter.

- Tooltip Text: Enter documentation for the parameter.

- Required: Select this checkbox if the parameter must be entered.

- Do Not Display: Select this checkbox if you want to hide the parameter in the user interface.

- Display Control: From the dropdown list, select the control you want to appear in the user interface. Display control options include Text Box, Choicelist, List of Values (with search), Date Picker.

4. After you select a data type, you must configure its display.

- Boolean: From the Default Value dropdown list, select true or false.

- DateTime: Select Date Only or Date and Time.
From the Date Format dropdown list, select the format in which to display the date.

From the Default Value dropdown list, select any of the following values: Today, Tomorrow, A week from now, or Specific date.

If you select Specific date, use the date editor to select a date. This is required.

- Numeric: From the Number Format dropdown list, select the format in which to display the number.
For the Data Alignment option, select Left or Right. This configures the alignment of the number value in the job request submission UI.

In the Default Value field, enter a default value for the number.

- String: From the Display Widget dropdown list, select Text Box, Choicelist, or List of Values (with search). This is required.
Text Box: When selecting this value from the Display Widget dropdown list, enter the default text in the Default Value field.

Choicelist/List of Values (with search): From the List of Values Source dropdown list, select the source for the list of values. For the List of Values (with search), enter a default value in the field provided. In the Display Attributes list, select the attributes you want to appear. For information about searching for and registering a list of values, see Section 6.11.1.2.3 and Section 6.11.1.2.4.

5. Click Save and Close or Save and Create Another.

6.11.1.2.2 Configuring Application Defined Properties for a Job Definition

If your job definition requires additional properties to be filled in by users at runtime, you can add these properties in the Application Defined Properties tab of the job definition creation user interface.

To configure application defined properties for a job definition:

1. In the job definition creation user interface, click the Application Defined Properties tab.

2. Select Actions and then select New, or click the New icon.
The Create Application Defined Property dialog box appears.

3. In the Create Application Defined Property dialog box, enter the following information:

- Name: Enter a name for the property.

- Data Type: From the dropdown list, select a data type for the property. Data types include Boolean, Date, Number, and String.

- Default Value: Enter a default value for the property.

- Read Only: Select Read Only if you want the property to be shown only, not edited.

For more information about defining application defined properties, see Section 6.11.1.2.1.

4. Click Save and Close.

6.11.1.2.3 Registering Sources for Lists of Values

If you define a user property or parameter that uses a list of values, you must first register the source for the list of values.

To register a source for a list of values:

1. In the job definition creation user interface, click the Manage List of Value Sources tab.

2. Select Actions and then select New, or click the New icon.
The Create List of Value Source dialog box appears.

3. In the Create List of Value Source dialog box, enter the following information:

- Application Name: From the dropdown list, select the name of the application for the list of value. This is required.

- List of Values Source Definition Name: Enter the name of the source definition file for the list of values. This is required.

- User List of Values Source Name: Enter the name of the source for the list of values to be shown to users. This is required.

- Description: Enter a description for the list of values.

4. Click Save and Close.

6.11.1.2.4 Searching for List of Value Sources

When defining a user property or parameter using a list of values, you must register a source for the list of values. The Search field enables searching for a source for a list of values. You can also save the search for future use.

For information about registering a source for a list of values, see Section 6.11.1.2.3.

To search for list of value sources:

1. In the job definition creation user interface, click the Manage List of Value Sources tab.

2. In the Search field, select any of the following:

- Match: Select the All or Any option to search for any or all of the criteria.

- Application Name: From the dropdown list, select the name of the application you want to search. Then, select an operator such as Greater than or equal to.

- User List of Values Source Name: Enter text for the user list of values source name. Then, select an operator such as Contains.

3. (Optional). You can add additional fields to search by. Click Add Fields and select any of the following fields to search by:

- Application ID

- Created by

- Creation Date

- Data Source ID

- Description

- Last Update Date

- Last Update Login

- Last Updated By

- List of Values Source Definition Name

- Object Version Number

- Product Short Name

- User List of Values Source Name

4. Click Search to run the search, or Save to reserve the search for future use.

6.11.1.2.5 Defining Parameters with Dependent Lists of Values in Oracle Fusion Functional Setup Manager

In some cases, it is necessary to capture dependencies between interdependent parameter lists of values in the Oracle Enterprise Scheduler job definition. For example, suppose the job definition has three parameters, namely Country, State and City. In this job definition, the value of the Country parameter determines the values available in the State parameter, which in turn determines the values available in the City parameter. In this sense, the job parameters are dependent upon each other.

To define job parameters with dependent lists of values, you must do the following:

1. Create a list of values view object with a data source and view criteria.

2. Define bind parameters for the view criteria and expose them.

3. Map the bind variable to the relevant job parameter value.

In the previous example, the City and State parameters defined in a job use the CityLovVO data source to display a list of cities in the UI. The CityLovVO data source includes a view criterion called filterByState with a bind variable called state_code. The bind variable state_code can be mapped to the value of the State parameter value such that the list of cities shown in the UI is restricted by the state selected before invoking the City list of values.

To define parameters with dependent lists of values:

1. Create a job definition with parameters and a list of values view object with data source and bind variables. Be sure to mark as optional all the bind variables used for the dependent list of values view objects. For more information, see Section 6.11.1.2, Section 6.11.1.2.1, and Section 6.11.1.2.3.

2. From the Administration menu in the global area of Oracle Fusion Applications, choose the Setup and Maintenance work area and click the All Tasks tab. Search for all tasks.

3. From the list of tasks that is displayed, select the relevant UI application you will use to host the job definitions and parameter view objects. This Oracle Fusion application is the portlet producer application for the job.
Click the Go to Task button.

The Manage Job Definitions tab is displayed.

4. From the Manage Job Definitions tab, select the job definition you want to edit and click the Edit button.

5. In the Edit Job Definition tab, click the Parameters tab and select the parameter you created that is associated with a list of values.

6. Click the Manage Dependencies button to the right-hand side of the Delete button.
The Manage List of Values Dependencies dialog is displayed, as shown in Figure 6-4.

Figure 6-4 The Manage List of Values Dependencies Dialog

7. Bind the selected criteria to the relevant job parameters you defined earlier.

1. From the Available View Criteria list, select the view criteria you want to use and use the buttons to shuttle them to the Selected View Criteria list.

2. In the Bind Variables area, for each criteria name, from the Mapped Parameter drop-down list, select the job definition parameter to which you want to map the criteria name.

3. Click OK.

6.11.1.3 Duplicating Job Definitions with their Parameters

You can duplicate existing job definitions, including parameters, using Oracle Fusion Functional Setup Manager. The parameters used in the duplicated job definition can be defined as lists of values. The UI creates two view definitions in MDS, one for the job definition and another for mapping parameters (this includes references to a list of values view object for each parameter). The Oracle Enterprise Scheduler job submission UI reads these view definitions from MDS to create the corresponding job with parameters at runtime.

After you have created a new job definition by duplicating an existing one, you can still take the following actions in the new job definition:

- Add a new parameter.

- Delete or modify the existing parameters.

- View the list of values source attached to a parameter, and change it if necessary.

- Add a list of values source to an existing parameter or change it.

- Attach multiple return values from a list of values defined for a parameter.

Note:

It is necessary to define a list of values data source in the system first, so as to use it in the parameters view object. When duplicating a job definition, there is no guarantee that those data sources have already been created in the system. If it is found that a list of values data source has not been defined, the relevant list of values data source is created programmatically.

Note the following about duplicated job definitions:

- The attribute validations present on the attributes in the parameters view object are not copied over.

- If the list of values view object is a data secured polymorphic view object, then the view criteria defined in them cannot be read.

- The mapping of derived attributes from an expression may not be represented correctly.

- The job creation UI enables adding multiple return values from a list of values view object. To do so, the read-only record matching the list attribute should be the bottom most in the UI table as displayed in Figure 6-5. Otherwise, there may be a mismatch in the derived attributes. All derived attributes should be marked hidden. In Figure 6-5, Attribute5 should be a hidden attribute in the UI.

Figure 6-5 Managing Multiple Return Values

To duplicate an existing job definition:

1. From the Administration menu in the global area of Oracle Fusion Applications, choose the Setup and Maintenance work area and click the All Tasks tab. Search for all tasks.

2. From the list of tasks that is displayed, select the relevant UI application you will use to host the job definitions and parameter view objects. This Oracle Fusion application is the portlet producer application for the job.
Click the Go to Task button.

The Manage Job Definitions tab is displayed.

3. From the Manage Job Definitions tab, select the job definition you want to duplicate and click the Duplicate button.

6.11.2 Managing Job Sets

The Job Sets page in Fusion Applications Control enables you to view, create, edit, delete, and search for job sets.

A job set is a collection of job requests that can be grouped together to run as a unit. A job set can be nested, such that it may contain a collection of job requests or one or more child job sets. Each job request or job set included within a job set is called a job set step.

Figure 6-6 shows the Results table in the Job Sets page. The Results table displays job sets and their attributes, including name, package, execution mode, and description.

Figure 6-6 The Job Sets Page and Results Table

This section contains the following topics:

- Section 6.11.2.1, "Viewing Job Sets"

- Section 6.11.2.2, "Creating or Editing Job Sets"

- Section 6.11.2.3, "Deleting Job Sets"

6.11.2.1 Viewing Job Sets

You can view the job sets created for an application.

To display job sets:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Job Metadata and then select Job Sets.
The Job Sets page appears.

3. From the Applications dropdown list, select the name of the application whose job sets you want to view.

4. Enter the name and package name of the job set you want to find, and click Go.
The job sets for that application appear in a table below the application dropdown list.

Column Name

Description

Name

This column displays the name of the job set.

Display Name

This column displays a short descriptive title for the job set.

Package

This column displays the name of the Java package associated with the job set.

Execution Mode

This column displays the execution mode of the job set, Serial or Parallel.

Description

This column displays a description of the job set.

5. To view the details of a specific job set, click the name of the relevant job set.

6.11.2.2 Creating or Editing Job Sets

A job set is defined as either a serial or a parallel job set. At runtime, Oracle Enterprise Scheduler runs parallel job set steps simultaneously, in parallel. When a serial job set runs, Oracle Enterprise Scheduler runs the steps one after another in a specific sequence. Using a serial job set Oracle Enterprise Scheduler supports conditional branching between steps based on the execution status of a previous step.

For each step in a job set, you can configure an action to be taken upon completion of the step, depending on the state of the step. You can also configure parameters and system properties for the job set, such as elevating access privileges to complete a particular job request or specifying the number of times a job can be retried in the event of a failure.

To create or edit a job set:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Job Metadata and then select Job Sets.
The Job Sets page appears.

3. Click Create to define a new job set, or click Edit to modify an existing job set.

4. In the Job Set field, enter the name of the job set in the field provided. You can add a description in the Description field, and the name of the relevant job set Java package in the Package field.

5. In the Job Set Steps field, select Serial or Parallel to create a serial or parallel job set.

6. Add steps as required by clicking the Add icon. Define each step.

1. In the Step tab, in the Step ID field, enter a meaningful ID for the step.
In the Job field, enter search text and click the browsing button. In the window that appears, select the job definition that you want to use for this step.

2. In the Effective Application region, select Insert into main diagram or Add to list of available steps. If you choose to add the step to the list of available steps, use the dropdown lists that appear to define an action for the possible job outcomes, namely On Success, On Error, and On Warning.

3. In the Application Defined Properties tab, click the Add icon to define any required properties and enter their initial values in the field provided. For more information about defining application defined properties, see Section 6.11.1.2.1.

4. In the System Properties tab, click the Add icon to define any system parameters required for the step.
From the Name dropdown list, select the system property you want to specify. Possible system properties are shown in Table 6-3.

In the Initial Value field, enter the value you want to assign to the system property.

Table 6-3 System Properties

System Property Name

Description

SYS_allowMultPending

This property specifies whether multiple pending requests for the same job definition are allowed. This property has no meaning for a job set step. True or false.

SYS_application

This property specifies the logical name of the Scheduling Services folder application used for request processing. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_bizErrorExitCode

This property specifies the process exit code for a process job request that denotes an execution business error. If this property is not specified, the system treats a process exit code of 4 as an execution business error.

This property is optional for a process job type. It is not used for other job types.

SYS_className

This property specifies the Java executable file for a Java job request. This is the name of a Java class that implements the oracle.as.scheduler.Executable interface. This property is required for a Java job type. It is not used for other job types.

SYS_cmdLine

This property specifies the command line used to invoke an external program for a process job request.

This property is required for a Process job type. It is not used for other job types.

SYS_effectiveApplication

This property specifies the logical name of the Scheduling Services folder application that will be the effective application used to process the request. A job definition, job type, or a job set step can be associated with a different application by defining the EFFECTIVE_APPLICATION system property. This property can only be specified through metadata and cannot be specified as a submission parameter.

SYS_environmentVariables

This property specifies the environment variables to be set for the spawned process of a process job request.The property value must be a comma-separated list of name value pairs (name=value) representing the environment variables to be set.

This property is optional for a Process job type. It is not used for other job types.

SYS_executePast

This property specifies whether instances of a repeating request with an execution time in the past is generated. Instances are never generated before the requested start time nor after the requested end time. To cause past instances to be generated, you must set this property to TRUE and specify the requested start time as the initial time from which instances is generated. Note that a null requested start time defaults to the current time.

Valid values for this property are:

- TRUE: All instances specified by a schedule are generated regardless of the time of generation.

- FALSE: Instances with a scheduled execution time in the past (that is, before the time of generation) will not be generated.

Default: If this property is not specified, the system default is TRUE.

SYS_extensionListener

This property is for internal use only.

SYS_external_id

This property specifies an identifier for an external portion of an asynchronous Java job. For example, an asynchronous Java job usually invokes a remote process and then returns control to Oracle Enterprise Scheduler. This property can be used to identify the remote process. This property is set by the job implementation of asynchronous Java jobs when the identifier is known. It is never set by Oracle Enterprise Scheduler.

SYS_groupName

This property specifies the name of the Oracle Enterprise Scheduler isolation group to which this request is bound. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_inputList

This property specifies input to a job request. The input to a serial job set is forwarded as input to the first step only. The input to a parallel job set is forwarded as input to all the parallel steps.

Oracle Enterprise Scheduler imposes no format on the value of this property.

SYS_inputWorkDirectory

This property specifies the working directory used during job request processing for input files. Oracle Enterprise Scheduler sets the value of this property during job request processing.

SYS_listener

This property specifies the event listener class associated with the request. This is the name of a Java class that implements the oracle.as.scheduler.EventListener interface.

SYS_locale

This property specifies a language code to apply to the job.

SYS_logWorkDirectory

This property specifies the logging working directory.

SYS_outputList

This property specifies output from a request.

The output of a serial job set is the OUTPUT_LIST of the last step. The output of a parallel job set is the concatenation of the OUTPUT_LIST of all the steps, in no order, with oracle.as.scheduler.SystemProperty.OUTPUT_LIST_DELIMITER as a separator.

SYS_outputWorkDirectory

This property specifies the working directory used during job request processing for output files. Oracle Enterprise Scheduler sets the value of this property during job request processing.

SYS_postProcess

This property specifies the postprocess callout handler class. This is the name of a Java class that implements the oracle.as.scheduler.PostProcessHandler interface.

SYS_preProcess

This property specifies the preprocess callout handler class. This is the name of a Java class that implements the oracle.as.scheduler.PreProcessHandler interface.

SYS_priority

This property specifies the request processing priority. The priority interval is [0...9] with 0 as the lowest priority and 9 as the highest.

Default: If this property is not specified, the system default value used is 4.

SYS_procedureName

This property specifies the name of the PL/SQL stored procedure to be called for a SQL job request. The stored procedure is specified using the schema.name format.

The property is required for a SQL job type. It is not used for other job types.

SYS_product

This property specifies the product within the application that submitted the request.

SYS_redirectedOutputFile

This property specifies the file where standard output and error streams are redirected for a Process job request. This represents the full path of the log file where the standard output and error streams are redirected for the spawned process when the request is executed.

This property is optional for Process job types. It is not used for other job types.

SYS_reprocessDelay

This property specifies the callout handler processing delay time. This represents the time, in minutes, to delay request processing when a delay is requested by a callback handler.

Default: If this property is not specified, the system default used is 5. Integer type.

SYS_request_timeout

This property enables the job request to time out.

SYS_requestCategory

This property specifies an application-specific label for a request. The label, defined by an application or system administrator, enables administrators to group job requests according to their own specific needs.

SYS_requestedProcessor

This property specifies the request processor node on which the request is processed. This enables processor affinity to be specified for a job request. If this property is not specified, the request can run on any available request processor node. In general, this property should not be specified.

If this property is specified for a request, the request processor's work assignments oracle.as.scheduler.WorkAssignment (specialization) must allow the execution of such requests; otherwise the request will never be executed. If the specified node is not running, the request will remain in READY state and will not be executed until the node is restarted.

SYS_requestExpiration

This property specifies the expiration time for a request. This represents the time, in minutes, that a request will expire after its scheduled execution time. A expiration value of zero (0) means that the request never expires. If this property is not specified, the system default value used is 0.

Request expiration only applies to requests that are waiting to run. If a request waits longer than the specified expiration period, it does not run. After a request starts running, the request expiration no longer applies.

SYS_retries

This property specifies the retry limit for a failed request. If request execution fails, the request will be retried up to the number of times specified by this property until the request succeeds. If the retry limit is zero (0), a failed request will not be retried.

If this property is not specified, the system default used is 0.

SYS_runasApplicationID

This property enables elevating access privileges for completing a scheduled job.

Typically, a request runs as the submitting user. However, if this property is set in the metadata of the job associated with the request, then the request executes under the user identified by this property. This property can only be specified through metadata, and cannot be specified as a submission parameter.

SYS_selectState

This property specifies whether the result state of a job set step affects the eventual state of its parent job set. For the state of a job set step to be considered when determining the state of the job set, the SELECT_STATE must be set to true. If SELECT_STATE is not specified on a job set step, the state of the step will be included in the determination of the state of the job set. The data type is Boolean.

SYS_sqlJobClass

This property specifies an Oracle Enterprise Scheduler job class to be assigned to the Oracle Enterprise Scheduler job used to execute a SQL job request. This property need not be specified unless the job used for a job request is associated with a particular Oracle Database resource consumer group or has affinity to a database service.

If this property is not specified, a default Oracle Enterprise Scheduler job class is used for the job that executes the SQL request. That job class is associated with the default resource consumer group. It belongs to the default service, such that it has no service affinity and, in an Oracle RAC environment, any one of the database instances within the cluster might run the job. No additional privileges or grants are required for an Oracle Enterprise Scheduler SQL job request to use that default job class.

This property is optional for a SQL job type. It is not used for other job types.

SYS_submittingApplication

This property specifies the logical name of the Scheduling Services folder application for the submitted (absolute parent) request. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_substitutionHandlers

This property has been deprecated.

SYS_successExitCode

This property specifies the process exit code for a process job request that denotes an execution success. If this property is not specified, the system treats a process exit code of 0 as execution success.

This property is optional for a process job type. It is not used for other job types.

SYS_userFileDir

This property specifies a base directory in the file system where files, such as input and output files, may be stored for use by the request executable file.

Oracle Enterprise Scheduler supports a configuration parameter that specifies a file directory where requests can store files. At request submission, a USER_FILE_DIR property is automatically added for the request if the configuration parameter is currently set and USER_FILE_DIR property was not specified for the request. If the property is added, it will be initialized to the value of the configuration parameter. The property will not be added if the configuration parameter is not set at the time of the request submission.

SYS_userName

This property specifies the name of the user used to execute the request. Typically, this is the submitting user, unless the RUNAS_APPLICATIONID property was set in the job metadata. This property is automatically set by Oracle Enterprise Scheduler during the request submission.

SYS_warningExitCode

This property specifies the process exit code for a process job request that denotes an execution warning. If this property is not specified, the system treats a process exit code of 3 as an execution warning.

This property is optional for a Process job type. It is not used for other job types.

SYS_workDirectoryRoot

This property specifies the working directory for the spawned process of a Process job request.

This property is optional for a Process job type. It is not used for other job types.

5. If you configured the step as a serial step, it appears in the job set flow diagram. Configure the action to be taken upon reaching the error and warning states, respectively. From the dropdown list for the error and warning icons, select Stop or the name of the job definition to run upon reaching an error or warning state.

7. Continue to define steps as required for the job set.

8. Define application defined properties and system properties as required towards the bottom of the job set window.

Note:

These properties apply to the job set as a whole, as opposed to the properties configured earlier on the page that apply to specific steps in the job set.

9. Configure access control for the job set.

1. In the Access Control section of the Create Job Set page, click the Add icon to add access control to the job set.
The Add Access Control dialog box appears.

2. From the Role dropdown list, select the name of the role you want to apply to the job set. The role defines the users with sufficient permissions to access the job set.

3. Select the actions you want to allow role members to take: Read, Execute, Update, and Delete.

10. Click OK to save the job set.

6.11.2.3 Deleting Job Sets

You can delete a job set.

To delete a job set:

1. Search for the relevant job set, as described in Section 6.11.2.1.

2. In the Results table, select the job set you want to delete, and click the Delete icon.

6.11.3 Managing Incompatibilities

An Oracle Enterprise Scheduler incompatibility specifies which job definitions are incompatible with other job definitions. At runtime, when job definitions are specified in an incompatibility, any job requests associated with the job definitions that are incompatible cannot run simultaneously.

An incompatibility defines either a global incompatibility or a domain-specific, property-based incompatibility.

This section contains the following topics:

- Section 6.11.3.1, "Viewing Incompatibilities"

- Section 6.11.3.2, "Creating or Editing an Incompatibility"

- Section 6.11.3.3, "Deleting an Incompatibility"

6.11.3.1 Viewing Incompatibilities

The Incompatibilities page displays information about incompatibilities including name, the Java package associated with an incompatibility and a description of the incompatibility.

To view job incompatibilities:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Job Metadata and then select Incompatibilities.
The Incompatibilities page appears.

3. From the Applications dropdown list, select the name of the application whose incompatibilities you want to view.

4. Enter the name and package name of the incompatibilities you want to find, and click Go.
The incompatibilities for that application appear in a table below the application dropdown list.

Column Name

Description

Name

This column displays the name of the incompatibility.

Package

This column displays the name of the Java package associated with the incompatibility.

Incompatibility Type

This column displays the type of incompatibility, global or domain specific.

Description

This column displays a description of the incompatibility.

5. To view the details of a specific incompatibility, click the name of the relevant incompatibility.

6.11.3.2 Creating or Editing an Incompatibility

An incompatibility consists of two or more job definitions configured as incompatible, and the resource over which they need to be incompatible. A resource is not specified for a global incompatibility. This resource is represented by the property name that forms the incompatibility. The property name might be different across job definitions. For example, if two job definitions, JobA and JobB, are made incompatible, then the property identified for incompatibility might have different names in JobA and JobB.

- Domain-specific: Two or more job definitions are marked as incompatible within the scope of a resource, where the resource is identified by a system property name or a user-defined parameter name. An incompatibility specifies two or more incompatible entities where each entity consists of a job definition, or a job set definition and a property name that represents the resource over which the entities are incompatible. Each entity can use the same property name or a different property name. A property-based incompatibility is used when the incompatible entities are incompatible over a property. For property-based incompatibility, a job definition or a job set and a property name must be specified for each entity. Oracle Enterprise Scheduler ensures that requests for the incompatible jobs or job sets, with a property that has the same property value, do not run at the same time.

- Global: Two or more job definitions cannot run together at one time. A global incompatibility is used when the incompatible entities are not to be run at the same time regardless of any property. For global incompatibility, only the job definition or job set is specified for each entity. Oracle Enterprise Scheduler ensures that requests for the incompatible jobs or job sets do not run at the same time.

Defining an incompatibility involves the following:

- Package and scope: Select a relevant Java package to use for the incompatibility and set the scope for the incompatibility (global or domain specific).

- Jobs: Select the jobs that are incompatible.

- Parameters and properties: Define parameters and properties as required.

- Access control: Define access control as required.

To create or edit an incompatibility:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Job Metadata and then select Incompatibilities.
The Incompatibilities page appears.

3. Click Create to define a new incompatibility, or Edit to modify an existing incompatibility.
The Create Incompatibilities page appears.

4. Enter the following information:

- Name: Enter a name for the incompatibility.

- Package: Enter the name of the relevant incompatibility Java package.

- Description: (Optional). Add descriptive text for the incompatibility.

- Type: Configure the scope of the incompatibility by selecting Global or Domain.

5. In the Entities field, click the Add icon to add jobs to the incompatibility.
The Add Entity dialog box appears.

6. Select one or more jobs and click OK.

7. Define parameters and system properties, as required, toward the bottom of the incompatibility window. For more information about defining parameters and system properties, see Section 6.11.2.2.

8. Configure access control for the incompatibility, as described in Step 9 of Section 6.11.2.2.

9. Click OK to save the incompatibility.

6.11.3.3 Deleting an Incompatibility

Deleting an incompatibility results in the incompatible job requests or job sets becoming compatible again.

To delete an incompatibility:

1. Search for the relevant incompatibility, as described in Section 6.11.3.1.

2. In the Results table, select the incompatibility you want to delete, and click the Delete icon.

6.12 Managing Work Assignments and Workshifts

Work allocation is the process of defining constraints on where and when jobs run and the amount of resources that can be used to process the jobs. This process includes creating a work assignment, and binding the work assignment to a request processor.

A work assignment consists of a specialization rule and one or more workshifts. The specialization rule defines restrictions on which jobs can be processed. A workshift defines the temporal windows when the jobs can be processed and what resources can be used during those periods. The resources defined in a workshift include threads, which are a local resource of the request processor, and asynchronous workers, a global resource. The number of asynchronous workers can be specified to balance the use of a shared global resource, such as database jobs.

Binding associates a work assignment with a request processor on a server, determining where the jobs can run. An exclusive binding mode is supported to not only determine when the jobs can run but to prevent them from running anywhere else.

By default, no work assignments are bound. When there is no bound or active work assignment, a virtual default work assignment will be started to process all jobs using all available resources.

For more information about managing work assignments, workshifts, and schedules, see the section "Managing Work Assignments and Workshifts" in the chapter "Introduction to Managing the Work of Oracle Enterprise Scheduler Jobs" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

6.13 Managing Oracle ADF Connections

The ADF Connections Configuration page enables you to create connections to services such as ADF Business Components services, Oracle Business Activity Monitoring, Oracle Enterprise Scheduler, URLs, and web services.

Figure 6-7 shows the ADF Connections Configuration page.

Figure 6-7 The ADF Connections Configuration Page

Use the ADF Connections Configuration page to configure the following properties for Oracle Enterprise Scheduler:

- Request Files Store (RequestFileDirectory): From the dropdown list, select File System or Content Repository to store job request logs to the file system or a repository. This property is used for job requests submitted by Oracle ADF applications.

Note:

Ensure that the requestFileDirectory property is not configured to any location under the directory /tmp when running on a Linux server. When restarting the computer, the operating system may delete files from the /tmp directory, thus losing any related Oracle Enterprise Scheduler information stored there.

- Request Files Location: Configure this property to indicate the path of the folder to which job request logs are to be written. This property appears only when selecting File System from the Request Files Store dropdown list.

- UMS Server URL (NotificationServiceURL): Configure this property when using the notification service with Oracle Enterprise Scheduler. Set the URL of this property to that of the UMS Server NotificationServiceURL.

- SAML Token Policy (SAMLTokenPolicyURI): Set this property to the URI of the SAML policy used to secure job requests submitted by Oracle ADF applications.

- Client Callback Policy (EssCallbackClientSecurityPolicyURI): Configure this property to enable the security policy used in the WS-Security headers for web service invocations from Oracle Enterprise Scheduler for web service callbacks.

You can manage ADF connections in Fusion Applications Control only.

To create or edit an ADF connection:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Configuration and then select ADF Connections.
The ADF Connections Configuration page appears.

3. In the Create Connection field, click the Connection Type dropdown list and select the type of connection you want to create.

4. In the Connection Name field, enter a name for the connection.

5. Click Create Connection to add the connection.
The new connection appears under the relevant connection category.

6. To configure the connection, scroll down to the relevant connection category and select the new connection. Click Edit.
The connection window appears.

7. Configure the connection accordingly. For more information about the attributes you can configure for each type of connection, see the online help by clicking the help icon on the ADF Connections Configuration page.

8. Click Apply to activate the connection.

6.14 Managing Application Properties

The Managing Application Properties page enables you to define Oracle Enterprise Scheduler or application properties for a deployed application.

Figure 6-8 shows the Applications Properties page.

Figure 6-8 The Application Properties Page

To create or edit an application property:

1. From the navigation pane, expand Scheduling Services and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Configuration and then select Application Properties.
The Application Properties page appears.

3. From the Application dropdown list, select the name of the application for which you want to configure a property.

4. In the Configuration Properties region, click Add to create a new property.
The Add Property window appears.

5. In the Add Property window, configure the following.

- Type: From the dropdown list, select ESS or APP.

- Name: When configuring an application property, enter a name for the property in the field provided. When configuring an Oracle Enterprise Scheduler property, select a property from the dropdown list. Properties include PerlCommand and EssCallbackClientSecurityPolicyURI (for more information about this property, see Section 6.13).

- Value: Enter a value for the property.

Click OK to save the property.

6. Click Apply to activate the application property.

6.15 Managing Application and Role Policies

Oracle Enterprise Scheduler application and role policies are the same as other application and role policies. For more information about managing application and role policies, see Chapter 5.

6.16 Managing Oracle Enterprise Scheduler Web Services

Oracle Enterprise Scheduler web services are the same as other Oracle Fusion application web services. For information about managing the web services related to Oracle Fusion Applications, see the "Understanding Oracle WSM Policy Framework" chapter in the Oracle Fusion Middleware Security and Administrator's Guide for Web Services.

6.17 Managing Logging for Oracle Enterprise Scheduler

You can search for and view log data for individual job requests, and set log levels for Oracle Enterprise Scheduler. You can also save job request logs to a file, and trace job requests for additional troubleshooting information.

For more information about logging, see Chapter 13 and the section "Managing Logging for Oracle Enterprise Scheduling Service" in the chapter "Monitoring Oracle Enterprise Scheduler" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler. For more information about managing log files and diagnostic data, see the chapter "Managing Log Files and Diagnostic Data" in the Oracle Fusion Middleware Administrator's Guide.

This section contains the following topics:

- Section 6.17.1, "Finding Log Information for a Job Request"

- Section 6.17.2, "Setting Oracle Enterprise Scheduler Log Levels"

- Section 6.17.3, "Saving Job Request Logs"

Note:

The Oracle WebLogic Server logger (logging.xml) only shows logs written by Oracle Enterprise Scheduler jobs running in Oracle WebLogic Server. After Oracle Enterprise Scheduler transfers control of running PL/SQL and C jobs to the PL/SQL or C processes, respectively, PL/SQL and C job logging data is not written to the Oracle Enterprise Scheduler logs as they run in separate processes.

6.17.1 Finding Log Information for a Job Request

Job request logs can often be written to different files. You can find log data regarding a job request using its Execution Context Identifier (ECID), a unique identifier that enables finding log data for the job request.

For more information about finding the ECID for a job request, see the "Correlating Log Messages Across Log Files and Components" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

6.17.2 Setting Oracle Enterprise Scheduler Log Levels

It is possible to configure Oracle Enterprise Scheduler server logging for an Oracle WebLogic Server by modifying the logging.xml file of that Oracle WebLogic Server. By default, there is no explicit logger entry for Oracle Enterprise Scheduler. Oracle Enterprise Scheduler inherits the logging level and log handlers configured for the parent logger, typically the oracle logger or the root logger.

By default, the log messages for the Oracle Enterprise Scheduler logger can be found in the Oracle WebLogic Server diagnostic log file for that Oracle WebLogic Server. The logging.xml file is located under DOMAIN_HOME/config/fmwconfig/servers/WebLogic_Server_Name, where DOMAIN_HOME is the domain home directory for the Oracle WebLogic Server domain and WebLogic_Server_Name is the name of the Oracle WebLogic Server that uses the logging.xml file.

Table 6-4 shows the Oracle Enterprise Scheduler logger names, log levels, and a description for each level.

Table 6-4 Loggers and Log Levels for Oracle Enterprise Scheduler

Logger Name

Log Level

Description

oracle.as.ess

SEVERE

Problems encountered by Oracle Enterprise Scheduler runtime in the context of request processing that result in the request errors. Errors include exceptions thrown by the job code, unchecked exceptions when running the job code, and exceptions when running Oracle Enterprise Scheduler code.

Problems encountered by Oracle Enterprise Scheduler runtime outside the context of request processing, such as dispatching, system event handling, and so on.

oracle.as.ess

WARNING

Less severe problems encountered by Oracle Enterprise Scheduler runtime during or outside of request processing, which might not cause requests to enter on error state.

oracle.as.ess

INFO

Messages for request state transitions.

Messages related to work assignment activities.

Messages about batch deletion failures.

Messages about the starting and stopping of the Oracle Enterprise Scheduler resource adapter.

oracle.as.ess

CONFIG

Application endpoint activation and deactivation for Oracle Enterprise Scheduler resource adapter.

oracle.apps.fnd.applcp.srs

WARNING

Any problems that occur during UI rendering to submission.

oracle.apps.fnd.applcp.srs

INFO

Messages related to job fetch and submission API calls.

oracle.apps.fnd.applcp.srs

FINEST

Details tracing messages for the scheduled job request submission UI.

oracle.apps.fnd.applcp.monitor

WARNING

Any problems that occur during UI rendering to operations in the UI.

oracle.apps.fnd.applcp.monitor

INFO

Messages related to job request fetch and various API calls.

oracle.apps.fnd.applcp.monitor

FINEST

Details tracing messages for the job request monitoring UI.

oracle.apps.fnd.applcp

SEVERE

Records any errors that occurred when creating a session for Oracle Fusion Middleware Extensions for Applications, or when creating a file during preprocessing and postprocessing.

oracle.apps.fnd.applcp

WARNING

Records messages related to terminating sessions and closing files during preprocessing and postprocessing

oracle.apps.fnd.applcp

FINE

Messages related to preprocessing and postprocessing execution activity.

Two main types of logging can be used:

- Application Logging: Oracle Enterprise Scheduler job implementation can call standard Oracle Fusion Applications logging code. For proper operation, the AFLOG_ENABLED property must be set to Y. For PL/SQL jobs, set AFLOG_PLSQL_FILENAME to Y. For C jobs, set AFLOG_FILENAME to Y. For more information about configuring log settings, see Section Section 13.4 and the "Viewing Special Log Output for Oracle Fusion Incentive Compensation" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide. For more information about setting the AFLOG_ENABLED property, see the section "Enabling JBO Logging in the Provisioned Environment" in the "Debugging Oracle ADF and Oracle SOA Suite" chapter in the Oracle Fusion Applications Developer's Guide.

- Request Logging: Oracle Enterprise Scheduler job implementation can write business-specific job request execution log information to the job request log file. This log file is specific to each request, and is automatically enabled by default. For more information about viewing the log file for a job request, see the section "Viewing Job Request Logs" in the chapter "Monitoring Oracle Enterprise Scheduler" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

For information about setting the log levels for Oracle WebLogic Server, see the section "Tracing Oracle Enterprise Scheduling Service Jobs" in the chapter "Monitoring Oracle Enterprise Scheduler" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler. For more information about Oracle Diagnostic Logging levels, see Section 13.4.3.

Set the log levels for the Oracle WebLogic Server running Oracle Enterprise Scheduler as described in the Oracle WebLogic Server documentation.

6.17.3 Saving Job Request Logs

By default, job request logs are written to the fnd_log API if Oracle Fusion Applications logging is set to FINER.

It is possible to save job request log data to the server log file. Job request logs are typically stored in Oracle WebCenter Content. However, when setting the log level to FINER, all job request logs are copied to the server log file.

To save job request logs to the server diagnostic file in Fusion Applications Control:

1. In Fusion Applications Control, in the navigation pane, select WebLogic Domain, and then select the domain and server names.

2. Click the WebLogic Server menu and select Logs, and then select Log Configuration.
The Log Configuration pane appears.

3. In the Log Configuration pane, click the Log Levels tab.

4. In the Search field, search for oracle.as.scheduler, and find the oracle.as.scheduler.security.internal.SecurityExecutorFactory logger.

5. Set the log level to FINER and click Apply.

6. Run a diagnostic test, as described in Chapter 13. The log messages are now saved to the <server>-diagnostic.log file.
The logs are saved to the server diagnostic file, <Oracle Enterprise Scheduler server name>-diagnostic.log.

6.18 Managing Alerts for Oracle Enterprise Scheduler in Cloud Control

Cloud Control enables you to configure, view, and manage alerts for Oracle Enterprise Scheduler entities including the scheduling service itself, work assignments, and job definitions. Alerts are based on performance metrics for Oracle Enterprise Scheduler. Each metric includes named objects with upper and lower thresholds that indicate warning or critical states for that particular metric. For example, you can configure an alert for all job requests that have entered a state of error, such that 10 errors constitute a warning state, and 20 errors are a critical state. After you configure alerts, you can view any existing alerts and any configuration changes made within a specified period.

Table 6-5 lists the alerts available for Oracle Enterprise Scheduler.

Table 6-5 Oracle Enterprise Scheduler Alerts

Alert

Scope

Collected Data

Alert Automatically Cleared?

Alert for job requests in the ready state and the average wait time for job requests in the ready state.

Work assignment

The number of job requests in the ready state and the average wait time of the ready job requests, by work assignment.

No. The alert is only cleared when the number of ready job requests is smaller than the threshold. The same is true for alerts pertaining to the average wait time of a ready job request.

Alert for job requests that are in an error state.

Work assignment

The number of job requests that are in an error state following the last collection.

Yes. The alert is automatically cleared if the change in value of the subsequent collection is below the threshold.

Alert for long running job requests.

Job definition

The longest running time of a job request listed by job definition. The data is queried for only those job definitions for which a threshold is specified.

No. The alert is only cleared when a job request runs for the job definition beyond the threshold value.

Alert for job requests that are in the ERROR_MANUAL_RECOVERY state.

Scheduling service

The number of job requests in the ERROR_MANUAL_RECOVERY state.

No. An administrator must recover the job request to clear the alert.

Alert for timed out job requests.

Scheduling service

The number of timed out job requests.

No. An administrator must cancel or recover the job request to clear the alert.

Alert for job requests that are in the ERROR state.

Scheduling service

The number of job requests that are in the ERROR state during the last hour.

Yes. The alert automatically clears if the change in value in the subsequent collection is below the threshold.

Alert for blocked job requests.

Scheduling service

The number of job requests in the BLOCKED state.

No. An administrator must cancel the job request, or the job request must be selected for processing to clear the alert.

This section contains the following topics:

- Section 6.18.1, "Configuring Metric Alerts for Oracle Enterprise Scheduler in Cloud Control"

- Section 6.18.2, "Viewing Alerts for Oracle Enterprise Scheduler in Cloud Control"

6.18.1 Configuring Metric Alerts for Oracle Enterprise Scheduler in Cloud Control

You can configure the thresholds for each object monitored by the metric. You can configure alert rules for a metric as follows:

- Select an object that the metric monitors, such as job requests in a state of error.

- Configure the values at which the object reaches warning and critical states, including an operator value such as greater than (>) or less than (<).

- Enter a corrective action to be taken when the alert criteria are fulfilled.

- Arrange the alert rules in the order you desire.

To configure metric alerts for Oracle Enterprise Scheduler in Cloud Control:

1. Navigate to the scheduling service.

1. From the Targets menu, select Fusion Applications.

2. In the table on the Fusion Applications page, click the relevant Oracle Fusion Applications instance with Oracle Enterprise Scheduler deployed.

3. In the Target Navigation pane, click the name of the domain where Oracle Enterprise Scheduler is deployed, and then click Scheduling Services.

2. Click the Oracle Enterprise Scheduler cluster or an individual Oracle Enterprise Scheduler server.

3. From the Targets menu, select Monitoring and then click Metric and Collection Settings.
A list of metrics appears.

4. Select the metric for which you want to configure alert thresholds and click the Edit icon. For example, you can configure the thresholds for the Average Wait Time for Requests in Ready State (in seconds) metric.
The Edit Advanced Settings page appears, including the Monitored Objects list.

5. In the Edit Advanced Settings page, click Add to add a row to the list of monitored objects.

6. Select the object you want to monitor.

1. In the Name field of the new row, click the Search button.
The Search and Select Objects window appears.

2. Search for the object you want to use and click Select.

7. In the spaces provided, enter the values to be used for the Critical and Warning thresholds.

8. Click Continue, then click OK to save your settings.

9. Configure any additional thresholds, as required.

For more information about configuring alerts, see the following topics in the Cloud Control online help:

- "Incident Rules—Common Tasks"

- "Incident Rules—Advanced Tasks"

6.18.2 Viewing Alerts for Oracle Enterprise Scheduler in Cloud Control

The Oracle Enterprise Scheduler Service home page displays a summary of alerts. You can navigate to the Incident Manager page to view additional information about incidents by clicking the number of incidents that appear in the Monitoring and Diagnostics area.

To view alerts for Oracle Enterprise Scheduler with Cloud Control:

1. Navigate to the scheduling service.

1. From the Targets menu, select Fusion Applications.

2. In the table on the Fusion Applications page, click the relevant Oracle Fusion Applications instance with Oracle Enterprise Scheduler deployed.

3. In the Target Navigation pane, click the name of the domain where Oracle Enterprise Scheduler is deployed, and then click Scheduling Services.

2. Click the Oracle Enterprise Scheduler cluster or an individual Oracle Enterprise Scheduler server.
The Scheduling Service summary page appears. The Monitoring and Diagnostics pane displays the following information.

- Incidents: The number of incidents that occurred in the scheduling service instance appears here. The number of incidents is determined by those incidents collected due to configuring job request alerts. For more information about configuring job request alerts, see Section 6.18.1. If the number of incidents is greater than zero, click the number for more information about the incidents that have occurred.

- Descendant Target Incidents: The number of incidents that occurred anywhere in the scheduling service cluster appears here. If the number of incidents is greater than zero, click the number for more information about the incidents that have occurred.

- Configuration Changes: The number of changes that were made to alert configurations appears here. Click the number of configuration changes to search for the changes made within a particular period. The default period is 7 days. For more information, see Section 6.5.

3. Click the number of incidents to display detailed information about the alerts in the Incident Manager pane.

The Incident Manager displays incidents in a table, with the following information listed for each incident: severity, summary, target, priority, status, last updated, owner, acknowledged, escalated, type, and category.

You can click an incident to display its details.

Related Links

The following documents provide additional information:

- For more information about using Incident Manager to view common tasks, see the topic "Incident Manager—Common Tasks" in the Cloud Control online help.

- For more information about using Incident Manager to view advanced tasks, see the topic "Incident Manager—Advanced Tasks" in the Cloud Control online help.

6.19 Managing Oracle Enterprise Scheduler Using Oracle WebLogic Scripting Tool Commands

You can manage Oracle Enterprise Scheduler applications, job requests, and parameters using customized Oracle WebLogic Scripting Tool commands.

For a list of commands, their syntax, and samples, see the chapter "Oracle Enterprise Scheduler Custom WLST Commands" in Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

7 Managing Report Delivery Servers

This chapter describes report delivery server administration in Oracle Fusion Applications.

This chapter contains the following topics:

- Section 7.1, "Introduction to Managing Report Delivery Servers"

- Section 7.2, "Navigating to the Oracle BI Publisher Administration Page"

- Section 7.3, "Configuring Report Delivery Servers"

- Section 7.4, "Understanding the Report and Delivery Processors"

- Section 7.5, "Managing Report Processing and Delivery Server Load"

- Section 7.6, "Scaling Out Report Processors"

- Section 7.7, "Diagnosing Report Processing Issues"

- Section 7.8, "Configuring System Properties for Reporting"

7.1 Introduction to Managing Report Delivery Servers

Oracle Business Intelligence Publisher is the report generation and delivery engine for Oracle Fusion Applications. Oracle BI Publisher receives report requests from Oracle Fusion Applications in the following ways:

- Through Oracle Enterprise Scheduler

- Through the Reports and Analytics pane

- From an application page

Requests submitted through Oracle Enterprise Scheduler are processed by the Oracle BI Publisher scheduler. Requests submitted through the Reports and Analytics pane can be either real-time online requests or scheduled requests. Requests submitted through an application may invoke Oracle Enterprise Scheduler or may return report request results directly back to the application page.

After installing Oracle Fusion Applications, Oracle BI Publisher is configured to accept requests from Oracle Fusion Applications. However, before you can deliver report documents to their destinations you must define the delivery servers in Oracle BI Publisher. Use the Oracle BI Publisher Administration page to define your delivery servers.

After setup, you can then further configure the number of report processor and delivery threads to best handle your processing and delivery requirements. In addition, you can configure report properties for the system or at the report level to tune performance of your reports. To diagnose report processing issues, BI Publisher provides a set of scheduler diagnostics.

7.2 Navigating to the Oracle BI Publisher Administration Page

Use the Oracle BI Publisher Administration page to:

- Configure delivery servers

- Manage report and delivery processors

- View scheduler diagnostics

- Set system properties and report runtime configuration properties

Note:

You must be assigned the BIAdministrator role to access the BI Publisher Administration page.

To navigate to the Oracle BI Publisher Administration page:

- From the Oracle Fusion Applications Navigator, under Tools, click Reports and Analytics. In the Reports and Analytics pane, click Catalog to display the Oracle Business Intelligence presentation catalog page. From here, click Administration and then click Manage BI Publisher.
Alternatively, log in to Oracle Business Intelligence directly (example: http://example.com:port/analytics). Click Administration and then click Manage BI Publisher.

Figure 7-1 shows the BI Publisher Administration page:

Figure 7-1 BI Publisher Administration Page

7.3 Configuring Report Delivery Servers

To configure delivery servers:

1. From the BI Publisher Administration page, click Delivery Configuration.

2. Enter values in the Delivery Configuration Options tab to set general properties for email deliveries and notifications. Figure 7-2 shows the Delivery Configuration Options tab:

Figure 7-2 Delivery Configuration Options Tab

- SSL Certificate File — If SSL is enabled for your installation, then you can leave this field empty if you want to use the default certificates built-in with BI Publisher. SSL works with the default certificate if the server uses the certificate signed by a trusted certificate authority such as Verisign. This field is mandatory only if the user uses the SSL with a self-signed certificate. The self-signed certificate means the certificate is signed by a non-trusted certificate authority (usually the user).

- E-mail From Address — Enter the From address to appear on e-mail report deliveries from the BI Publisher server. The default value is bipublisher-report@oracle.com.

- Delivery Notification E-mail From Address — Enter the From address to appear on notifications delivered from the BI Publisher server. The default value is bipublisher-notification@oracle.com.

- Success Notification Subject — Enter the subject line to display for e-mail notification recipients when the report status is Success.

- Warning Notification Subject — Enter the subject line to display for e-mail notification recipients when the report status is Warning.

- Failure Notification Subject — Enter the subject line to display for e-mail notification recipients when the report status is Failed.

- Skipped Notification Subject — Enter the subject line to display for e-mail notification recipients when the report status is Skipped.

3. To configure a delivery server, click the appropriate tab.

The following table lists the report delivery channels supported by Oracle BI Publisher. See the corresponding section in the "Setting Up Delivery Destinations" chapter in the Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Publisher for configuration information.

Delivery Type

Section

Printer and Fax

Adding a Printer or Fax Server

E-mail

Adding an E-mail Server

WebDAV

Adding a WebDAV Server

HTTP

Adding an HTTP Server

FTP

Adding an FTP Server

7.4 Understanding the Report and Delivery Processors

When Oracle Enterprise Scheduler initiates a job, it is picked up by the BI Publisher scheduler queue. The processors perform as follows:

- Job Processor - listens for requests from the scheduler queue. When the job information is received, the job processor executes the data model (and splits the data for bursting jobs), stores the data in the shared temporary folder, and sends the report metadata to the report queue.

- Report Processor - listens for requests from the report queue. When the report information is received, the report processor generates the report documents, stores it in the shared temporary folder and puts the delivery information in the delivery queue.

- Delivery processors - each delivery processor listens to the delivery queue and handles the delivery of reports for its channel. The delivery processors are:

- Email Processor

- File Processor

- FTP Processor

- Print Processor

- WebDAV Processor

- Fax Processor

You can configure the number of threads dedicated to each processor.

7.5 Managing Report Processing and Delivery Server Load

Manage the processors in the BI Publisher Scheduler Configuration page. By default, each processor is enabled and the thread count for each is set to five. For each Managed Server that is running in the BI cluster, a table for that instance's processors will display. Use the table to enable or disable processors for the instance and configure the thread counts.

To configure processor threads:

1. From the BI Publisher Administration page, click Scheduler Configuration.

2. On the Scheduler Configuration page scroll to the Cluster Instances region.
Figure 7-3 shows the Oracle BI Publisher Scheduler Configuration page, highlighting the JMS Configuration and Cluster Instances regions:

Figure 7-3 BI Publisher Scheduler Configuration Page

3. Enter the Number Threads value in the processor configuration table.
Note that all processors will automatically be set to use the number of threads defined in the Threads Per JMS Processor value of the JMS Configuration region of the page. Enter a value in the Number Threads column to change the value from this default.

7.6 Scaling Out Report Processors

To add Managed Servers to enable more report and delivery processors to handle your reporting throughput see the "Scaling Out the Oracle Business Intelligence Domain" chapter in the Oracle Fusion Applications Installation Guide.

After performing the scale-out procedure, follow the steps in Section 7.5 to configure the processor threads for each cluster instance.

7.7 Diagnosing Report Processing Issues

The following tools enable you to diagnose report processing and delivery issues:

- Scheduler Diagnostics page

- Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control)

7.7.1 Using the Scheduler Diagnostics Page

The Scheduler Diagnostics page provides the runtime status of the scheduler. It provides status of its JMS configuration, JMS queues, cluster instances, scheduler Database, and Oracle Enterprise Scheduler.

To access the Scheduler Diagnostics page:

1. Navigate to the Oracle Business Intelligence Publisher Administration page.

2. In the System Maintenance group, click Scheduler Diagnostics.
The Scheduler Diagnostics page is shown in Figure 7-4:

Figure 7-4 BI Publisher Scheduler Diagnostics Page

7.8 Configuring System Properties for Reporting

Use the Oracle BI Publisher Runtime Configuration page to set the system-level runtime properties for reports.

To access the Runtime Configuration page:

1. Navigate to the Oracle Business Intelligence Publisher Administration page (see Section 7.2, "Navigating to the Oracle BI Publisher Administration Page").

2. In the Runtime Configuration group, click Properties.
For more information about this page click the Help icon on the page for a complete description of each property.

8 Managing Search with Oracle Enterprise Crawl and Search Framework

This chapter describes how to manage search using Oracle Enterprise Crawl and Search Framework (ECSF).

This chapter includes the following topics:

- Section 8.1, "Introduction to Oracle Fusion Applications Search"

- Section 8.2, "Validating the Environment for ECSF"

- Section 8.3, "Getting Started with Managing ECSF with Fusion Applications Control"

- Section 8.4, "Administering Search"

- Section 8.5, "Performing Advanced Administration Tasks"

8.1 Introduction to Oracle Fusion Applications Search

Knowledge workers can spend up to 24% of their time looking for information. Good search tools help them find this information more quickly. Expectations about the ease of use of search tools are high because searches are so easy to perform on the Internet. Oracle Fusion Applications Search is designed to exceed user expectations.

Oracle Fusion Applications Search is embedded within Oracle Fusion Applications. Any application that connects to multiple data sources or manages a significant amount of unstructured (non-database) information—or both—needs advanced search capabilities so that application users can easily locate and take action on data that is relevant to them. Powered by the Oracle Enterprise Crawl and Search Framework and Oracle Secure Enterprise Search, Oracle Fusion Applications Search not only provides a seamless search experience to the Oracle Fusion Applications end user for getting the right content at the right time, but also enhances the Oracle Fusion Applications developer's experience by providing a metadata-driven, declarative design time and runtime interface to manage enterprise search capabilities.

8.1.1 Oracle Fusion Applications Search Use Case Example

Simone Sterling is a new sales representative at Cobalt Inc. a computer hardware company. She is taking over for Jim Anderson, who just left the company. Simone needs to learn about Jim's interactions with his customers and about how to sell Cobalt's new line of energy-saving displays.

Simone starts by entering ”Jim Anderson” in the Oracle Fusion Applications Search box that is available at the top of every Oracle Fusion Applications page. Simone retrieves hundreds of documents pertaining to Jim Anderson and to people named ”Jim” or ”Anderson”. Simone is only interested in documents related to sales or customers, so she de-selects all the search categories except Sales and Customers and then re-runs her search.

Now that Simone is only looking at potentially relevant records, she decides to start exploring the results for specific customers. Simone expands the Customer Account node under the Customer node in the Available Filters tree to display a list of customer accounts. Simone can only view the search results for documents to which she has been granted access. Likewise, she can only view the search categories and filters to which she has access.

Simone clicks ”ABC Corporation” to display only the records that involve both Jim Anderson and ABC Corporation. Simone hovers her mouse pointer over result items for Customer Notes and Customer Interactions to see the first 244 characters of each document. She drills down to view details for a note about the new energy-saving displays.

Simone continues to explore her search results. She filters the results by selecting new customers from the Customer Accounts node, views result items in the Search Results window, then drills into Oracle Fusion Applications to view details for interesting items.

Simone finds a particularly useful set of results by searching for the new energy-saving displays, then filtering for recent customer interactions. She decides to save her search so she can monitor customer interactions around the energy-saving displays, so she clicks the Save… button and names her search ”Energy Saver Interactions”. This enables her to re-run her search at any time from any page within Oracle Fusion Applications.

Thus, Simone reaps the benefits of the powerful Oracle Fusion Applications Search feature that helps her tailor the search results to meet her specific business needs. She can also save the searches that she wants to reuse often.

8.1.2 Oracle Fusion Applications Search UI

The user interface for Oracle Fusion Applications Search, shown in Figure 8-1, offers a variety of useful features.

Figure 8-1 Oracle Fusion Applications Search UI

In the preceding figure, the following features are called out:

- The Search Categories dropdown list allows Oracle Fusion Applications users to scope their searches to one or more selected categories. Each search category corresponds to one Oracle Secure Enterprise Search (Oracle SES) data source group. Search categories (Oracle SES data source groups) are used for display purposes and for organizing searchable objects (Oracle SES data sources).

- The Keywords field allow users to enter terms or Oracle SES-supported operators for search.

- Tabbed Browsing organizes the search results for Oracle Fusion Applications and Oracle Business Intelligence (BI) Catalog into separate tabs. In Oracle Fusion Applications V1, Oracle Fusion Applications Search federates queries to the Oracle SES instance that searches the Oracle Business Intelligence (BI) Catalog. Search results from the Oracle Fusion Applications Oracle SES instance appear on the Oracle Fusion Applications tab. Search results from the Oracle Business Intelligence (BI) Catalog Oracle SES instance appear on the Business Intelligence tab.

- Faceted Browsing allows Oracle Fusion Applications users to filter their search results by selecting nodes in the Available Filters tree. Applied filters are shown in bold in the Available Filters tree and as tiles in the Selected Filters region. The numbers in parentheses next to the applied filters in the Available Filters tree represent the number of documents in the search result set that have that facet value.
Users can filter by category (Oracle SES data source group), subcategory (searchable object /Oracle SES data source), and values of one or more facets defined for a given subcategory. Filtering on a facet value automatically filters on its parent subcategory and category.

Filters can be removed via the delete icons in the Available Filters tree and the Selected Filters region. Removing a parent filter also removes all its children.

- Saved Searches allows Oracle Fusion Applications users to save the searches they create. Saved searches comprise all characters in the Keywords field and all the filters the user applies. Selecting a saved search runs the query and display all filters in the Available Filters tree and the Selected Filters region.

- The Main Link identifies the object or page to which a search result item links. It is the primary link and search result item title, as defined in the Default Action Title by the Oracle Fusion Applications developer.

- The Title provides key information about each search result item in addition to the main link. The title is part of the search result item's fixed content that appears regardless of where the user's keywords match the searchable document.

- The Body of each search result item includes a context snippet that comprises one or more instances of the keywords and the surrounding text extracted from the body of the searchable document.

- The Actionable Results are the list of the action links that appear below the body of each search result item. The action links allow Oracle Fusion Applications users to navigate directly to the pages for the objects represented by the search result items so that they can take specific actions on those objects. Action links can also take the user to third party web sites or any page accessed by a fully qualified URL.

8.1.3 Oracle Enterprise Crawl and Search Framework

Oracle Fusion Applications Search functionality is fundamentally made possible by the integration of three systems, each playing a role in forming the complete search platform:

- Search engine, as provided by Oracle Secure Enterprise Search (Oracle SES), which provides the fundamental search capability that includes indexing, querying, as well as some value added functionalities such as security.

- Source system, such as a relational database, where the searchable information resides

- Search development framework, such as Oracle Enterprise Crawl and Search Framework (ECSF), that supports the integration of applications with search engines

ECSF is an Oracle Fusion Middleware search framework that enables the exposure of application context information on various business objects to enable full-text transactional search. Benefits of ECSF include:

- Transparent integration of applications with search engines, which minimizes development time and maximizes the user experience with search

- Code reuse, through use of a well designed set of abstract classes, to reduce long design cycles

- Basic platform for developing search, which helps new developers to grasp the conceptual flow of work easily

- Centralized process and control mechanism, which enhances search functionality

- Wide range of optimizations that offer better control to leverage search results

8.1.3.1 ECSF Management Features

ECSF management features include:

- Runtime server, a metadata-driven runtime engine that serves as an integration framework between enterprise data sources and Oracle SES. It enables crawling, indexing, and the security service. It also serves as the semantic engine that provides ”smart” search features, such as faceted navigation, actionable results, and related search.

- Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control), an administration user interface for configuring and administering the ECSF runtime server, managing the searchable object lifecycle, and synchronizing with Oracle SES. Support for a command line administration option is also provided. For more information, see the ”ECSF Command Line Administration Utility” appendix in the Oracle Fusion Applications Developer's Guide.

8.1.3.2 Key ECSF Features

Key ECSF features that are built on top of Oracle SES and enhance the Oracle Fusion Applications user experience with search include:

- Basic search, which allows query based on keyword and search category.

- Advanced search, which allows query based on keyword, search category, and up to 100 attribute filters.

- Faceted navigation, which allows the filtering of search results based on attributes of the business objects. Users can navigate a search result set based on a set of predefined facets, or dimensions. This feature returns a list of facets and their associated set of available values with the search result. Users can select a value for each facet, which is then submitted with the search query to narrow down the result set.

- Actionable results, which are search results with action links associated with the searchable objects. From the search results users can either go straight to the page displaying the record they selected, or they can invoke a specific task on a search result.

- Saved searches, which allows saved search criteria for later use. Users can create new saved search entries, edit and delete existing saved search entries, and retrieve user-specified or public saved search entries.

- File attachments, which allow the crawling of attachments that are associated with Oracle Fusion Applications transactional objects or records.

- Crawling Oracle WebCenter Portal tags, which supports crawling searchable objects that contain Oracle WebCenter Portal tags.

- Crawling tree structures, which supports search functionality on source systems containing data that is organized in a tree structure (for example, Oracle Business Intelligence (BI) Catalog).

- Search support for external data sources, which allows querying against search groups that contain external data sources, which are non-ECSF related data sources, such as wiki pages and blogs, that are directly crawled by Oracle SES.

8.1.3.3 ECSF Process Flow

The process flow for search using the ECSF architecture, illustrated in Figure 8-2, begins from the time the Oracle Fusion Applications developer makes a view object searchable to the time the Oracle Fusion Applications user receives the search results. The arrows indicate the direction of flow, and the numbered circles indicate the sequence of the steps, which correspond to the list immediately following the illustration.

Figure 8-2 ECSF Process Flow

The process flow includes the following steps:

1. The Oracle Fusion Applications developer creates a searchable object.

2. The Oracle Fusion Applications developer configures the security rules.

3. The Oracle Fusion Applications administrator deploys the searchable objects to the ECSF runtime environment by registering them in the Oracle Fusion Applications database.

4. The Oracle Fusion Applications administrator deploys the searchable objects to Oracle SES. The Oracle SES search engine crawls the searchable objects in the Oracle Fusion Applications and indexes them as documents.

5. The Oracle Fusion Applications administrator creates search categories containing the searchable objects and deploys them to Oracle SES. When the Oracle Fusion Applications user issues a search query, the Oracle Fusion Applications Search UI performs the query through the ECSF Query Service.

6. The Query Service applies the Oracle Fusion Applications-specific rules and sends the query to the Oracle SES search engine.

7. The Oracle SES search engine returns the result set to the Query Service.

8. The Query Service applies post query security rules and constructs the search hits, and the Oracle Fusion Applications Search UI renders the search results for the Oracle Fusion Applications user.

8.1.4 Item Business Object and Data Level Security

Oracle SES does not apply data level security to Item business objects to determine if the object can be viewed by the user. All qualified users will see a limited amount of information when the Item business object is enabled for search. The information displayed in the search results includes the item number and description. The Oracle Product Information Management application checks the data level security when the user elects to view item details through the links within the search results.

Review your internal security policies before enabling the Item business object for search to determine if item information should be viewed by the end users.

8.2 Validating the Environment for ECSF

Before you begin to manage search with ECSF, make sure that the environment is set up properly for using ECSF.

To validate the ECSF setup, follow the procedures in the following sections.

Task 1   Make Sure That Oracle Fusion Applications Includes Search Functionality

Oracle Fusion Applications Search should be embedded within Oracle Fusion Applications, but it must be enabled in the user interface by setting the profile option FUSION_APPS_SEARCH_ENABLED to Y. For more information, see Task 6, "Enable the Oracle Fusion Applications Search UI".

To make sure that Oracle Fusion Applications includes search functionality:

1. Log in to Oracle Fusion Applications. If you cannot log in to Oracle Fusion Applications, contact your installation team.

2. Verify that the Enterprise Search box is available at the top of every Oracle Fusion Applications page.

3. View the Search Categories dropdown list. There should be no search categories listed.

4. Log out.

Task 2   Make Sure That Oracle SES Is Installed and Configured Properly

Oracle SES provides the fundamental search capability that includes crawling, indexing, and querying.

To make sure that Oracle SES is installed and configured properly:

1. Check the administration endpoint by logging in to the Oracle SES Administration GUI with the administration username and password at the following URL.

http: host_name:7777/search/admin/index.jsp

The default port number is 7777. Make sure that you use the correct port number for your installation. If you cannot access the Oracle SES search engine, contact your installation team.

2. Make sure that the Oracle SES identity plug-in has been registered.

3. Make sure that the federated trusted entities are created. Depending on what product families are installed, you should see one to three proxy users listed. The valid values are:

- FUSION_APPS_CRM_ECSF_SEARCH_APPID

- FUSION_APPS_FSCM_ECSF_SEARCH_APPID

- FUSION_APPS_HCM_ECSF_SEARCH_APPID

Task 3   Make Sure That Fusion Applications Control Is Available

Fusion Applications Control must be available for configuring and administering the ECSF runtime server, managing the searchable object lifecycle, and synchronizing with Oracle SES.

To make sure that Fusion Applications Control is available:

1. Log in to Oracle Enterprise Manager.

2. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

3. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page, shown in Figure 8-3.
The search engine types (Oracle SES) should be listed.

4. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, and validate the Oracle SES search engine instance parameters.

5. From the table of search engine instances, select a search engine instance record, and then select the Searchable Objects tab to view the table of searchable objects, and validate the list of searchable objects for the application. For a list of seeded searchable objects, see Appendix C.

6. Select the Search Categories tab to view the table of search categories, and validate the list of search categories and objects associated with the search categories for the application. For a list of seeded search categories, see Appendix C.

7. From the navigation pane, re-select the application to open the Enterprise Crawl and Search Framework Configuration Settings page, then click the Search Application Service Component link to open the Search Application Service Component administration page, and validate that the search applications for the product families are installed.

Task 4   Provide Access to ECSF Pages in Fusion Applications Control

To access the ECSF pages in Fusion Applications Control, users must have Operator privileges in Oracle WebLogic Server. You must add the users to the Operator group and above on Oracle WebLogic Server.

Task 5   Validate the Application Identities

Oracle Fusion Applications include seven search-related application identities that are seeded and are stored in the identity store:

- FUSION_APPS_CRM_SES_CRAWL_APPID

- FUSION_APPS_CRM_ECSF_SEARCH_APPID

- FUSION_APPS_FSCM_SES_CRAWL_APPID

- FUSION_APPS_FSCM_ECSF_SEARCH_APPID

- FUSION_APPS_HCM_SES_CRAWL_APPID

- FUSION_APPS_HCM_ECSF_SEARCH_APPID

- FUSION_APPS_ECSF_SES_ADMIN_APPID

ECSF is powered by Oracle SES. To integrate with Oracle SES, several integration identities known as application identities are used. For each Oracle Fusion Applications application, there are a pair of application identities, for example, FUSION_APPS_HCM_SES_CRAWL_APPID and FUSION_APPS_HCM_ECSF_SEARCH_APPID. The CRAWL application identities are used by Oracle SES to interact with ECSF for crawling and security requests, while the SEARCH application identities are used by Oracle SES to query Oracle SES as proxy users.

FUSION_APPS_ECSF_SES_ADMIN_APPID is the application identity used by ECSF to integrate with Oracle SES for administration tasks, such as deployment, scheduling, and so on.

Application identities are provisioned as users in the Oracle Fusion Applications identity store. They often have high level privileges, and their credentials are generated and stored in the credential store. These users are used mainly for machine to machine (application to application) integration.

The Lightweight Directory Access Protocol (LDAP) credential store stores the passwords for the identities that Oracle Fusion Applications and ECSF uses to retrieve passwords for Oracle SES integration.

View the LDAP credential store to make sure the application identities exist.

Related Links

The following document provides additional information about the topics discussed in this section:

- For more information about adding users to the Operator group, see Oracle Fusion Middleware Securing Oracle WebLogic Server.

8.3 Getting Started with Managing ECSF with Fusion Applications Control

Fusion Applications Control is an administration user interface that can be used for configuring and administering the ECSF runtime server, managing the searchable object lifecycle, and synchronizing with Oracle SES.

ECSF also provides support for a command line administration option. The ECSF Command Line Administration Utility offers a command line interface, and has no external dependencies on Oracle Enterprise Manager. The utility is available in the ECSF Library (ecsf.jar) and can be started as a Java program. For more information, see the ”ECSF Command Line Administration Utility” appendix in the Oracle Fusion Applications Developer's Guide.

Both Fusion Applications Control and the ECSF Command Line Administration Utility require connection to the Oracle Fusion Applications database.

Note:

While both Fusion Applications Control and the ECSF Command Line Administration Utility can be used concurrently, it is recommended that ECSF be administered using one or the other to facilitate data control.

Key points of administration include:

- ECSF Configuration: ECSF currently supports only the Oracle SES search engine and its different versions. The Oracle SES search engine with its versions are stored in the ECSF_SEARCH_ENGINE_TYPE table, which resides in the FUSION schema, and is rendered in Fusion Applications Control. Every Oracle SES search engine instance must be configured using a set of Oracle SES parameters. Every instance created for search must also be configured using a set of ECSF parameters. Both sets of parameters and their values are stored in the ECSF_PARAMETER table and are rendered in Fusion Applications Control. Parameter names are read-only, while parameter values can be updated.

- ECSF Administration

- Search engine instances and parameters: ECSF supports more than one search engine instance of a given search engine type (currently only Oracle SES). It supports the declarative distribution of index over several search engine instances. Each search engine instance belongs to exactly one version of the Oracle SES search engine type. All the supported search engines instances are stored in the ECSF_ENGINE_INSTANCE table and managed using Fusion Applications Control.

- Searchable objects: Searchable object definitions are configured at design time, and the information is stored in metadata XML files. This information is imported into the Oracle Fusion Applications database and rendered in Fusion Applications Control in the form of searchable objects.

- Search categories: The metadata for search categories, also called search groups (for Oracle SES), is collected and rendered in Fusion Applications Control.

- External search categories: Fusion Applications Control enables you to import external search categories (registered Oracle SES data source groups that are crawled and created directly using Oracle SES Administration UI) to be used directly for querying.

- Index schedule: The index schedule is created in Fusion Applications Control. A corresponding Oracle SES index schedule is then created.

Security administration for ECSF is handled outside the framework and Fusion Applications Control.

For general information about Fusion Applications Control, see Chapter 2.

8.3.1 Navigating to the ECSF Administration Pages

To navigate to the ECSF administration pages in Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder, and select the application engine instance that contains the searchable objects you want to manage.

The Enterprise Crawl and Search Framework Configuration Settings page displays. For more information about the Configuration Settings page, see Section 8.3.2.

2. Expand the Enterprise Crawl and Search Framework target menu.

The menu displays the options described in Table 8-1.

Table 8-1 Enterprise Crawl and Search Framework Target Menu Options

Menu Option

Description

Home

Displays the Enterprise Crawl and Search Framework Configuration Settings page. For more information about this page, see Section 8.3.2.

Logs

Displays the options to either view log messages or access the Log Configuration page to configure basic and advanced log configuration settings.

The log files are stored in the following directory:

DOMAIN_HOME/sysman/log/emoms.log

Register Searchable Object

Displays the Register Searchable Object page. For more information about the Register Searchable Object task, see Task 2, "Register the Searchable Objects".

Unregister Searchable Object

Displays the Unregister Searchable Object page. For more information about the Unregister Searchable Object task, see Task 4, "Unregister the Searchable Objects".

System MBean Browser

Displays the MBean browser that allows to you browse the MBeans for the selected application.

Performance Summary

Displays performance information for the selected component or application. For more information, see Section 11.4.1.

WebLogic Server Administration Console

Launches the Oracle WebLogic Server Administration Console in a separate browser window.

General Information

Displays general information about the application instance.

8.3.2 Understanding the Enterprise Crawl and Search Framework Configuration Settings Page

The Enterprise Crawl and Search Framework Configuration Settings page, shown in Figure 8-3, displays the search engine types and their corresponding search engine instance parameters. This page is your starting place for administering and managing search.

Figure 8-3 Enterprise Crawl and Search Framework Configuration Settings Page

From the Enterprise Crawl and Search Framework Configuration Settings page, you can navigate to the Search Application Service Component Administration page to create and configure Search Application Service Component instances.

You can also navigate to the Search Engine Instance Administration page (by selecting a search engine type) to define search engine instances, manage data sources and schedules, and extend search.

8.4 Administering Search

Administer search by managing data sources and schedules and modifying data sources.

Note:

Administration of searchable objects, search categories, and index schedules must be performed using Fusion Applications Control. You can use the Oracle SES Administration GUI for all other Oracle SES related administration tasks.

To access the ECSF pages in Fusion Applications Control, you must have Operator privileges in Oracle WebLogic Server. For more information, see Task 4, "Provide Access to ECSF Pages in Fusion Applications Control".

You can perform the following procedures to administer search using Fusion Applications Control:

- Section 8.4.1, "Making Seeded Searchable Objects Available for Search"

- Section 8.4.2, "Managing Index Schedules"

- Section 8.4.3, "Changing the Association of Searchable Objects with Search Categories"

- Section 8.4.4, "Renaming Search Categories"

- Section 8.4.5, "Deleting Search Categories"

- Section 8.4.6, "Making External Search Categories Available for Federated Search"

- Section 8.4.7, "Deleting External Search Categories"

- Section 8.4.8, "Modifying the Display Name of Deployed Searchable Objects"

- Section 8.4.9, "Undeploying Searchable Objects"

- Section 8.4.10, "Unregistering Searchable Objects from the Oracle Fusion Applications Database"

- Section 8.4.11, "Modifying Search Application Service Component Instance Parameters"

To avoid disrupting running schedules, it is highly recommended that you administer search when the index schedules are not running.

8.4.1 Making Seeded Searchable Objects Available for Search

The Oracle Fusion Customer Relationship Management, Oracle Fusion Human Capital Management, and Oracle Fusion Supply Chain Management product families each has its own set of seeded searchable objects that are packaged into its corresponding search application. For example, the seeded searchable objects for Oracle Fusion Customer Relationship Management are packaged in the Oracle Fusion Customer Relationship Management search application. For more information, see Appendix C.

Note:

While Oracle Fusion Financials searchable objects, search categories, and index schedules are seeded, they are not available for search. Do not use Oracle Fusion Financials searchable objects, search categories, and index schedules to enable search because they are not seeded.

To manage the searchable objects for a particular product family, you must select the search application corresponding to that product family.

To make seeded searchable objects available for search, follow the procedures in the following tasks:

- Task 1, "Deploy the Searchable Objects to the Oracle Secure Enterprise Search (Oracle SES) Instance"

- Task 2, "Activate the Searchable Objects"

- Task 3, "Deploy the Search Categories"

- Task 4, "Deploy the Index Schedules"

- Task 5, "Start the Index Schedules"

- Task 6, "Enable the Oracle Fusion Applications Search UI"

- Task 7, "Validate That Searchable Objects Are Available for Search"

Task 1   Deploy the Searchable Objects to the Oracle Secure Enterprise Search (Oracle SES) Instance

Deploying searchable objects to the Oracle Secure Enterprise Search (Oracle SES) instance makes the objects available for the search engine instance to crawl. The searchable objects deployed to Oracle SES must have a unique and fully qualified name, for example, oracle.apps.crm.Opportunity or oracle.apps.hcm.Opportunity.

To deploy searchable objects to the Oracle SES instance using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, shown in Figure 8-4.

Figure 8-4 Search Engine Instance Administration Page

4. From the table of search engine instances, select the record of the search engine instance that contains the searchable object you want to deploy, and then select the Searchable Objects tab, shown in Figure 8-5, to view the table of searchable objects for the selected search engine instance.

Figure 8-5 Searchable Objects Tab

5. Click the Deploy icon. Alternatively, select Deploy from the Actions menu or use the Ctrl+Shift+P keyboard shortcut.
A green check mark appears in the Deployed column of the selected searchable object to indicate that the source has been created in Oracle SES.

Note:

When a searchable object is registered to ECSF, by default it is inactive and not deployed. You can deploy the searchable object to the search engine instance regardless of whether the searchable object is active or inactive. When deployed successfully, the searchable object is flagged as deployed and inactive until you activate it. When a searchable object is deployed, the search engine instance can crawl the searchable object. However, a query of that object will return no results until the object is activated.

Task 2   Activate the Searchable Objects

A query of deployed and crawled searchable objects will return results only if the objects are activated.

To activate searchable objects using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance that contains the searchable object you want to activate, and then select the Searchable Objects tab, shown in to view the table of searchable objects for the selected search engine instance.

5. Select the desired searchable object from the table, and click the Activate icon. Alternatively, select Activate from the Actions menu or use the Ctrl+Shift+T keyboard shortcut.
A green check mark appears in the Active column of the selected searchable object to indicate that the searchable object is available for search.

Note:

A query of this object will return results only if the object has been deployed to a search engine instance and has been crawled.

Task 3   Deploy the Search Categories

Deploying search categories pushes them to the Oracle SES instance. Only search categories with associated searchable objects that are activated can be deployed. Only deployed search categories appear in the Search Categories dropdown list in the Oracle Fusion Applications Search UI.

To deploy search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance to which you want to deploy a search category, and then select the Search Categories tab to view the table of search categories for the selected search engine instance.

5. Select the record of the search category you want to deploy.

6. Set the scope of the search category to GLOBAL to display the search category on the Oracle Fusion Applications Search UI.

7. Click the Deploy icon. Alternatively, select Deploy from the Actions menu or use the Ctrl+Shift+P keyboard shortcut.
A green check mark appears in the Deployed column of the selected search category to indicate that the source group has been created in Oracle SES.

Note:

You cannot deploy a search category that contains a searchable object that is not activated. All searchable objects in the search category must be activated. For more information, see Task 2, "Activate the Searchable Objects".

The Oracle Fusion Applications Search UI reflects this change after the ECSF cache expires and the user logs out and logs back in. The default is 30 minutes after the change is added to the cache.

Task 4   Deploy the Index Schedules

Deploying index schedules pushes them to the Oracle SES instance. Only index schedules with associated searchable objects can be deployed.

Caution:

Deploying index schedules to Oracle SES automatically sets the value for recrawlPolicy to Process Documents That Have Changed in Oracle SES. Do not change the value of recrawlPolicy. ECSF supports only incremental crawling.

To deploy index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance for which you want to deploy an index schedule, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

Figure 8-6 Index Schedules Tab

5. Select the desired index schedule from the table, and click the Deploy Index Schedule icon. Alternatively, select Deploy from the Actions menu or use the Ctrl+Shift+P keyboard shortcut.
A green check mark appears in the Deployed column of the selected index schedule, and the Status column indicates Scheduled. This indicates that the schedule has been created in Oracle SES.

Task 5   Start the Index Schedules

Starting an index schedule initiates the crawling and indexing of data. You cannot start an index schedule that has not been deployed. You must first deploy the index schedule to add it to the search engine instance. For more information, see Task 4, "Deploy the Index Schedules".

To start index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance for which you want to start an index schedule, and then select the Index Schedules tab to view the table of index schedules for the selected search engine instance.

5. Select the desired index schedule from the table, and click the Start Index Schedule icon. Alternatively, select Start from the Actions menu or use the Ctrl+Shift+W keyboard shortcut.
The Status column of the selected index schedule indicates that the schedule is Launching. The date and time appear in the Start Time column when you start the index schedule.

You must manually refresh the page to view the status updates.

Task 6   Enable the Oracle Fusion Applications Search UI

After you have configured search and started the crawl, enable the Oracle Fusion Applications Search UI by setting the value of the FUSION_APPS_SEARCH_ENABLED profile option to Y. This setting makes the search controls visible in the user interface. The default value is N, which disables the search controls in the user interface.

To set the FUSION_APPS_SEARCH_ENABLED profile option to Y:

1. Sign in to Oracle Fusion Applications with a user account that is provisioned with the Manage All Application Profile Values role. Contact your security administrator for details.

2. From the Administration menu in the work area of Oracle Fusion Applications, choose Setup and Maintenance.

3. From the Setup and Maintenance Overview page, search for profile tasks.
The Manage Administrator Profile Values page displays.

4. Edit profile option values.

5. Query the profile option using the code FUSION_APPS_SEARCH_ENABLED.

6. Set the value to Yes at the site level. This profile option is defined at the site level only.

For more information about configuring profile options, see Section 13.4.5.

Task 7   Validate That Searchable Objects Are Available for Search

Make sure that you can see valid search results by running a query on a selected search category.

To validate that searchable objects are available for search using Fusion Applications Control:

1. Make sure that the index schedule you started has completed crawling and indexing the content for search, which is indicated by Scheduled in the Status column for the index schedule.

2. Log in to your application and expand the Categories field in the global area. You should see all the search categories you deployed.

3. Select one search category, enter * (wildcard) in the Search Term field, and click the Play button to initiate the search.
Search results should appear, confirming the readiness for search.

8.4.2 Managing Index Schedules

You can perform the following tasks to manage index schedules:

- Section 8.4.2.1, "Creating the Index Schedules"

- Section 8.4.2.2, "Associating the Searchable Objects with Index Schedules"

- Section 8.4.2.3, "Deploying the Index Schedules"

- Section 8.4.2.4, "Starting the Index Schedules"

- Section 8.4.2.5, "Stopping Index Schedules"

- Section 8.4.2.6, "Disassociating Searchable Objects from Index Schedules"

- Section 8.4.2.7, "Starting Full Indexing"

- Section 8.4.2.8, "Undeploying Index Schedules"

- Section 8.4.2.9, "Deleting Index Schedules"

Note:

Repetitive deployment of index schedules is not supported.

8.4.2.1 Creating the Index Schedules

You can either create new index schedules for the new searchable objects or add the new searchable objects to existing index schedules. Creating an index schedule adds a new record to the ECSF_INDEX_SCHEDULE table in the Oracle Fusion Applications database.

To create index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance for which you want to create an index schedule, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. Click the New Index Schedule icon. Alternatively, select New Record from the Actions menu or use the Ctrl+Shift+N keyboard shortcut.
A new record is added to the top of the table of index schedules.

6. Enter a value for the Name column.

7. From the Frequency Type dropdown list, select the desired value for how often you want the index schedule to run.

8. Complete the Time Between Launches, Schedule Launch Days, and Schedule Launch Time columns that become enabled based on your selection in the Frequency Type column. Table 8-2 lists the valid values for the required columns based on the frequency type.

Table 8-2 Index Schedule Frequency Values

Frequency Type

Time Between Launches

Schedule Launch Day

Schedule Launch Time

Manual

---

---

---

Hourly

1 to 23

---

---

Daily

1 to 99

---

1:00 AM to 12:00 AM

Weekly

1 to 12

Monday to Sunday

1:00 AM to 12:00 AM

Monthly

1 to 12

1 to 31

1:00 AM to 12:00 AM

9. Click the Save Index Schedule icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+Shift+S keyboard shortcut.

Caution:

A save will occur only for the selected record. You can only save one record at a time.

Note:

To proceed with other operations, you must first select any record. Creating or deleting ECSF objects removes the focus from the window.

8.4.2.2 Associating the Searchable Objects with Index Schedules

Associating searchable objects with an index schedule adds the objects to that index schedule. You can only associate each searchable object with one index schedule. Only a searchable object that is not already associated with an index schedule can be added to an index schedule. If the searchable object is already associated with an index schedule, you must disassociate it from that index schedule before you can associate it with another index schedule. For more information, see Section 8.4.2.6.

You can only associate searchable objects with index schedules that are not already deployed. If the index schedule has already been deployed, you must undeploy it before you can associate searchable objects with it. For more information, see Section 8.4.2.8.

To associate searchable objects with index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the desired search engine instance, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. Select the desired index schedule to which you want to add searchable objects, and click the Bind icon.
The Bind icon is disabled if the index schedule is deployed. You cannot associate or disassociate searchable objects if the index schedule is deployed.

6. In the Bound Searchable Objects to the Selected Index Schedule dialog, shown in Figure 8-7, select the checkboxes of the desired searchable objects from the Available Objects list, and click the Move icon to add them to the Selected Objects list.

Figure 8-7 Bound Searchable Objects to the Selected Index Schedule Dialog

7. Click OK.
The IS_ID column in the ECSF_SEARCH_INDEX_OBJECT table is populated with the Index Schedule ID.

Note:

A searchable object can be assigned to only one index schedule. If a searchable object has been assigned to an index schedule, it will not be listed in the table of available searchable objects.

8.4.2.3 Deploying the Index Schedules

Deploying index schedules pushes them to the Oracle SES instance. For more information, see Task 4, "Deploy the Index Schedules".

8.4.2.4 Starting the Index Schedules

Starting an index schedule initiates the crawling and indexing of data. For more information, see Task 5, "Start the Index Schedules".

8.4.2.5 Stopping Index Schedules

Stopping an index schedule that has been started aborts the index process.

To stop index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance for which you want to stop an index schedule, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. Select the desired index schedule from the table, and click the Stop Index Schedule icon. Alternatively, select Stop from the Actions menu or use the Ctrl+Shift+O keyboard shortcut.
The Status column of the selected index schedule indicates that the schedule has Failed, or that the index process was aborted. The date and time appear in the Stop Time column when you stop the index schedule.

8.4.2.6 Disassociating Searchable Objects from Index Schedules

Disassociating a searchable object from an index schedule removes it from that index schedule and makes it available to be added to another index schedule. You can only disassociate a searchable object from an index schedule with which it is associated. You can only disassociate a searchable object from an index schedule that is not deployed. If the index schedule has been deployed, you must undeploy it before you can disassociate a searchable object from it. For more information, see Section 8.4.2.8.

To disassociating searchable objects from index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the desired search engine instance, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. Select the desired index schedule from which you want to remove searchable objects, and click the Bind icon.
The Bind icon is disabled if the index schedule is deployed. You cannot associate or disassociate searchable objects if the index schedule is deployed.

6. In the Bound Searchable Objects to the Selected Index Schedule dialog, shown in Figure 8-7, select the checkboxes of the desired searchable objects from the Selected Objects list, and click the Remove icon to remove them from the Selected Objects list and make them available for adding to an index schedule.

7. Click OK.

8.4.2.7 Starting Full Indexing

Full indexing is the process by which the search engine creates indexes from all crawled and indexable documents for a particular data source. In contrast, incremental indexing builds indexes on top of existing indexes.

To start full indexing using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the desired search engine instance record, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. From the table of index schedules, select the desired schedule for which you want to build a full index.

6. Click the Start Full Indexing icon. Alternatively, select Full Index from the Actions menu or use the Ctrl+Shift+L keyboard shortcut.
A confirmation dialog appears. Click OK.

The Status column indicates that the full indexing is Launching. Indexing will occur only on the active and deployed searchable objects.

8.4.2.8 Undeploying Index Schedules

Undeploying an index schedule removes it from the Oracle SES instance. Only deployed index schedules can be undeployed.

To undeploy index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance for which you want to undeploy an index schedule, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. Select the desired index schedule from the table, and click the Undeploy Index Schedule icon. Alternatively, select Undeploy from the Actions menu or use the Ctrl+Shift+U keyboard shortcut.
The green check mark disappears from the Deployed column of the selected index schedule, and Scheduled disappears from the Status column. This indicates that the schedule has been deleted from Oracle SES.

8.4.2.9 Deleting Index Schedules

Deleting an index schedule disassociates it from the search engine instance and removes its corresponding record from the ECSF_INDEX_SCHEDULE table in the Oracle Fusion Applications database. Only undeployed index schedules can be deleted.

To delete index schedules using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance from which you want to delete an index schedule, and then select the Index Schedules tab, shown in Figure 8-6, to view the table of index schedules for the selected search engine instance.

5. Select the record of the index schedule you want to delete.

6. Click the Delete Index Schedule icon. Alternatively, select Delete Record from the Actions menu or use the Ctrl+Shift+D keyboard shortcut.
The selected record is removed from the table of index schedules.

Note:

To proceed with other operations, you must first select any record. Creating or deleting ECSF objects removes the focus from the window.

8.4.3 Changing the Association of Searchable Objects with Search Categories

Changing the association of searchable objects with a search category disassociates the searchable objects from the search category and or associates additional searchable objects with the search category.

To change the association of searchable objects with search categories, follow the procedures in the following tasks:

- Task 1, "Undeploy the Search Categories"

- Task 2, "Disassociate the Searchable Objects from Search Categories"

- Task 3, "Associate Searchable Objects with the Search Categories"

- Task 4, "Deploy the Search Categories"

Task 1   Undeploy the Search Categories

Undeploying a search category removes it from the Oracle SES instance. Only deployed search categories can be undeployed.

To undeploy search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance in which you want to undeploy a search category, and then select the Search Categories tab, shown in Figure 8-15, to view the table of search categories for the selected search engine instance.

5. Select the record of the search category you want to undeploy.

6. Click the Undeploy icon. Alternatively, select Undeploy from the Actions menu or use the Ctrl+Shift+U keyboard shortcut.
The green check mark disappears from the Deployed column of the selected search category to indicate that the source group has been removed from Oracle SES.

Note:

The Oracle Fusion Applications Search UI reflects this change after the ECSF cache expires and the user logs out and logs back in. The default is 30 minutes after the change is added to the cache.

Task 2   Disassociate the Searchable Objects from Search Categories

Disassociating a searchable object from a search category removes it from that search category. The searchable object is still available for association to other search categories.

To disassociate searchable objects from search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the desired search engine instance, and then select the Search Categories tab, shown in Figure 8-15, to view the table of search categories for the selected search engine instance.

5. Select the desired search category from which you want to remove searchable objects, and click the Bind icon.
The Bind icon is disabled if the search category is deployed. You cannot associate or disassociate searchable objects if the search category is deployed.

6. In the Bound Searchable Objects to the Selected Search Category dialog, shown in Figure 8-16, select the checkboxes of the desired searchable objects from the Selected Objects list, and click the Remove icon to remove them from the Selected Objects list.

7. Click OK.

Task 3   Associate Searchable Objects with the Search Categories

Associate searchable objects with a search category to add the objects to that search category. For more information, see Task 8, "Associate the Searchable Objects with Search Categories".

Task 4   Deploy the Search Categories

Deploy the search categories to push them to the Oracle SES instance. For more information, see Task 3, "Deploy the Search Categories".

8.4.4 Renaming Search Categories

Renaming a search category changes the name of the search category.

To change the name of a search category using Fusion Applications Control:

1. If the search category is deployed, you must undeploy it. For more information, see Task 1, "Undeploy the Search Categories".

2. In the Name column of the Search Categories tab, edit the value corresponding to to the record of the search category you want to modify.

3. Click the Save Search Category icon. Alternatively, select Save Record from the Actions menu or use the Ctrl+Shift+S keyboard shortcut.

4. If the search category was deployed before renaming it, redeploy it. For more information, see Task 4, "Deploy the Search Categories".

8.4.5 Deleting Search Categories

Deleting a search category disassociates it from the search engine instance and removes its corresponding record from the ECSF_SEARCH_INDEX_GROUP table in the Oracle Fusion Applications database.

To delete search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance from which you want to delete a search category, and then select the Search Categories tab, shown in Figure 8-15, to view the table of search categories for the selected search engine instance.

5. Select the record of the search category you want to delete.

6. Click the Delete Search Category icon. Alternatively, select Delete Record from the Actions menu or use the Ctrl+Shift+D keyboard shortcut.
The selected record is removed from the table of search categories.

Note:

To proceed with other operations, you must first select any record. Creating or deleting ECSF objects removes the focus from the window.

8.4.6 Making External Search Categories Available for Federated Search

External search categories are the registered Oracle SES data source groups that contain external data sources (that is, data sources created using Oracle SES administration). External data sources are not registered in the ECSF_SEARCH_INDEX_OBJECT table. They include data sources such as Intranet, mail, database, and federated data sources (that is, data sources from another search engine instance). Oracle SES data source groups can also contain federated ECSF data sources. For more information, see Section 8.5.4.

External search categories are directly used for querying. Executing the import operation pulls all the external search categories into the Oracle Fusion Applications database. All external search categories in the Oracle Fusion Applications database are available during ECSF query time through the ECSF query API.

Note:

Since external search categories are not managed by ECSF, you must use Oracle SES to modify the external search categories.

To make external search categories available for federated search, follow the procedures in the following tasks:

- Task 1, "Import the External Search Categories"

- Task 2, "Set the Application ID Value"

- Task 3, "Associate the Application ID with an Active Search Application"

Task 1   Import the External Search Categories

Importing external search categories adds new records to the ECSF_SEARCH_INDEX_GROUP table in the Oracle Fusion Applications database. The import also automatically sets the IS_EXTERNAL flag to TRUE to indicate that the search category is an external search category.

To import external search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance that points to an Oracle SES instance, and then select the External Search Categories tab, shown in Figure 8-8, to view the table of external search categories for the selected search engine instance.

Figure 8-8 External Search Categories Tab

5. Click the Import button.
The Import External Categories dialog, shown in Figure 8-9, appears.

Figure 8-9 Import External Categories Dialog

6. In the Available Categories column, select the checkbox of the external search categories you want to import and click the Move icon to shuttle your selection to the Selected Categories column.

7. Click OK to import the selected external search categories.

Note:

All existing external search categories in the Oracle Fusion Applications database are replaced by the latest import from Oracle SES.

Clicking OK without selecting any external search categories also deletes all the existing external search categories in the Oracle Fusion Applications.

The selected search categories from the selected Oracle SES instance display in the table of external search categories. Fusion Applications Control currently only displays the name of each external search category that is imported.

Clicking Cancel cancels the import operation, preserves any existing external search categories in the Oracle Fusion Applications database, and returns you to the External Search Categories page.

Task 2   Set the Application ID Value

Setting the Application ID value allows the external search categories to be queried using the GLOBAL scope, which is the default scope for Oracle Fusion Applications.

To set the Application ID value using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance that points to an Oracle SES instance, and then select the External Search Categories tab, shown in Figure 8-8, to view the table of external search categories for the selected search engine instance.

5. From the table of external search categories, select the record of the external search category that you want to modify.

6. In the Application ID column corresponding to the external search category you want to modify, enter an application ID (for example, CRM) based on the desired Service Component to which this category is to be assigned.

7. Click the Save External Search Category icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+Shift+S keyboard shortcut.

Task 3   Associate the Application ID with an Active Search Application

The application ID set for the external search category must be associated with an active search application in order for the external search category to be available for federated search.

To associate the application ID with an active search application, update the ECSF_QUERY_SERVICE_APP_IDS parameter value to include the application ID in the comma separated string. For more information, see Section 8.4.11.

8.4.7 Deleting External Search Categories

You can delete individual external categories after they are imported into the Oracle Fusion Applications database. Deleting an external search category removes its corresponding record from the ECSF_SEARCH_INDEX_GROUP table in the Oracle Fusion Applications database, and will make it unavailable for querying.

To delete external search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance from which you want to delete an external search category from the Oracle Fusion Applications database, and then select the External Search Categories tab, shown in Figure 8-8, to view the table of external search categories for the selected search engine instance.

5. Select the record of the external search category you want to delete.

6. Click the Delete Search Category icon. Alternatively, select Delete Record from the Actions menu or use the Ctrl+Shift+D keyboard shortcut.
The selected record is removed from the table of external search categories.

Note:

This deletion removes the external search category from the Oracle Fusion Applications database. It does not undeploy the search group from Oracle Secure Enterprise Search (Oracle SES).

8.4.8 Modifying the Display Name of Deployed Searchable Objects

You can change a deployed searchable object's display name and application ID without first having to deactivate and undeploy the searchable object.

Caution:

Do not modify the Oracle Fusion Applications Help searchable object named TopicSearchPVO.

To change the display name and application ID using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance that contains the searchable object you want to modify, and then select the Searchable Objects tab, shown in Figure 8-5, to view the table of searchable objects for the selected search engine instance.

5. In the Display Name column, edit the value corresponding to the searchable object you want to modify.

6. In the Application ID column, edit the value corresponding to the searchable object you want to modify.

7. Click the Save Searchable Object icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+Shift+S keyboard shortcut.

8.4.9 Undeploying Searchable Objects

Undeploying searchable objects from the Oracle SES instance makes the objects unavailable for the search engine instance to crawl. While undeployed, the searchable object is still associated with the search engine instance record and can be redeployed to the physical engine. When a searchable object is undeployed, any association to a search category or index schedule is removed.

To undeploy searchable objects from the Oracle SES instance, follow the procedures in the following tasks:

- Task 1, "Deactivate the Searchable Object"

- Task 2, "Undeploy the Searchable Object from the Oracle SES Instance"

Task 1   Deactivate the Searchable Object

Deactivated searchable objects are still available for the search engine instance to crawl, but a query of the deactivated searchable objects will return no results.

To deactivate searchable objects on search engine instances using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance that contains the searchable object you want to deactivate, and then select the Searchable Objects tab, shown in Figure 8-5, to view the table of searchable objects for the selected search engine instance.

5. Select the desired searchable object from the table, and click the Deactivate icon. Alternatively, select Deactivate from the Actions menu or use the Ctrl+Shift+I keyboard shortcut.
The green check mark disappears from the Active column of the selected searchable object to indicate that the searchable object is not available for search.

Note:

When the searchable object is inactive, a query of that object will return no results until the object is activated.

Task 2   Undeploy the Searchable Object from the Oracle SES Instance

Undeploy searchable objects from the Oracle SES instance to make the objects unavailable for the search engine instance to crawl. While undeployed, the searchable object is still associated with the search engine instance record and can be redeployed to the physical engine. You can undeploy only searchable objects that are inactive.

Note:

When a searchable object is undeployed, any association to a search category or index schedule is removed.

To undeploy searchable objects from the Oracle SES instance using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance that contains the searchable object you want to undeploy, and then select the Searchable Objects tab, shown in Figure 8-5, to view the table of searchable objects for the selected search engine instance.

5. Select the desired searchable object from the table, and click the Undeploy icon. Alternatively, select Undeploy from the Actions menu or use the Ctrl+Shift+U keyboard shortcut.
The green check mark disappears from the Deployed column of the selected searchable object to indicate that the source has been deleted from Oracle SES.

8.4.10 Unregistering Searchable Objects from the Oracle Fusion Applications Database

Unregistering searchable objects removes the searchable object records from the Oracle Fusion Applications database. Using Fusion Applications Control, you can remove records of searchable objects from the Oracle Fusion Applications database.

Only those searchable objects that are inactive, undeployed, and not associated with any engine instance can be unregistered.

To remove searchable object records from the Oracle Fusion Applications database, follow the procedures in the following tasks:

- Task 1, "Deactivate the Searchable Objects"

- Task 2, "Undeploy the Searchable Objects from the Oracle SES Instance"

- Task 3, "Disassociate the Searchable Objects from Search Engine Instances"

- Task 4, "Unregister the Searchable Objects"

Task 1   Deactivate the Searchable Objects

Deactivate the searchable object you want to remove from the Oracle Fusion Applications database. For more information, see Task 1, "Deactivate the Searchable Objects".

Task 2   Undeploy the Searchable Objects from the Oracle SES Instance

Undeploy the searchable object you want to remove from the Oracle Fusion Applications database. For more information, see Task 2, "Undeploy the Searchable Object from the Oracle SES Instance".

Task 3   Disassociate the Searchable Objects from Search Engine Instances

Disassociating a searchable object from the search engine instance removes that object from the specified instance and makes it available for association to another search engine instance.

To delete searchable objects from search engine instances using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance to which you want to add a searchable object, and then select the Searchable Objects tab, shown in Figure 8-5, to view the table of searchable objects for the selected search engine instance.

5. Select the desired searchable object from the table, and click the Delete Searchable Object icon. Alternatively, select Delete Record from the Actions menu or use the Ctrl+Shift+D keyboard shortcut.
The selected searchable object is removed from the table for the selected search engine instance, but it is not deleted from the Oracle Fusion Applications database. It can be assigned to another search engine instance. When assigned, you can deploy and activate the searchable object.

Note:

To proceed with other operations, you must first select any record. Creating or deleting ECSF objects removes the focus from the window.

Task 4   Unregister the Searchable Objects

Unregistering a searchable object removes its record from the Oracle Fusion Applications database.

To unregister the searchable object using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage containing searchable objects to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. From the Enterprise Crawl and Search Framework target menu, select Unregister Searchable Object.

4. On the Unregister Searchable Objects page, shown in Figure 8-10, select the searchable object you want to unregister.

Figure 8-10 Unregister Searchable Objects Page

5. Click the Unregister icon.
A dialog with a confirmation message appears.

8.4.11 Modifying Search Application Service Component Instance Parameters

You can modify the Search Application Service Component instance parameters to edit the query web service reference name and activate or deactivate the search application.

To modify Search Application Service Component instance parameters using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Search Application Service Component link.

4. On the Search Application Service Component administration page, shown in Figure 8-11, select the desired Search Application Service Component instance record.

Figure 8-11 Search Application Service Component Administration Page

5. On the Parameters tab, modify the value for the desired parameter of the Search Application Service Component instance.

6. Save.

8.5 Performing Advanced Administration Tasks

You can extend search by performing any of the following tasks:

- Section 8.5.1, "Modifying the Title, Body, Keyword, and Action Title of Searchable Objects"

- Section 8.5.2, "Making New Searchable Objects Available for Search"

- Section 8.5.3, "Defining Search Engine Instances"

- Section 8.5.4, "Enabling Search on External Data Sources"

- Section 8.5.5, "Adding Product Families for Federated Search"

Note:

Administration of searchable objects, search categories, and index schedules must be performed using Fusion Applications Control. You can use the Oracle SES Administration GUI for all other Oracle SES related administration tasks. Oracle Enterprise Crawl and Search Framework only exposes the Oracle SES functionality for deploying and undeploying index schedules.

To access the ECSF pages in Fusion Applications Control, you must have Operator privileges in Oracle WebLogic Server. For more information, see Task 4, "Provide Access to ECSF Pages in Fusion Applications Control".

8.5.1 Modifying the Title, Body, Keyword, and Action Title of Searchable Objects

You can customize searchable objects by changing the title, body, keywords, and search result action title using Fusion Applications Control.

Caution:

Do not modify the Oracle Fusion Applications Help searchable object named TopicSearchPVO.

To change the title, body, keywords, and action title of searchable objects, follow the procedures in the following tasks:

- Task 1, "Deactivate the Searchable Object"

- Task 2, "Undeploy the Searchable Object"

- Task 3, "Edit the Title, Body, Keywords, and Action Title"

- Task 4, "Enable the Customization"

- Task 5, "Deploy the Searchable Object"

- Task 6, "Activate the Searchable Object"

- Task 7, "Validate the Changes"

Task 1   Deactivate the Searchable Object

If the searchable object that you want to customize is active, deactivate it. For more information, see Task 1, "Deactivate the Searchable Object".

Task 2   Undeploy the Searchable Object

If the searchable object that you want to customize is deployed, undeploy it. For more information, see Task 2, "Undeploy the Searchable Object from the Oracle SES Instance".

Task 3   Edit the Title, Body, Keywords, and Action Title

Edit the title, body, keywords, and search result action title to customize the searchable objects.

To edit the title, body, keywords, and action title of a searchable object using Fusion Applications Control:

1. From the Actions menu on the Searchable Objects tab, select Modify. Alternatively, use the Ctrl+Shift+Z keyboard shortcut.

2. In the Customize Searchable Objects dialog, shown in Figure 8-12, edit the Groovy expression in the field for the property you want to modify.

Figure 8-12 Customize Searchable Objects Dialog

The Available Attributes table displays the attributes of the parent view object.

Note:

You can use only stored attributes (for example, SRNumber) in the default action title. Using unstored attributes in the default action title results in an error during validation.

3. Click the Validate button to validate the Groovy expression.

4. Click the Save button to save your input to the database.

Task 4   Enable the Customization

Enable the customization by selecting Enable Customization from the Actions menu, or using the Ctrl+Shift+O keyboard shortcut.

This validates all the modified expressions for title, body, keywords, and action title and sets the customization flag. A green check mark appears in the Customized column to indicate that the searchable object is customized.

You can remove the customization flag by selecting Disable Customization from the Actions menu, or using the Ctrl+Shift+Q keyboard shortcut.

Task 5   Deploy the Searchable Object

Deploy the searchable object to the Oracle SES instance to make it crawlable. For more information, see Task 1, "Deploy the Searchable Objects to the Oracle Secure Enterprise Search (Oracle SES) Instance".

Task 6   Activate the Searchable Object

Activate the searchable object so that a query of that object will return results. For more information, see Task 2, "Activate the Searchable Objects".

Task 7   Validate the Changes

Validate that the Oracle Fusion Applications Search UI reflects the changes you made.

To validate your changes to the searchable objects title, body, keywords, and action title:

1. Log in to the search application.

2. Select the single category that contains the object.

3. Perform a query using the * wild card.

4. Check the search results for your changes to the title, body, keywords, and action title.

8.5.2 Making New Searchable Objects Available for Search

New searchable objects are objects in addition to the set of transactional objects that are available out of the box.

To make new searchable objects available for search, follow the procedures in the following tasks:

- Task 1, "Obtain the Necessary Information"

- Task 2, "Register the Searchable Objects"

- Task 3, "Associate the Searchable Objects with Search Engine Instances"

- Task 4, "Deploy the Searchable Objects to the Oracle SES Instance"

- Task 5, "Activate the Searchable Objects"

- Task 6, "Create the Search Categories"

- Task 7, "Undeploy the Search Categories"

- Task 8, "Associate the Searchable Objects with Search Categories"

- Task 9, "Deploy the Search Categories"

- Task 10, "Create the Index Schedules"

- Task 11, "Undeploy the Index Schedules"

- Task 12, "Associate the Searchable Objects with Index Schedules"

- Task 13, "Deploy the Index Schedules"

- Task 14, "Start the Index Schedules"

Task 1   Obtain the Necessary Information

To more efficiently make new searchable objects available for search, you should collect information from the Oracle Fusion Applications developer who creates the searchable objects, as well as from the business unit to which the new objects belong.

Obtain the following information before you begin the process of making new searchable objects available for search:

- Fully qualified object name of the searchable object (for example, oracle.ecsf.demo.model.UX_CustomerVO)

- Display name of the searchable object (for example, Customer)

- Name of the search category (existing or new) to which the searchable object must be associated (for example, Customers)

- Name of the index schedule (existing or new) to which the searchable object must be associated (for example, CRM_Customers)

- Name of the search engine instance with which the searchable object must be associated (for example, CRMSES1)

- Name of the search engine type to which the search engine instance belongs (for example, SES11.2.1)

Task 2   Register the Searchable Objects

Registering searchable objects creates searchable object records in the Oracle Fusion Applications database.

To create searchable object records in the Oracle Fusion Applications database using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage containing searchable objects to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. From the Enterprise Crawl and Search Framework target menu, select Register Searchable Object.

4. On the Register Searchable Object page, shown in Figure 8-13, enter a display name for the searchable object in the Display Name field.

Figure 8-13 Register Searchable Object Page

5. In the Searchable Object Name field, enter the fully qualified searchable object name that is defined in your application.

6. Click the Register button.

Task 3   Associate the Searchable Objects with Search Engine Instances

Associating a searchable object with a search engine instance adds that object to the specified instance. Only an unassigned object, which is a searchable object that is not associated with a search engine instance, can be added to a search engine instance, so a searchable object can only be associated with one search engine instance at a time.

To associate searchable objects with search engine instances using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance to which you want to add a searchable object, and then select the Searchable Objects tab, shown in Figure 8-5, to view the table of searchable objects for the selected search engine instance.

5. Click the Add button to open the Add a Searchable Object to Selected Engine Instance dialog, shown in Figure 8-14.

Figure 8-14 Add a Searchable Object to Selected Engine Instance Dialog

6. Select the desired searchable object from the table, and click OK.
The searchable object you selected appears in the table of searchable objects on the Searchable Objects tab. The value in the Application ID column indicates the application with which the searchable object is associated.

Note:

A searchable object can be assigned to only one search engine instance. If a searchable object has been assigned to a search engine instance, it will not be listed in the table of available searchable objects.

To proceed with other operations, you must first select any record. Creating or deleting ECSF objects removes the focus from the window.

Task 4   Deploy the Searchable Objects to the Oracle SES Instance

Deploy the searchable objects to the Oracle SES instance to make the objects available for the search engine instance to crawl. For more information, see Task 1, "Deploy the Searchable Objects to the Oracle Secure Enterprise Search (Oracle SES) Instance".

Task 5   Activate the Searchable Objects

Activate the searchable objects so that a query of the deployed and crawled searchable objects will return results. For more information, see Task 2, "Activate the Searchable Objects".

Task 6   Create the Search Categories

You can either create new search categories for the new searchable objects or add the new searchable objects to existing search categories. Creating a search category adds a new record to the ECSF_SEARCH_INDEX_GROUP table in the Oracle Fusion Applications database.

To create search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the search engine instance for which you want to add a search category, and then select the Search Categories tab, shown in Figure 8-15, to view the table of search categories for the selected search engine instance.

5. Click the New Search Category icon. Alternatively, select New Record from the Actions menu or use the Ctrl+Shift+N keyboard shortcut.
A new record named CHANGE_ME is added to the table of search categories.

6. Enter a new value in the Name column.

7. Select a value (LOCAL or GLOBAL) from the Scope column dropdown list.

8. Click the Save Search Category icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+Shift+S keyboard shortcut.

Caution:

A save will occur only for the selected record. You can only save one record at a time.

Note:

To proceed with other operations, you must first select any record. Creating or deleting ECSF objects removes the focus from the window.

Task 7   Undeploy the Search Categories

To add the new searchable objects to existing search categories, you must first undeploy the search categories. For more information, see Task 1, "Undeploy the Search Categories".

Task 8   Associate the Searchable Objects with Search Categories

Associating searchable objects with a search category adds the objects to that search category. You can only associate deployed searchable objects with search categories. You can associate the same searchable object with multiple search categories. You cannot associate searchable objects with search categories that have been deployed. If the search category has been deployed, you must undeploy it before you can associate searchable objects with it. For more information, see Task 1, "Undeploy the Search Categories".

To associate searchable objects with search categories using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page.

4. From the table of search engine instances, select the record of the desired search engine instance, and then select the Search Categories tab, shown in Figure 8-15, to view the table of search categories for the selected search engine instance.

Figure 8-15 Search Categories Tab

5. Select the desired search category to which you want to add searchable objects, and click the Bind icon.
The Bind icon is disabled if the search category is deployed. You cannot associate or disassociate searchable objects if the search category is deployed.

6. In the Bound Searchable Objects to the Selected Search Category dialog, shown in Figure 8-16, select the checkboxes of the desired searchable objects from the Available Objects list, and click the Move icon to add them to the Selected Objects list. Only deployed searchable objects are listed as available objects.

Figure 8-16 Bound Searchable Objects to the Selected Search Category Dialog

7. Click OK.
A new record is created in the ECSF_SIO_SIG_INT intersection table.

Task 9   Deploy the Search Categories

Deploy the search category. For more information, see Task 4, "Deploy the Search Categories".

Task 10   Create the Index Schedules

You can either create new index schedules for the new searchable objects or add the new searchable objects to existing index schedules. For more information on how to create index schedules, see Section 8.4.2.1.

Task 11   Undeploy the Index Schedules

To add the new searchable objects to existing index schedules, you must first undeploy the index schedules. For more information, see Section 8.4.2.8.

Task 12   Associate the Searchable Objects with Index Schedules

Associate the new searchable object to either the newly created index schedule or an existing, undeployed index schedule. For more information, see Section 8.4.2.2.

Task 13   Deploy the Index Schedules

Deploy the index schedules. For more information, see Task 4, "Deploy the Index Schedules".

Task 14   Start the Index Schedules

Start the index schedules. For more information, see Task 5, "Start the Index Schedules".

8.5.3 Defining Search Engine Instances

ECSF supports multiple search engine instances for each search engine type. Each search engine instance belongs to exactly one version of the Oracle SES search engine type and is stored in the ECSF_ENGINE_INSTANCE table.

You can perform the following tasks to define search engine instances:

- Section 8.5.3.1, "Creating Search Engine Instances"

- Section 8.5.3.2, "Configuring Search Engine Instance Parameters"

- Section 8.5.3.3, "Modifying Search Engine Instances"

- Section 8.5.3.4, "Modifying Search Engine Instance Parameters"

8.5.3.1 Creating Search Engine Instances

Creating a search engine instance adds a new search engine instance to the specified search engine type.

To create search engine instances using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, shown in Figure 8-4.

4. In the Search Engine Instance toolbar, click the New Engine Instance icon. Alternatively, select New Record from the Actions menu or use the Ctrl+N keyboard shortcut.
A new record is added to the top of the table of search engine instances.

5. Enter values for the Name and Comments columns.

Caution:

A save will occur only for the selected record. You can only save one record at a time.

6. Click the Save Engine Instance icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+S keyboard shortcut.

7. Configure the search engine instance parameters. For more information, see Section 8.5.3.2.

8. Click the Register icon to register the identity plug-in and create the federated trusted entity for the selected search engine instance. Alternatively, select Register from the Actions menu or use the Ctrl+G keyboard shortcut.
A dialog with a confirmation message appears.

Registering the identity plug-in for search engine instances allows users to perform secure searches.

8.5.3.2 Configuring Search Engine Instance Parameters

Configuring search engine instance parameters sets parameter values to the search engine instance.

To configure search engine instance parameters using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, shown in Figure 8-4.

4. From the table of search engine instances, select the record of the search engine instance for which you want to configure the parameters.
The parameters of the selected search engine instance appears in the Parameters table, shown in Table 8-3.

Table 8-3 Search Engine Instance Parameters

Parameter Name

Description

Sample Value

SES_ADMIN_SERVICE

URL to Oracle SES administrative web service endpoint.

http://example.com:7777/search/api/admin/AdminService

SES_ADMIN_USERNAME

Oracle SES user for logging into Oracle SES administrative web service.

searchsys

SES_ADMIN_PASSWORD

Password for user SES_ADMIN_PROXY_USERNAME.

password

SES_ADMIN_SESSION_TIMEOUT

Time, in minutes, allowed by ECSF to keep administration session to Oracle Secure Enterprise Search (Oracle SES) before forcing to re-login/reestablish session with Oracle SES. This timeout is independent of Oracle SES's internal administration session timeout.

60

SES_QUERY_SERVICE

URL to Oracle SES Query web service endpoint.

http://example.com:7777/search/query/OracleSearch

SES_QUERY_PROXY_USERNAME

ECSF/Fusion user used by Oracle SES as a proxy user for queries.

scott

SES_QUERY_PROXY_PASSWORD

Password for ECSF user used by Oracle SES as a proxy user.

password

SES_QUERY_SESSION_TIMEOUT

Time, in minutes, allowed by ECSF to keep query session to Oracle SES before forcing to re-login/reestablish session with Oracle SES. This timeout is independent of Oracle SES's internal query session timeout.

60

ECSF_DATA_SERVICE

URL to ECSF servlets. This URL is used to construct configuration feeds for Oracle SES.

http://example.com:7101/approot/searchfeedservlet

ECSF_SECURITY_USERNAME

ECSF/Fusion user used by Oracle SES to invoke ECSF Security Service.

password

ECSF_SECURITY_PASSWORD

Password for ECSF/Fusion user used by Oracle SES to invoke ECSF Security Service.

password

ECSF_SECURITY_SERVICE

URL to ECSF servlets. This URL is used to construct configuration feeds for Oracle SES. ECSF runtime URL and ECSF Security Service URL can be set to 2 different servers, which is also what Oracle SES supports.

http://example.com:7101/approot/searchfeedservlet

ECSF_REDIRECT_SERVICE

URL to ECSF feed servlets. This URL is used to redirect drilldowns/actionable results.

http://example.com:7101/approot/searchfeedservlet

5. Select the record for the desired parameter, and modify the entry in the corresponding Value column.

Caution:

A save will occur only for the selected record. You can only save one record at a time.

6. Click the Save Engine Instance Parameter icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+Shift+S keyboard shortcut.

8.5.3.3 Modifying Search Engine Instances

Modifying a search engine instance edits the properties of an existing search engine instance.

To modify search engine instances using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, shown in Figure 8-4.

4. Modify the entries in the Name and Comments columns.

Caution:

A save will occur only for the selected record. You can only save one record at a time.

5. Click the Save Engine Instance icon to save the selected record. Alternatively, select Save Record from the Actions menu or use the Ctrl+S keyboard shortcut.

8.5.3.4 Modifying Search Engine Instance Parameters

Modifying search engine instance parameters updates the parameter values. When the parameter values are updated, you must update all the deployed searchable objects of the same search engine instance with the latest search engine instance parameters on the Oracle SES server. Only searchable objects that have been deployed can be updated with the latest search engine instance parameters on the Oracle SES server.

To modify search engine instance parameters, follow the procedures in the following tasks:

- Task 1, "Edit the Search Engine Instance Parameters"

- Task 2, "Deploy the Parameters to All Deployed Searchable Objects"

- Task 3, "Deploy the Parameters to Individual Deployed Searchable Objects"

Task 1   Edit the Search Engine Instance Parameters

You can edit the search engine instance parameters to change their values.

To change the values of the search engine instance parameters using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, shown in Figure 8-4.

4. From the table of search engine instances, select the record of the search engine instance for which you want to modify the parameters.
The parameters of the selected search engine instance appears in the Parameters tab.

5. Select the record for the desired parameter, and modify the entry in the corresponding Value column.

Tip:

It is recommended that you modify these parameters during system downtime. It is also recommended that you update the objects when all the parameters are set.

Task 2   Deploy the Parameters to All Deployed Searchable Objects

After you update the search engine instance parameter values, you must update all the deployed searchable objects of the same search engine instance with the latest search engine instance parameters on the Oracle SES server.

To deploy the new values of the search engine instance parameters to all the deployed searchable objects in the search engine instance using Fusion Applications Control:

1. From the Parameters tab, click the Deploy Parameters icon to update all the deployed searchable objects with the latest search engine instance parameter values. Alternatively, select Deploy Parameters from the Actions menu or use the Ctrl+Shift+Y keyboard shortcut.
A confirmation dialog appears.

2. Validate that all deployed searchable objects have been updated with the latest parameter values by selecting the Searchable Objects tab and viewing the Parameters Applied column.
A green check mark indicates that the searchable object is updated with the latest parameter values. A red X indicates that the searchable object is not updated with the latest parameter values. A gray box indicates that the searchable object is not deployed.

Task 3   Deploy the Parameters to Individual Deployed Searchable Objects

For any deployed searchable objects that were not updated with the latest parameter values, update them individually.

To deploy the parameters to individual deployed searchable objects using Fusion Applications Control:

1. From the Searchable Objects tab, select the record corresponding to a searchable object that was not updated with the new parameter value.
A green check mark indicates that the searchable object is updated with the latest parameter values. A red X indicates that the searchable object is not updated with the latest parameter values. A gray box indicates that the searchable object is not deployed.

2. Click the Deploy Parameters icon to update the parameter values for that deployed searchable object. Alternatively, select Deploy Parameters from the Actions menu or use the Ctrl+Shift+Y keyboard shortcut.
A confirmation dialog appears.

A green check mark will replace the red X when the latest search engine instance parameters are updated for the searchable object.

8.5.3.5 Deleting Search Engine Instances

Deleting search engine instances removes them from the specified search engine type.

To delete search engine instances using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Oracle SES search engine type name link in the Search Engine Types table to open the Search Engine Instance administration page, shown in Figure 8-4.

4. From the table of search engine instances, select the record you want to delete.

5. Click the Delete Engine Instance icon to delete the selected record. Alternatively, select Delete Record from the Actions menu or use the Ctrl+D keyboard shortcut.

8.5.4 Enabling Search on External Data Sources

In addition to providing search against ECSF data sources (that is, view object based data sources deployed from ECSF administration) and data sources that are crawled via ECSF, ECSF supports search against all registered Oracle SES data source groups that contain external data sources. External data sources include data sources such as Intranet, mail, database, and federated data sources (data sources crawled in separate engine instances). Oracle SES data source groups can also contain federated ECSF data sources (data sources created in different logical engine instances via the ECSF administration tools).

ECSF Administration synchronizes categories with the data source groups on Oracle SES. The data sources are not synchronized.

Figure 8-17 illustrates the process flow for enabling search on external data sources.

Figure 8-17 Process Flow for Search on External Data Sources

The process flow includes the following steps:

1. Data source groups are imported from Oracle SES via the Fusion Applications Control. For more information, see Task 1, "Import the External Search Categories".

2. The Oracle Fusion Applications database is synchronized with the data source groups from Oracle SES.
ECSF sets the IS_EXTERNAL flag to true on records in the ECSF_SEARCH_INDEX_GROUP table to identify them as external search categories.

3. ECSF-created search categories and external search categories are both accessible via getSearchGroups().

4. SearchCtrl can query any search category, and the underlying data may actually be federated to other Oracle SES instances.

Note:

ECSF supports multiple search engine instances for each application. However, each query can only contain search categories deployed on the same search engine instance.

Search categories containing ECSF data sources are represented in the ECSF_SEARCH_INDEX_GROUP table and linked to one or more searchable objects through an intersection table. Search results are usually grouped by the searchable object name stored in the ECSF_SO_NAME custom attribute that is returned in each search result.

Note:

ECSF currently does not support querying search categories that contain mixed data sources. Each search category must contain either only ECSF data sources or only external data sources.

External search categories are not linked to searchable objects. Instead, ECSF creates the ExternalSearchableObject searchable object type for external search categories. Search results from external search categories are assigned to the external searchable object, named oracle.ecsf.meta.ExternalSearchableObject, that is created during runtime.

Example 8-1 queries an external category called ”Oracle Website.”

Example 8-1 Sample Code for Querying External Categories

public void federationTest()
{
SearchCtrl searchCtrl = new SearchCtrl();
SearchHits searchHits = null;
SearchContext searchContext = null;
SearchEngineInstance engineInstance = null;
SearchGroup[] sgs = new SearchGroup[1];

QueryMetaDataImpl queryMetaData = new QueryMetaDataImpl();
queryMetaData.setQueryString("%");
queryMetaData.setPageSize(10);
queryMetaData.setCurrentPage(1);

ArrayList<SearchEngineInstance> engineInstances =
(ArrayList<SearchEngineInstance>)searchCtrl.getEngineInstances();
for (int i = 0; i < engineInstances.size(); i++)
{
if (engineInstances.get(i).getId() == 1)
{
engineInstance = engineInstances.get(i);
break;
}
}

ArrayList<SearchGroup> groups = (ArrayList<SearchGroup>)engineInstance.getSearchGroups();
for (int j = 0; j < groups.size(); j++)
{
if (groups.get(j).getName().equals("Oracle Website"))
{
sgs[0] = groups.get(j);
break;
}
}      queryMetaData.setSearchGroups(sgs);      searchContext = ContextFactory.getSearchContext();      searchContext.bindUser("scott");      try      {         searchHits = searchCtrl.runQuery(searchContext, queryMetaData);      }      catch (Exception e)      {          fail("Failed runQuery due to "+e.getMessage());      }            IndexedDocument doc = searchHits.getDocument(0);      String url = null;      try      {         url = doc.getDefaultAction().getRedirectURL();         ActionURLResolver resolver = new ActionURLResolver();         url = resolver.resolveURL(searchContext, doc.getDefaultAction());      }      catch (Exception e)      {      }}

Since there is no view object or search object definition file where actions can be defined, the URL attribute of the resulting object returned from Oracle SES will be used to generate a default action with the name Default.

Advanced search and faceted navigation are not supported for external data sources.

8.5.5 Adding Product Families for Federated Search

To include a new product family for federated search, you must add a Search Application Service Component instance to engine type Oracle Search Application and configure the instance.

Note:

Manage credentials via the MBean using JConsole.

Each product family (Oracle Fusion Customer Relationship Management, Oracle Fusion Human Capital Management, and Oracle Fusion Supply Chain Management) has its own search application. Each search application provides the data service, query web service, authentication service, and authorization service for the product family. Each search application also contains all the searchable objects and its dependencies for the product family as well as the references to the ECSF shared libraries.

To create and configure a Search Application Service Component instance using Fusion Applications Control:

1. From the navigation pane, expand the farm and then the Enterprise Crawl and Search Framework folder.

2. Select the application engine instance that contains the searchable objects you want to manage to open the Enterprise Crawl and Search Framework Configuration Settings page.

3. Click the Search Application Service Component link.

4. On the Search Application Service Component administration page, shown in Figure 8-11, click the New Engine Instance icon. Alternatively, select New Record from the Actions menu or use the Ctrl+Shift+N keyboard shortcut.
A new Search Application Service Component instance record is added to the top of the table of configured search applications.

5. Enter a value for the Name column.

6. On the Parameters tab, set the value for the ECSF_QUERY_SERVICE_REF_NAME parameter of the Search Application Service Component instance. Use the following format:
{/oracle/ecsf/service/query/common/componentname/}SearchService

replacing componentname with the name of the Search Application Service Component.

7. Set the value for the IS_ACTIVE parameter of the Search Application Service Component instance.
Set the value to Y to specify that the Search Application Service Component is active. The component is skipped during global search related functions when you set the value to N. If the IS_ACTIVE parameter value is not defined for the component in the database, the component is treated as active.

8. Save.

Related Links

The following document provides additional information about the topics discussed in this section:.

- For more information managing credentials via the MBean using JConsole, see Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

9 Managing Oracle WebLogic Communication Services for Click-to-Dial Functionality

Oracle WebLogic Communication Services provides click-to-dial functionality for applications primarily through contextual actions. Contextual actions provide related information and actions to users within the immediate context of the object instances upon which they act. This chapter explains how to enable and configure these services.

It includes the following topics:

- Section 9.1, "Introduction to Third Party Call Web Service"

- Section 9.2, "Modifying Third Party Call Web Service Default Settings Using the System MBean Browser"

- Section 9.3, "Call Routing Through a Session Border Controller"

9.1 Introduction to Third Party Call Web Service

The Third Party Call Web service in Oracle WebLogic Communication Services enables click-to-dial functionality in applications by providing an interface to initiate a call between two parties. The Web service is an implementation of the Parlay X 2.1 Third Party Call Interface.

The Third Party Call Web service can:

- Set up a call between two parties

- Query the status of an ongoing call

- Cancel a call it is creating

- Terminate an ongoing call it created

The Third Party Call Web service is provided through the thirdpartycall application, which is installed with default configuration settings in the domain for the each product family.

9.2 Modifying Third Party Call Web Service Default Settings Using the System MBean Browser

You can use the System MBean Browser to modify the default configuration settings for the thirdpartycall application for the product family domains.

To modify the MBeans for the thirdpartycall application with the System MBean Browser from the Fusion Applications Control:

1. From the target navigation pane, expand the farm and then Application Deployments.

2. Select the application thirdpartycall.

3. From the Application Deployment menu, select System MBean Browser.
Fusion Applications Control displays the System MBean Browser page.

4. Scroll down to the node that displays oracle.ucs.thirdpartycall. Expand the oracle.ucs.thirdpartycall node and drill down to the node that displays the ThirdPartyCallConfiguration MBean.

5. Click the ThirdPartyCallConfiguration MBean node. The configuration settings for the thirdpartycall application appear on the right pane. Select the Attributes tab to display the details for this group of attributes.
For more information about the configurable attributes for the thirdpartycall application, see Table 9-1.

6. Update values of the attributes to modify by entering the new value in the Value field.

7. Click Apply.

Table 9-1 contains a list of attributes for configuring the Third Party Call Web service

Table 9-1 Configuration Attributes for Third Party Call Web Service

Attribute

Format

Description

Values

ChargingAllowed

String

Specifies if charging is allowed.

Default: False

Note: No server restart is required if you change the value.

ControllerUri

String in URI format

Specifies the Third Party controller Session Initiation Protocol (SIP) URI that is used to establish the third party call. If this value is set, a call appears to the callee to come from this URI.

Default: empty

By default, no controller URI is used to establish the call. In this case, the call appears to the callee to come from the caller.

Note: You must restart the server if you change this value.

MaximumCallDuration

int

Specifies the maximum time (in minutes) for an ongoing call. If this time expires, the call is terminated.

Default: 1440 (24 hours)

Minimum: -1 (0 and -1 means that call-length supervision is disabled)

Maximum: Unbounded

Note: No server restart is required if you decrease this value. You must restart the server if you increase the value or set the value to 0 or -1.

PAssertedIdentityUri

String in URI format

Specifies the SIP URI used in the P-Asserted-Identity header added by the Third Party Call service. If left blank the P-Asserted-Identity header is not added.

Default: empty

Note: You must restart the server if you change this value.

StatusRetentionTime

int

Specifies the time (in minutes) for retaining the status information about a call after it was terminated.

Default: 5

Minimum: -1 (0 and -1 means that the status information is removed when the call is terminated).

Maximum: Unbounded

Note: No server restart is required if you change the value.

PreloadedRouteUri

String in URI format

Specifies the SIP URI to put in a route header of outgoing SIP INVITE requests during a call setup.

Default: empty

Note: You must restart the server if you change this value.

Related Links

The following document provides additional information about the topics discussed in this section:

- For more information about the System MBean Browser, see the ”Getting Started Using Oracle Enterprise Manager Fusion Middleware Control” section in Oracle Fusion Middleware Administrator's Guide.

9.3 Call Routing Through a Session Border Controller

The Third Party Call Web service interfaces on the backend with SIP infrastructure, such as a SIP-enabled switch or a SIP-to-PSTN gateway. When the SIP infrastructure lies outside the enterprise network, such as in the case of a hosted SIP trunking service or if the switch is in an external network, a Session Border Controller (SBC) is typically used to secure and control the interaction. A SBC is a piece of equipment that is deployed at the border of the network and controls the signaling and media across network address translation (NAT) devices and firewall boundaries. In addition, it prevents unauthorized access and denial of service (DoS) attacks.

You can route the Third Party Call Control (TPCC) requests through an SBC either by setting up an outbound proxy server or by configuring one TPCC attribute.

This section contains the following topics:

- Section 9.3.1, "Setting Up an Outbound Proxy Server"

- Section 9.3.2, "Configuring the PreLoadedRouteUri Attribute"

9.3.1 Setting Up an Outbound Proxy Server

You can set up the SBC as an outbound proxy server and route TPCC requests through the outbound proxy server. If you define an outbound proxy server (SBC) for a SIP Servlet container, any request from all SIP servlet applications (including the thirdpartycall application) on this SIP Servlet container is routed through the SBC.

Oracle WebLogic SIP Server provides Oracle WebLogic Administration Console extensions that allow you to modify the SIP Servlet container properties. To set up an outbound proxy:

1. Enter the following URL in a browser:

http://hostname:port_number/console

where the hostname and the port_number correspond to the Administration Server for the domain.

2. Log in using the Oracle Fusion Middleware administrative user name and password.

3. Select the SipServer node in the left pane. The right pane of the console displays the tabbed pages that are used for configuring and monitoring WebLogic SIP Server.

4. Select the Proxy tab.

5. Select the Proxy Routing Policy as proxy.

6. In the Proxy Routing URIs section, enter the URI as sip:SBC_hostname:SBC_portnumber, where SBC_hostname and SBC_portnumber represent the host and port of the Session Border Controller, respectively.

7. Click Save.

For more information, see the "SIP Server: Configuration: Proxy" topic in the Oracle WebLogic Administration Console Help.

Note:

Oracle recommends that you use the Administration Console to modify sipserver.xml indirectly, rather than editing the file by hand. Using the Administration Console ensures that the sipserver.xml document always contains valid XML.

9.3.2 Configuring the PreLoadedRouteUri Attribute

To route requests only from the thirdpartycall application through SBC, set the value of the PreLoadedRouteUri attribute as sip:SBC_hostname:SBC_portnumber, where SBC_hostname and SBC_portnumber represent the host and port of the SBC, respectively.

For more information about modifying the PreLoadedRouteUri attribute, see Section 9.2.

Part III

Monitoring

This part provides information about how to monitor the Oracle Fusion Applications environment. It explains how to find information about the cause of an error and its corrective action, and how to view and manage log files to assist in monitoring system activity and to diagnose problems.

Part III contains the following chapters:

- Chapter 10, "Monitoring Oracle Fusion Applications"

- Chapter 11, "Monitoring the Oracle Fusion Applications Middle Tier"

- Chapter 12, "Monitoring and Tuning Oracle Database for Oracle Fusion Applications"

- Chapter 13, "Managing Oracle Fusion Applications Log Files"

- Chapter 14, "Managing Oracle Fusion Applications Diagnostic Tests"

10 Monitoring Oracle Fusion Applications

This chapter describes how to manage Oracle Fusion web applications using Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) and Oracle Enterprise Manager (Cloud Control).

This chapter includes the following topics:

- Section 10.1, "Introduction to Monitoring Oracle Fusion Applications"

- Section 10.2, "The Product Family Home Page and Sections in Fusion Applications Control"

- Section 10.3, "The Product Home Page and Sections in Fusion Applications Control"

- Section 10.4, "The Fusion Instance Overview Page and Sections in Cloud Control"

- Section 10.5, "The Product Family Home Page and Sections in Cloud Control"

- Section 10.6, "The Product Home Page and Sections in Cloud Control"

- Section 10.7, "Monitoring Product Families and Products"

- Section 10.8, "Monitoring the Detailed Status of Oracle Fusion Applications"

- Section 10.9, "Monitoring Business Performance Metrics for a Product Family"

- Section 10.10, "Monitoring Business Performance Metrics for a Product"

- Section 10.11, "Viewing the Routing Topology of an Oracle Fusion Applications Instance, Product Family, or Product"

- Section 10.12, "Viewing the Configuration Topology of an Oracle Fusion Applications Instance, Product Family, or Product"

10.1 Introduction to Monitoring Oracle Fusion Applications

Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) is a tool used to monitor Oracle Fusion Applications product families and products deployed to Oracle WebLogic Server. Oracle Enterprise Manager Cloud Control (Cloud Control) is a tool used in much the same way, but viewing Oracle Fusion Applications product families and products within the larger context of Oracle Fusion Middleware.

Oracle Enterprise Manager Fusion Applications Control provides a large picture view of your deployments, while also allowing you to drill down for more detailed information. You can monitor the status of the servers to which product families are deployed and the databases that store product information, the status of all scheduled job requests running in the system, as well as the overall state and performance of product families and products. The customizable performance summary pages allow you to monitor product performance and diagnose problems. You can modify these charts to display statistics that are relevant to your deployment, or add a product to the chart so as to compare the performance information for two components in one chart.

Using a topographical chart, you can examine the relationship between a deployed product family and its products, and drill down to view the status of individual product instances. Out-of-the-box performance metrics provided for each Oracle Fusion Applications product allow detailed monitoring of the state and performance of all product families and each individual product.

10.2 The Product Family Home Page and Sections in Fusion Applications Control

The product family home page provides an overview of the products belonging to a product family. An example of a product family home page is shown in Figure 10-1.

Figure 10-1 The Product Family Home Page in Fusion Applications Control

The Product Family home page includes the following sections:

- Section 10.2.1, "Applications and Infrastructure Section"

- Section 10.2.2, "Topology Section"

- Section 10.2.3, "Oracle Enterprise Scheduler Sections"

10.2.1 Applications and Infrastructure Section

The Applications and Infrastructure section shows the status of the database, deployed Oracle Fusion Applications and Oracle Fusion Middleware itself. The Fusion Applications and Fusion Middleware pie charts show the percentage of Oracle Fusion Applications and Oracle Fusion Middleware servers that are currently up or down. The number of applications and servers that are running or down is shown below each pie chart.

10.2.2 Topology Section

The Topology section displays the components of the product family or product. In the Product home page, the Topology section displays the same information, with the irrelevant products and Java EE applications grayed out.

The Product Family home page Topology section is shown in Figure 10-2.

Figure 10-2 Product Family Home Page Topology Region

The Product home page Topology section is shown in Figure 10-3.

Figure 10-3 Product Home Page Topology Section

Mousing over a component under the Oracle Fusion Applications heading highlights the related product under the Product heading, and vice versa. In the Product Family home page, clicking a product in the Topology section displays the Product home page for that product. Clicking the name of the Oracle Fusion Applications product family in the Topology section displays the Oracle Fusion application instances running on servers in the application cluster. The Fusion Cluster Application home page is displayed, as shown in the following figure.

Figure 10-4 Fusion Cluster Application Home Page

For more information about viewing topology information, see Section 11.2.3.1

10.2.3 Oracle Enterprise Scheduler Sections

The Oracle Enterprise Scheduler sections display information pertaining to scheduled jobs running in relation to the product or product family. The Oracle Enterprise Scheduler sections are as follows.

- Top Long Running Job Requests: This section provides information about the top long running scheduled job requests, including request ID, job definition used, the product and time elapsed since the job executed. Fusion Applications Control Product home page only.

- Recently Completed Job Requests (Last 24 Hours): This section provides information about the most recent scheduled jobs completed within the last 24 hours, including job definition used, the product, the number of completed and failed requests, the percentage of successfully completed job requests and the time elapsed from execution.

- Ready Job Requests: This section shows the scheduled job requests that are awaiting execution, including the job definition used, the product and the number of jobs that are ready to run. Fusion Applications Control Product home page only.

For more information about this section, see the online help.

10.2.4 Recently Completed SOA Instances Section

The Recently Completed SOA Composite Requests (Last 24 Hours) section displays information about the most recent SOA composite execution requests completed within the last 24 hours, including the name of the SOA composite, the name of the partition to which the composite is deployed, the number of completed instances, the percentage of successfully completed instances and the response time in milliseconds for synchronously executed SOA composites.

10.3 The Product Home Page and Sections in Fusion Applications Control

The product home page provides an overview of the Oracle Fusion Applications required to run a given product. An example of a product home page is shown in Figure 10-5.

Figure 10-5 The Product Home Page in Fusion Applications Control

The Oracle Fusion Applications Product Home page displays the following sections:

- Section 10.3.1, "Key Performance Indicators Section"

- Section 10.3.2, "Fusion Applications Section"

- Section 10.3.3, "Servers Section"

- Section 10.2.2, "Topology Section"

- Section 10.2.3, "Oracle Enterprise Scheduler Sections"

10.3.1 Key Performance Indicators Section

The Key Performance Indicators section displays the main performance metrics related to the product family or product. By default, these metrics display in graphical format. Alternatively, you can display the performance metrics in tabular format instead. Mousing over a particular metric causes the performance graph to display only the data for that metric.

You can add or remove metrics from the Key Performance Indicators section. You can also change the order in which metrics display. For more information about monitoring business metrics for a product family or product, see Section 10.10

10.3.2 Fusion Applications Section

The Oracle Fusion Applications section displays the Oracle Fusion Applications that are part of the product and have been installed. Each application may include instances running on other servers in the domain.

For more information about this section, see the online help.

10.3.3 Servers Section

The Servers section displays the names of the domain, clusters and servers running the Oracle Fusion Application. The table listing the clusters and servers displays the status of each item, indicating whether they are up or down. Additionally, the table displays other data such as the number of sessions currently active, the number of requests received per minute and the time required to process a request.

For more information about this section, see the online help.

10.4 The Fusion Instance Overview Page and Sections in Cloud Control

The Fusion Instance home page allows you to monitor a whole instance at a glance, including diagnostic values, a summary of member targets, the status of members and top long running job requests. The Fusion Instance menu provides several administrative options for managing all the product families, as shown in Figure 10-6.

Figure 10-6 The Fusion Instance Overview Page in Cloud Control

To display the Cloud Control Fusion Instance overview page:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications page, click the Fusion Instance whose overview page you want to display.
The Fusion Instance page is displayed, as shown in Figure 10-6.

The Fusion Instance overview page displays the following sections:

- Section 10.4.1, "Summary Section"

- Section 10.4.2, "Member Target Summary Section"

- Section 10.4.3, "Status Section"

- Section 10.4.4, "Infrastructure Section"

- Section 10.4.5, "Compliance Summary Section"

- Section 10.4.6, "Patch Recommendations"

10.4.1 Summary Section

The Summary section displays an overview of the Fusion instance as a whole, including diagnostic and database information.

The following sub-sections display in the Summary section:

- Section 10.4.1.1, "Monitoring and Diagnostics Region"

- Section 10.4.1.2, "Database System Region"

10.4.1.1 Monitoring and Diagnostics Region

The Monitoring and Diagnostics sub-section displays major incidents and changes that have occurred in the Fusion instance, including incidents at the instance level, incidents that have occurred in descendant targets, any configuration changes that have occurred over the last seven days and any support workbench problems. Incidents are listed by severity, namely fatal, critical, warning and escalation levels.

10.4.1.2 Database System Region

The Database System sub-section displays database information related to the Fusion instance, including the name of the database system, the percentage of available space on the system and the name of the database to which the Fusion instance writes its data.

10.4.2 Member Target Summary Section

The Member Target Summary section displays an overview of the member targets of the Fusion instance, including product families and products. The type of information displayed in this sub-section is similar to that displayed in the Cloud Control Fusion Applications overview page described in Section 2.8.4.

10.4.3 Status Section

The Status section displays status information regarding the members of the Fusion instance. The numbers at the top of the Status section indicate how many members of the instance are up, down or unavailable. You can click a number or status for more information.

The table in the Status section displays members that have been affected the most within the last 24 hours. This includes Oracle WebLogic Servers, application deployments, clustered application deployments, Fusion Java EE applications, and so on. The table displays the status and percent availability for each member. You can click individual member items for more information.

10.4.4 Infrastructure Section

The Infrastructure section shows the status of the Oracle Fusion Middleware targets on which Fusion Applications runs, including Oracle WebLogic Servers and clusters. The Member Status Summary indicates the number of targets that are running or down.

The Incidents column shows major incidents that have occurred in the infrastructure targets, including descendant targets. Incidents are listed by severity, namely fatal, critical, warning and escalation levels.

10.4.5 Compliance Summary Section

The Compliance Summary section indicates the extent to which targets are in compliance with any standards defined for the organization. Compliance evaluation is the process of testing the compliance standard rules within a compliance standard against a target and recording any violations in the Oracle Management Repository.

Compliance standards are sets of rules that require all components to be configured according to organization policy. Compliance standards can include checks, such as verifying that all servers run securely using SSL, or that files do not include unhashed passwords. You can use the compliance standards provided by Oracle, for example, Security Configuration for Oracle Database, or create your own standard.

Violations are categorized as errors, warnings, and minor warnings. Average compliance scores are listed for each component, as well as the date of the most recent compliance evaluation.

Click Trend Overview to visually determine whether the targets are adhering to or distancing themselves from the compliance best practices.

10.4.6 Patch Recommendations

The Patch Recommendations section indicates whether any patches can be applied to any given target. Patches can be displayed by target type or classification of patch.

10.5 The Product Family Home Page and Sections in Cloud Control

When selecting a product family from the Fusion Applications overview page or the Fusion Instance page, Cloud Control directs you to the product family home page for the selected product family, as shown in Figure 10-7. The Cloud Control Product Family home page displays an overview of the product family at a glance, including the products and Oracle Fusion applications comprising the product family.

Figure 10-7 The Product Family Home Page in Cloud Control

The Product Family home page includes the following sections:

- Section 10.2.1, "Applications and Infrastructure Section"

- Section 10.2.2, "Topology Section"

- Section 10.2.3, "Oracle Enterprise Scheduler Sections"

- Section 10.2.4, "Recently Completed SOA Instances Section"

- Section 10.3.1, "Key Performance Indicators Section"

The Product Family menu provides several administrative options for managing the the product family, which are similar to those in Fusion Applications Control.

You can click a particular product to display the Cloud Control product home page.

10.6 The Product Home Page and Sections in Cloud Control

When selecting a product from the Fusion Applications overview page, Fusion Instance page, or Product Family home page, Cloud Control directs you to a home page for the selected product, as shown in Figure 10-8. The Cloud Control Product home page displays an overview of a product at a glance, including the Oracle Fusion applications that compose the product and the servers on which they run.

Figure 10-8 The Product Home Page in Cloud Control

The Cloud Control Product home page displays the following sections:

- Section 10.4.1, "Summary Section"

- Section 10.3.1, "Key Performance Indicators Section"

- Section 10.3.2, "Fusion Applications Section"

- Section 10.3.3, "Servers Section"

- Section 10.2.2, "Topology Section"

- Section 10.2.3, "Oracle Enterprise Scheduler Sections"

The Product menu provides several administrative options for managing the product, which are similar to those in Fusion Applications Control.

10.7 Monitoring Product Families and Products

The product family and product home pages allow you to monitor various aspects of your servers and applications.

The main steps in monitoring product families and products are as follows:

- Verify component status.

- View and modify performance metrics.

- Monitor the status of any scheduled jobs.

To monitor a product family or product in Fusion Applications Control or Cloud Control:

1. Navigate to the product family home page:

- Fusion Applications Control: From the navigation pane, select the name of the product family.

- Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications page, click the Fusion Instance whose overview page you want to display.
The Fusion Instance page is displayed.

3. In the Fusion Instance overview page, expand the Fusion instance and click the name of the product family.

2. Alternatively, navigate to the product home page:

- Fusion Applications Control: From the navigation pane, expand the product family, then Products, and then select the product.

- Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications page, click the Fusion Instance whose overview page you want to display.
The Fusion Instance page is displayed.

3. In the Fusion Instance overview page, expand the Fusion instance and the product family. Click the name of the product whose home page you want to display.

3. Use the following sections on the main product family or product page to verify the status of various components.

- Applications and Infrastructure: Verify the availability of Fusion Applications and Oracle Fusion Middleware.

- Topology: View the complete topology of the product or product family. Click a node to view the home page of the selected component.

- Fusion Applications: Verify the status of Fusion cluster applications, Fusion applications and the relationship between domain and server.

- Servers: Verify the status of Fusion cluster applications and all related servers.

For more information about the individual sections on the product family and product home pages, see Section 10.2 and Section 10.3.

For more information about monitoring Fusion applications, see Section 10.8.

4. In the Key Performance Indicators section, view the product or product family main performance metrics. Click the View Actions menu to perform any of the following tasks.

- Modifying performance metrics: You can view and modify the performance metrics in this section by clicking the View Actions menu in the section and selecting Select Metrics.
The Select Metrics popup window is displayed.

In the Select Metrics dialog, you can search for a particular metric in the Search field and select or remove the metrics you want to display or hide in the Key Performance Indicators section.

For more information about monitoring and modifying performance metrics, see Section 10.9.

- Saving charts: You can save metric charts to a file by selecting View Actions > Save charts.

- Restoring default charts: You can restore the metric charts to their defaults such that only the default metrics display, by selecting View Actions > Restore default charts.

5. Monitor the status of any scheduled jobs by using the Oracle Enterprise Scheduler sections described Section 10.2.3. You can view more scheduled jobs displayed in these sections by clicking Show All at the bottom of each section.
Clicking Show All displays the Oracle Enterprise Scheduler section in a larger pane such that a larger number of relevant jobs display.

10.8 Monitoring the Detailed Status of Oracle Fusion Applications

The Applications and Infrastructure page allows you to verify the status of a given Oracle Fusion application.

To verify the status of a given Oracle Fusion application:

1. Display the Product Family home page.

- In Fusion Applications Control, from the navigation pane, select the product family.

- In Cloud Control, from the Targets menu, choose Fusion Applications.
In the Fusion Applications table, click the desired product family.

2. Display the Applications and Infrastructure page.

- In Fusion Applications Control, from the Product Family menu, choose Applications and Infrastructure

- In Cloud Control, from the Product Family menu, choose Monitoring and then select Applications and Infrastructure.

The Applications and Infrastructure page is displayed.

3. Click the Fusion Applications tab.
This tab shows the status of a given clustered Oracle Fusion J2EE application. When expanding an application, the individual instances of the Oracle Fusion application are displayed, each running on different servers. A status appears for each of these individual application deployments.

A pie chart indicates the percentage of Fusion applications in the product family that are up and running within the farm domain.

10.9 Monitoring Business Performance Metrics for a Product Family

The Key Performance Indicators page displays an overview of the performance metrics of a given product family. Typically, several default metrics display on the page in the form of graphs. Multiple metrics are tracked, and these can be added to the Key Performance Indicators page. Each product belonging to a given product family has its own set of metrics.

You can modify the Key Performance Indicators page as follows:

- Add or remove metrics from the page.

- Display performance data in tabular format.

- Save or delete a set of performance charts.

- Re-organize the display of charts, for example move charts up or down.

- Display the performance metrics of another instance of the product on top of the current chart sets, or display earlier metrics of the same product instance on top of current metrics.

- Toggle on or off the grid display on the performance chart set.

- Modify the performance time period.

To view and modify a product family's business performance summary page in Fusion Applications Control or Cloud Control:

1. Navigate to the product family home page.

- Fusion Applications Control: From the navigation pane, choose the product family.

- Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications list page, click the product family.

2. Display the Key Performance Indicators page.

- Fusion Applications Control: From the Product Family menu, select Key Performance Indicators.

- Cloud Control: From the Product Family menu, select Monitoring and then select Key Performance Indicators.

The product family home page is displayed. You can view the key metrics for the product family in the Key Performance Indicators page.

3. Display the metrics pane by clicking Show Metric Palette.

4. You can modify the metrics that display on the Key Performance Indicators pane.
In the Metrics Palette, select the metrics you want to display in the Key Performance Indicators pane.

5. You can search for a particular metric.
In the Metrics Palette Search field, enter the name of the metric you want to find and click the Search button.

6. You can change the order in which metrics display on the Key Performance Indicators pane, or delete a metric from the display.

- Click the bar to the left of the metric name and drag the metric up or down.

- Click the Close button on the upper right corner of the metric to delete it from the display.

7. In Cloud Control only, you can optionally click a metric name for more information about that metric.
The Additional Information dialog is displayed. From this dialog, you can view more details about the metric using the following links:

- Problem Analysis: Directs to the Problem Analysis page. This page enables you to see a metric with other related metrics, which are affecting the metrics being analyzed. It also shows the related targets and the related targets topology. The Problem Analysis is only available for request-related metrics, such as the Request Processing Time (ms) and Request (per minute).

- Analyze Logs: Displays a message that enables you to view the logs for a target on which the metric is viewed.

- Metric Details: Enables you view historical metric data.

- Target Home: Directs you to the home page.

When used together, Problem Analysis and Analyze Logs can help you inspect metrics, target status information, and logs during troubleshooting. These links are not available for all metrics.

Related Links

The following documents provide additional information:

- For more information about the Problem Analysis and Analyze Logs links, see the "Working with Cloud Control Problem Analysis and the Analyze Logs Options" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

- For information about viewing and modifying the display of product family performance indicators, see Section 2.5.7.

10.10 Monitoring Business Performance Metrics for a Product

The Performance Summary page displays an overview of the performance metrics for a given product. Typically, several default metrics display on the page in the form of graphs. Multiple metrics are tracked, and these can be added to the Performance Summary page. Each product belonging to a given product family has its own set of metrics.

You can modify the performance page as follows:

- Add or remove metrics from the page.

- Display performance data in tabular format.

- Save or delete a set of performance charts.

- Re-organize the display of charts, for example move charts up or down.

- Display the performance metrics of another product family on top of the current chart sets, or display earlier metrics of the same product family on top of current metrics.

- Toggle on or off the grid display on the performance chart set.

- Modify the performance time period.

To view and modify a product's business performance summary page in Fusion Applications Control or Cloud Control:

1. Navigate to the product home page.

- Fusion Applications Control: From the navigation pane, expand the product family, then Products, and then select the product.

- Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications list page, expand a product family and click an individual product.

2. Display the Key Performance Indicators page.

- Fusion Applications Control: From the Product menu, choose Key Performance Indicators.

- Cloud Control: From the Product menu, choose Monitoring and then select Key Performance Indicators.

The product family home page is displayed. You can view the key metrics for the product family in the Key Performance Indicators page.

3. To modify the display of metrics in the Key Performance Indicators page, follow the procedure in Section 10.9, beginning with Step 3.

10.11 Viewing the Routing Topology of an Oracle Fusion Applications Instance, Product Family, or Product

Cloud Control provides a routing topology viewer, which provides a graphical representation of routing relationships across targets, components and elements. It shows you the routing details for the Oracle Fusion Applications environment, from Oracle HTTP Server (OHS) to the Oracle WebLogic Servers to the Oracle Database. Targets are annotated to indicate status and incidents. Tool tips show additional information about entities and relationships. You can pan and zoom the graph, as in popular map programs, and also expand and collapse desired areas of the graph. The graph can be filtered to show only desired nodes. The topology graph is highly interactive. You can hover over and click on various parts of the graph. The topology graph provides visibility into the runtime environment.

You can also print the topology or save it to a .png file.

To view the topology with Cloud Control:

1. Navigate to a Fusion Instance, product family, or product home page:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications page, click the appropriate target, the instance for the Oracle Fusion Applications or product family. You can also expand a product family to select an individual product.

2. From the Fusion Instance, Product Family, or Product menu, choose Routing Topology.
The Routing Topology page is displayed.

3. From the View menu, choose one of the following topology views:

- Routing: Group by Application: Choose to view the topology of the applications as they relate to the Oracle WebLogic Server domains and servers, as well as the Oracle Database.

- Routing: Group by Middleware: Choose to view the topology for the middleware targets, such as Oracle WebLogic Server.

- Routing: Group by Host: Choose to view the topology of the targets on the hosts in the enterprise.

- Products: Choose this view the topology of Oracle Fusion Applications products.

4. To see information about a particular target, place your mouse over the target. To view additional information, click More. For example, for an Oracle WebLogic Server Domain, you can view general information about the domain home location, incidents, and configuration.

5. From the Products menu, select and deselect specific products to narrow or expand the scope of the graph.

6. From the Node Type menu, select or deselect specific node types to narrow or expand the focus of the graph.

7. From the Options menu, you can save or print the image, expand or collapse all of the nodes, change the orientation of the topology to be left to right or top to bottom, or reload the routing navigator.
In addition, you can refresh the status and the metrics or update the topology. To refresh the status and metrics, click Refresh Target Status and Metrics. To update the topology shown in the viewer, click Recreate Topology. If a target has been added or deleted, the target list and relationships are updated. This option also updates the status and metrics.

8. With Topology Viewer, you can also:

- Search for specific target or node or type of target or node within the topology with the Toggle Find Toolbar widget from the toolbar at top of the page. This makes it easier to find a target if you have many targets. After the target is found, it is highlighted in the topology and the topology is repositioned. This enables you to see the target, if it was not previously visible in the viewing area.

- View the targets by status. Choose Show Up Targets, Show Down Targets, Show Targets with Fatal Incidents, and Show Targets with Critical Incidents from the toolbar at top of the page.

- Navigate to the home page of a target. Right-click the target, and choose Home.

- Hide or show the status or metrics. From the Annotations menu, choose Status or Metrics.
If you select Metrics, one key performance metric for the component is displayed. (You cannot change the metric that is displayed.)

- View the routing relationships between components.

- Perform operations directly on the target by right-clicking. The right-click target menu is displayed.

9. Interact with a topology graph.
For more information, see "Interactive Gestures" in the Cloud Control online help.

10.12 Viewing the Configuration Topology of an Oracle Fusion Applications Instance, Product Family, or Product

With Cloud Control, you can view the configuration topology of the IT environment in a graphical format for the Fusion instance, product family, or individual product. The inter-relationships between targets are used to answer questions such as:

- On what targets does this target rely?

- What targets will be affected if this target goes down?

- How are the members of my system related?

To view a configuration topology:

1. Navigate to a Fusion Instance, product family, or product home page:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications list page is displayed.

2. In the table on the Fusion Applications page, click the appropriate target, the instance for the Oracle Fusion Applications or product family. You can also expand a product family to select an individual product.

2. From the Fusion Instance, Product Family, or Product menu, choose Configuration > Topology.
The Configuration Topology page is displayed.

3. From the View menu, choose one of the following topology views:

- Routing: Group by Application: Choose to view the topology of the applications as they relate to the Oracle WebLogic Server domains and servers, as well as the Oracle Database.

- Routing: Group by Middleware: Choose to view the topology for the middleware targets, such as Oracle WebLogic Server.

- Routing: Group by Host: Choose to view the topology of the targets on the hosts in the enterprise.

- Products: Choose this view the topology of Oracle Fusion Applications products.

4. Use the configuration topology:

- View existing configuration topologies. See "Viewing a Configuration Topology" in the Cloud Control online help.

- Create custom configuration topologies. See "Creating a Custom Topology View" in the Cloud Control online help

Related Links

The following documents provide additional information:

- For more information about viewing existing configuration topologies, see "Viewing a Configuration Topology" in the Cloud Control online help.

- For more information about creating custom configuration topologies, see "Creating a Custom Topology View" in the Cloud Control online help

11 Monitoring the Oracle Fusion Applications Middle Tier

This chapter describes how to monitor the middle tier using Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) and Oracle Enterprise Manager (Cloud Control).

This chapter includes the following topics:

- Section 11.1, "Introduction to Monitoring the Middle Tier"

- Section 11.2, "Monitoring and Viewing Performance Status of Oracle Fusion Middleware"

- Section 11.3, "Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product"

- Section 11.4, "Monitoring Performance for Key Oracle Fusion Middleware Components with Fusion Applications Control"

- Section 11.5, "Performing Proactive Performance Monitoring with Cloud Control"

- Section 11.6, "Tuning Middle Tiers for Oracle Fusion Applications"

The procedures referenced in the Oracle Fusion Middleware guides describe using Fusion Middleware Control. These procedures also apply to Fusion Applications Control.

11.1 Introduction to Monitoring the Middle Tier

Both Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) and Oracle Enterprise Manager Cloud Control (Cloud Control) automatically and continuously measure run-time performance. The performance metrics are automatically enabled; you do not need to set options or perform any extra configuration to collect them.

You can monitor the following aspects of the middle tier with this control:

- Monitor the state and performance of the Oracle Fusion Applications products and applications and an Oracle Fusion Middleware targets by providing out-of-the-box performance metrics

- Monitor CPU usage, heap usage, Work Manager, JMS servers, and JDBC and JTA usage for Oracle WebLogic Server

- Monitor JVM performance in terms of heap versus non-heap usage, garbage collection, and threads performance

- Monitor applications and web services deployed to an Oracle WebLogic Server

- Monitor a wide range of application metrics for servlets, JSPs, and EJBs are available, as well as web services metrics for faults, invocations, and violations. Such metrics are accessible from a target's home page.

- Access customizable performance summary pages to help administrators monitor performance and diagnose problems. These charts can be modified to display content that is relevant to your domain. A target or component might be added to the chart so that you can compare the performance information for two targets in one chart.

You can also monitor a specific set of metrics for performance tuning information. With Cloud Control, you can also view historical data. See Section 11.5 for more specific information about usage of Cloud Control.

Use the following sections for specifics on using Fusion Applications Control:

- Section 11.2, "Monitoring and Viewing Performance Status of Oracle Fusion Middleware"

- Section 11.3, "Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product"

- Section 11.5, "Performing Proactive Performance Monitoring with Cloud Control"

Use the following sections for specifics on using Cloud Control:

- Section 11.2, "Monitoring and Viewing Performance Status of Oracle Fusion Middleware"

- Section 11.3, "Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product"

- Section 11.4, "Monitoring Performance for Key Oracle Fusion Middleware Components with Fusion Applications Control"

11.2 Monitoring and Viewing Performance Status of Oracle Fusion Middleware

Monitoring the health of the underlying Oracle Fusion Middleware environment and ensuring that it performs optimally is an important task.

This section contains the following topics:

- Section 11.2.1, "Viewing the General Status of Oracle Fusion Middleware Components for a Product Family"

- Section 11.2.2, "Viewing the Detailed Status of Oracle Fusion Middleware Components for a Product Family"

- Section 11.2.3, "Viewing the Routing Topology of Oracle Fusion Middleware"

- Section 11.2.4, "Viewing the Performance of an Oracle WebLogic Server"

- Section 11.2.5, "Monitoring the System Performance of Oracle Fusion Applications Deployed to a Cluster"

11.2.1 Viewing the General Status of Oracle Fusion Middleware Components for a Product Family

You can view the overall status of the underlying Oracle Fusion Middleware components from the home page of the product family.

To view the general status with either Fusion Applications Control or Cloud Control:

1. Navigate to a product family home page:

- From Fusion Applications Control, in the navigation pane, select the product family.

- From Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications List page displays.

2. In the table on the Fusion Applications List page, click the appropriate Product Family target.

2. View the Applications and Infrastructure section. The following figure shows an example of the tab from Fusion Applications Control.

The pie charts in the Fusion Middleware section displays the percentage of Oracle Fusion Middleware components that are currently up or down.

11.2.2 Viewing the Detailed Status of Oracle Fusion Middleware Components for a Product Family

You can view the detailed status of Oracle Fusion Applications and Oracle Fusion Middleware components, including the Administration Server and the Managed Servers in the Oracle WebLogic Server domain and specific Oracle Fusion Middleware components.

To view detailed status with Oracle Fusion Middleware components:

1. Navigate to a product family home page:

- From Fusion Applications Control, from the navigation pane, select the product family.

- From Cloud Control:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications List page displays.

2. In the table on the Fusion Applications List page, click the appropriate Product Family target.

2. From the Product Family menu, choose Applications and Infrastructure.

3. From the Applications and Infrastructure page, click the Fusion Middleware tab.
This tab shows the status of the various components, associated host, and the percentage of CPU that is being used the component. The following figure shows an example of the tab from Fusion Applications Control.

4. Select a specific component to gain more insight.
For example, if you select the Oracle WebLogic Server domain, Fusion Applications Control directs you to the domain home page. This page shows the following.

- A general summary of the domain, along with a link to the Oracle WebLogic Server Administration Console

- Information about the servers, both the Administration Server and the Managed Servers in the domain

- Information about the clusters in the domain

- Information about the deployments in the domain

11.2.3 Viewing the Routing Topology of Oracle Fusion Middleware

This section contains the following topics:

- Section 11.2.3.1, "Viewing the Routing Topology of Oracle Fusion Middleware Using Fusion Applications Control"

- Section 11.2.3.2, "Viewing the Routing Topology of Oracle Fusion Middleware Using Cloud Control"

11.2.3.1 Viewing the Routing Topology of Oracle Fusion Middleware Using Fusion Applications Control

Fusion Applications Control provides a Topology Viewer for the farm. The Topology Viewer is a graphical representation of routing relationships across components and elements of the farm. You can easily determine how requests are routed across components.

The Topology Viewer enables you to easily monitor your Oracle Fusion Applications environment. You can see which entities are up and which are down.

You can also print the topology or save it to a .png file.

To view the topology with Fusion Applications Control:

1. Click Topology.
The Topology Viewer is displayedis displayed on the right side of the window

2. To see information about a particular target, place your mouse over the target. To view additional information, click More. The following figure shows additional information for the LedgerApp target.

3. From the Options menu, you can save or print the image, expand or collapse all of the nodes, change the orientation of the topology to be left to right or top to bottom, or show and hide the routing navigator.
In addition, you can refresh the status and the metrics or update the topology. To refresh the status and metrics, click Refresh Target Status and Metrics. To update the topology shown in the viewer, click Recreate Topology. If a target has been added or deleted, the target list and relationships are updated. This option also updates the status and metrics.

4. With Topology Viewer, you can also:

- Search for a target within the topology. This makes it easier to find a target if you have many targets. Enter the name in the Find box. The target is highlighted and the topology is repositioned so you can see the target if it was not previously visible in the viewing area.
You can also specify criteria for the search. From Find, choose the one or more types of Status or one or more of Target Type, or both.

- View the targets by status. Choose Up, Down, or Unknown from the Target Status at the top of the page.

- Navigate to the home page of a target. Right-click the target, and choose Home.

- Hide or show the status or metrics. From the Annotations menu, choose Status or Metrics.
If you select Metrics, one key performance metric for the component is displayed. (You cannot change the metric that is displayed.)

- View the routing relationships between components.

- Perform operations directly on the target by right-clicking. The right-click target menu is displayed.

5. To change what is visible in the topology view, drag the shaded section in the navigator window, which is located in the bottom right.

Notes:

- If you use Mozilla Firefox, when you click an entity in Topology Viewer to take you back to the main Fusion Applications Control window, focus is not returned to the main window. For example, if you right-click an entity and choose logs from menu, the focus remains on the Topology Viewer window. (If you go back to the main window, the Logs page is correctly displayed.)
To workaround this problem, make the following change in Firefox:

From the Tools menu, choose Options, and then Content. Click Advanced. In the Advanced JavaScript Settings dialog box, select Raise and lower windows.

- If you use Internet Explorer, turn off the Always Open Popups in New Tab option.

11.2.3.2 Viewing the Routing Topology of Oracle Fusion Middleware Using Cloud Control

See Section 10.11.

11.2.4 Viewing the Performance of an Oracle WebLogic Server

This section describes how to monitor an Oracle WebLogic Server, discussing how to view the status of the following:

- Oracle WebLogic Server domains

- Oracle WebLogic Server Administration or Managed Servers

- Clusters

For information on locating specific metrics to monitor, see Section 11.4.4.1.

11.2.4.1 Monitoring an Oracle WebLogic Server Domain

You can view the status of a domain, including the servers, clusters, and deployments in the domain from the domain home page of Fusion Middleware Control:

1. From the navigation pane, expand the farm, then WebLogic Domain.

2. Select the domain.
The domain home page is displayed, as shown in the following figure:

This page shows the following:

- A general summary of the domain, along with a link to the Oracle WebLogic Server Administration Console

- Information about the servers, both the Administration Server and the Managed Servers, in the domain

- Information about the clusters in the domain

- Information about the deployments in the domain

- A Resource Center, which provides links to more information

11.2.4.2 Monitoring an Oracle WebLogic Server Administration or Managed Server

You can view the status of a WebLogic Server Administration Server or Managed Server in Fusion Middleware Control:

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the server.
The server home page is displayed.

The following figure shows the home page for a Managed Server:

This page shows the following:

- A general summary of the server, including its state, and information about the servlets, JSPs, and EJBs running in the server

- Response and load

- Information about the applications deployed to the server

11.2.4.3 Monitoring a Cluster

You can view the status of a cluster, including the servers and deployments in the cluster using Fusion Middleware Control:

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the cluster.
The cluster page is displayed, as shown in the following figure:

This page shows the following:

- A general summary of the cluster, including the broadcast channel, if appropriate, the load algorithm, and the messaging mode

- A response and load section, which shows the requests per minute and the request processing time

- A deployments section with information about the applications deployed to the cluster

- A server section, with a table listing the servers that are part of the cluster

11.2.5 Monitoring the System Performance of Oracle Fusion Applications Deployed to a Cluster

During installation, Oracle Fusion Applications automatically deploys each application to a Managed Server in a cluster. For each Managed Server in the cluster, there is an instance of the application on each Oracle WebLogic Server.

There are times when you want to monitor the system performance of the application on an individual server, and times when you want to monitor the overall performance of the application across all the servers in the cluster.

For example, normally, you would manage the overall performance of the application to determine if there are any performance issues affecting all users of the application, regardless of which instance users access. If you notice a performance problem, you can then drill down to a specific instance of the application to determine if the problem is affecting one or all of the application instances in the cluster. Cloud Control and Fusion Applications Control provides monitoring pages for both of these scenarios.

This section contains the following topics:

- Section 11.2.5.1, "Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Fusion Applications Control"

- Section 11.2.5.2, "Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Cloud Control"

- Section 11.2.5.1, "Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Fusion Applications Control"

- Section 11.2.5.3, "Monitoring the Performance of Oracle Fusion Application Instances Using Fusion Applications Control"

11.2.5.1 Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Fusion Applications Control

To monitor the overall performance of the Oracle Fusion Applications cluster applications with Fusion Applications Control:

1. From the navigation pane, expand the product family, then Fusion Applications.
Fusion Applications Control lists the applications deployed in the current domain, as shown in the following figure:

2. Monitor the overall performance of the applications on a cluster by clicking the cluster application name, for example, PayablesApp.
The Fusion Cluster Application page displays.

3. View performance metrics. From the Fusion Cluster Application menu, choose Performance Summary.
The Performance Summary page displays. For more information about using this page, see Section 2.5.7.

11.2.5.2 Monitoring the Performance of Oracle Fusion Applications Cluster Applications Using Cloud Control

To monitor the overall performance of the Oracle Fusion Applications cluster applications with Cloud Control:

1. Navigate to a product family home page:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications List page displays.

2. In the table on the Fusion Applications page, click the appropriate Product Family target.

2. From the navigation pane, expand Fusion Applications.
Cloud Control lists the applications deployed in the current domain, as shown in the following figure:

3. Monitor the overall performance of the applications on a cluster by clicking the cluster application name, for example, PayablesApp.
The Fusion Cluster Application page displays.

4. View performance metrics. From the Fusion Cluster Application menu, choose Monitoring > Performance Summary.
The Performance Summary page displays. For more information about using this page, see the topic "Using Performance Summary" in the Cloud Control online help.

5. From the Performance Summary page, you can optionally click on a metric name.
The Additional Information dialog displays. From this dialog, you can view more details about the metric with the following links:

- Problem Analysis: Directs to the Problem Analysis page. This page enables you to see a metric with other related metrics, which are affecting the metrics being analyzed. It also shows the related targets and the related targets topology. The Problem Analysis is only available for request-related metrics, such as the Request Processing Time (ms) and Request (per minute).

- Analyze Logs: Displays a message that enables you to view the logs for a target on which the metric is viewed.

- Metric Details: Enables you view historical metric data.

- Target Home: Directs you to the home page.

When used together, Problem Analysis and Analyze Logs can help you inspect metrics, target status information, and logs during troubleshooting. These links are not available for all metrics. For more information about these links, see the "Troubleshooting Using the Diagnostic Testing Framework" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

11.2.5.3 Monitoring the Performance of Oracle Fusion Application Instances Using Fusion Applications Control

To monitor a specific instance of the application with Fusion Applications Control:

1. From the navigation pane, expand the product family, then Fusion Applications.

2. Expand the cluster application you want to monitor to show each instance of the application, as shown in the following figure:

3. Monitor the overall performance of an application instance on a server by clicking one of the application deployment instances, for example, PayablesApp (PayablesSever_1).
The Fusion J2EE Application page displays.

4. View performance metrics. From the Fusion J2EE Application menu, choose Performance Summary.
The Performance Summary page displays. For more information about using this page, see Section 2.5.7.

11.2.5.4 Monitoring the Performance of Oracle Fusion Application Instances Using Cloud Control

To monitor a specific instance of the application with Cloud Control:

1. Navigate to a product family home page:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications List page displays.

2. In the table on the Fusion Applications List page, click the appropriate Product Family target.

2. From the navigation pane, expand the product family, then Fusion Applications.

3. Expand the cluster application you want to monitor to show each instance of the application, as shown in the following figure:

4. Monitor the overall performance of an application instance in cluster by clicking one of the application deployment instances, for example, PayablesApp (PayablesSever_1).
The Fusion J2EE Application page displays.

5. View performance metrics. From the Fusion J2EE Application menu, choose Performance Summary.
The Performance Summary page displays. For more information about using this page, see the topic "Using Performance Summary" in the Cloud Control online help.

6. From the Performance Summary page, you can optionally click on a metric name.
The Additional Information dialog displays. From this dialog, you can view more details about the metric with the following links:

- Problem Analysis: Directs to the Problem Analysis page. This page enables you to see a metric with other related metrics, which are affecting the metrics being analyzed. It also shows the related targets and the related targets topology. The Problem Analysis is only available for request-related metrics, such as the Request Processing Time (ms) and Request (per minute).

- Analyze Logs: Displays a message that enables you to view the logs for a target on which the metric is viewed.

- Metric Details: Enables you view historical metric data.

- Target Home: Directs you to the home page.

When used together, Problem Analysis and Analyze Logs can help you inspect metrics, target status information, and logs during troubleshooting. These links are not available for all metrics. For more information about these links, see the "Working with Cloud Control Problem Analysis and the Analyze Logs Options" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

11.3 Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product

If you encounter a problem, such as a product running slowly or hanging, you can view more detailed performance information, including aggregate system performance metrics for all the product families or an individual product family. You can also view metrics specific to a particular product, to find out more information about the problem. You can only view aggregate system performance metrics for all the product families with Cloud Control.

This section contains the following topics:

- Section 11.3.1, "Monitoring System Performance Metrics for a Product Family or a Product with Fusion Applications Control"

- Section 11.3.2, "Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product with Cloud Control"

11.3.1 Monitoring System Performance Metrics for a Product Family or a Product with Fusion Applications Control

With Fusion Applications Control, you can view detailed aggregate system performance metrics for the product family or view metrics specific to a particular product.

To view the performance metrics for the product family with Fusion Applications Control:

1. From the navigation pane, select the name of the product family.

2. From the Product Family menu, choose System Performance Summary.
The System Performance page displays. For more information about using this page, see Section 2.5.7.

To view the performance metrics for a particular product with Fusion Applications Control:

1. From the navigation pane, expand the product family, then Products.

2. Select the product you want to monitor.

3. From the Product menu, choose System Performance Summary.
The System Performance page displays. For more information about using this page, see Section 2.5.7.

11.3.2 Monitoring System Performance Metrics for a Fusion Instance, Product Family, or a Product with Cloud Control

With Cloud Control, you can view aggregate system performance metrics for all the product families by monitoring the Fusion instance or an individual product family. You can also view metrics specific to a particular product.

To view the performance metrics for the product family with Cloud Control:

1. Navigate to a Fusion Instance, product family, or product home page:

1. From the Targets menu, choose Fusion Applications.
The Fusion Applications List page displays.

2. In the table on the Fusion Applications List page, click the appropriate target, the instance for the Oracle Fusion Applications or product family. You can also expand a product family to select an individual product.

2. From the Fusion Instance, Product Family, or Product menu, choose Monitoring > System Performance.
The Performance Summary page displays. For more information about using this page, see the topic "Using Performance Summary" in the Cloud Control online help.

3. From the Performance Summary page, you can optionally click on a metric name.
The Additional Information dialog displays. From this dialog, you can view more details about the metric with the following links:

- Problem Analysis: Directs to the Problem Analysis page. This page enables you to see a metric with other related metrics, which are affecting the metrics being analyzed. It also shows the related targets and the related targets topology. The Problem Analysis is only available for request-related metrics, such as the Request Processing Time (ms) and Request (per minute).

- Analyze Logs: Displays a message that enables you to view the logs for a target on which the metric is viewed.

- Metric Details: Enables you view historical metric data.

- Target Home: Directs you to the home page.

When used together, Problem Analysis and Analyze Logs can help you inspect metrics, target status information, and logs during troubleshooting. These links are not available for all metrics. For more information about these links, see the "Working with Cloud Control Problem Analysis and the Analyze Logs Options" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

11.4 Monitoring Performance for Key Oracle Fusion Middleware Components with Fusion Applications Control

Monitoring Oracle Fusion Middleware performance involves monitoring any Oracle WebLogic Server Managed Servers for a component and as available, performance metrics. The Oracle Fusion Middleware layer of Oracle Fusion Applications automatically and continuously measures run-time performance for middle tier components. Use Table 11-1 to find information on where to find related documentation for the main Oracle Fusion Middleware components in most Oracle Fusion Applications environments. As mentioned previously in this chapter, references to Fusion Middleware Control in the Oracle Fusion Middleware documents apply to Fusion Applications Control.

Table 11-1 Monitoring Oracle Fusion Middleware Components

Component

Documentation

Oracle Business Intelligence Suite

Status of an Oracle WebLogic Server Managed Server for Oracle Business Intelligence Suite: Section 11.2.4.1

Performance metrics: "Monitoring Service Levels" section in the Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Enterprise Content Management Suite, Content Server

Status of an Oracle WebLogic Server Managed Server for Content Server: Section 11.2.4.2

Performance Metrics: "Viewing Performance Information Using Fusion Middleware Control" section in the Oracle Fusion Middleware Administering Oracle WebCenter Content

Oracle Enterprise Crawl and Search Framework

Performance metrics: Section 11.4.1

Oracle Enterprise Scheduler Service

Status of an Oracle WebLogic Server Managed Server for Oracle Enterprise Scheduler: Section 11.2.4.2

Performance metrics: Section 11.4.2.5 and Section 11.4.4.3

Oracle Identity Management, Oracle Access Manager

Status of an Oracle WebLogic Server Managed Server for Oracle Access Manager: Section 11.2.4.2

Performance metrics: "Viewing Performance in Fusion Middleware Control" section in the Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager with Oracle Security Token Service

Oracle Identity Management, Oracle Identity Manager

Status of an Oracle WebLogic Server Managed Server for Oracle Identity Management: Section 11.2.4.2

Performance metrics: Section 11.4.3

Oracle Identity Management, Oracle Internet Directory

Status of an Oracle WebLogic Server Managed Server for Oracle Identity Management: Section 11.2.4.2

Performance Metrics: "Monitoring Oracle Internet Directory" in the Oracle Fusion Middleware Administrator's Guide for Oracle Internet Directory

Oracle Identity Management, Oracle Virtual Directory

Status of an Oracle WebLogic Server Managed Server for Oracle Virtual Directory: Section 11.2.4.2

Performance Metrics: "Monitoring Oracle Virtual Directory Using Fusion Middleware Control Metrics" in the Oracle Fusion Middleware Administrator's Guide for Oracle Virtual Directory

Oracle SOA Suite

Performance metrics: "Monitoring Message Delivery Processing Requests" section in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite and Section 11.4.4.2

Oracle WebCenter Portal

Status of an Oracle WebLogic Server Managed Server for Oracle WebCenter Portal: Section 11.2.4.2

Performance metrics: "Monitoring Oracle WebCenter Portal Performance" section in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter Portal

Oracle Web Tier, Oracle HTTP Server

Performance metrics: "Monitoring Oracle HTTP Server Performance" section in the Oracle Fusion Middleware Administrator's Guide for Oracle HTTP Server

Oracle WebLogic Server

Section 11.2.4 and Section 11.4.4.1

The section contains the following topics:

- Section 11.4.1, "Monitoring Oracle Enterprise Crawl and Search Framework"

- Section 11.4.2, "Monitoring the Performance of a Single Oracle Enterprise Scheduler Instance"

- Section 11.4.3, "Monitoring Oracle Identity Manager Performance Metrics"

- Section 11.4.4, "Locating Key Performance Metrics for Specific Components"

11.4.1 Monitoring Oracle Enterprise Crawl and Search Framework

Fusion Applications Control automatically and continuously measures the runtime performance of Oracle Enterprise Crawl and Search Framework. If you encounter a problem, you can view the performance metrics to find out more information about the problem.

To monitor performance metrics for Oracle Enterprise Crawl and Search Framework with Fusion Applications Control:

1. From the navigation pane, expand Enterprise Crawl and Search Framework.

2. Select the Oracle Enterprise Crawl and Search Framework application for the product family.

3. From the Enterprise Crawl and Search Framework menu, choose Performance Summary to view detailed performance metrics.
The Performance Summary page displays. For more information about using this page, see Section 2.5.7.

11.4.2 Monitoring the Performance of a Single Oracle Enterprise Scheduler Instance

You can monitor the performance of an Oracle Enterprise Scheduler instance, specifically current and historical performance data, as well as a summary of all performance data. Performance data displays in a chart set, which you save, delete and reorder. Additionally, you can modify the time period for which performance data displays.

This section contains the following topics:

- Section 11.4.2.1, "Viewing a Summary of Oracle Enterprise Scheduler Activity"

- Section 11.4.2.2, "Viewing Current Oracle Enterprise Scheduler Activity"

- Section 11.4.2.4, "Viewing Historical Oracle Enterprise Scheduler Reports"

- Section 11.4.2.5, "Viewing Oracle Enterprise Scheduler Metrics"

- Section 11.4.2.6, "Managing Chart Sets"

- Section 11.4.2.7, "Selecting the Performance Time Period"

11.4.2.1 Viewing a Summary of Oracle Enterprise Scheduler Activity

The Oracle Enterprise Scheduler Performance Summary page displays current charts of job requests such as requests completed per hour, running requests, requests by processing time and requests by status.

To view a summary of Oracle Enterprise Scheduler activity:

1. From the Scheduling Service menu, choose Performance > Service Summary.
By default, this page displays job requests running during a selected time period in the following categories:

- Requests completed per hour

- Processing times, average, minimum and maximum

- Running requests and maximum running requests

- Requests over the past hour with the status SUCCESS, WARNING, ERROR or CANCEL.

You can change the metrics displayed on the Service Summary performance page. Click the Show Metric Palette button to display the metric palette for Oracle Enterprise Scheduler.

2. You can change the duration for which performance data display.

3. Optionally, you can change the display format of performance data on the page.
Choose View > Grid to remove the grid display format from the charts.

Click the Table View link to display the performance data in table format.

4. You can overlay an additional scheduler service over the current service performance metrics.

1. Choose Overlay > Another Scheduler Service.
In the Search and Select: Targets window, enter the name of the target and host server and click Go to search for the relevant service.

2. From the search results table, select the relevant service and click Select to choose the scheduler service to overlay.

5. Additionally, you can take any of the following actions.

- Save the chart set, as described in Section 11.4.2.6.1.

- Reorder the chart set, as described in Section 11.4.2.6.3.

- Revert to an old chart set, as described in Section 11.4.2.6.4.

- Delete a chart set, as described in Section 11.4.2.6.2.

11.4.2.2 Viewing Current Oracle Enterprise Scheduler Activity

The Oracle Enterprise Scheduler Current Activity page displays pending and running requests by user and application.

To view current Oracle Enterprise Scheduler activity:

1. From the Scheduling Service menu, choose Performance > Current Activity.

2. You can view pending and running requests by user or application, or workload by work assignment.
To view pending and running requests by user, choose View > Requests By User.

To view pending and running requests by application, choose View > Requests By Application.

To view workloads by work assignment, choose View > Workload By Work Assignment.

11.4.2.3 Creating or Editing a Work Assignment

A work assignment includes two primary components that define request processor constraints:

- Specialization rules: Define restrictions for job request processing on a request processor.

- Workshifts: Specify temporal windows for processing job requests and thus describe the schedule for when job requests can be processed on a request processor

This combination of work assignment controls, including specialization rules and workshifts gives you the ability to select the kinds of job requests to be processed and decide how to allocate the request processor resources. For example, you can define two workshifts: a day shift and a night shift to allocate processing for these periods. The day shift could have more resources allocated for a peak usage period while the night shift could provide a different mix for its resource allocation.

By default, no work assignments are bound to a request processor and the request processor processes any ready job request. The default behavior is similar to using a request processor with no specialization rules and a workshift of 24/7 duration, all configured threads are used and there are no limits on the number of asynchronous jobs.

Table 11-2 shows the properties that you can define for specialization rules.

Table 11-2 Specialization Properties Available for Specialization Rules

Specialization Property

Description

Application

Specifies the name of the application associated with a job request.

Product

Specifies the name of the product within an application.

Submitted By

Specifies a user who submitted a job request.

Job Definition

Specifies a specific job request name.

Request Category

Specifies labels defined by the system administrator allowing administrators to group job requests for specific needs. You can include multiple labels that are separated by a delimiting character.

The following operators can be used to join the conditions of a rule: AND, OR (both of type binary), CONTAINS and NOT (unary).

Example 11-1 shows sample specialization rules that can be used in a work assignment.

Example 11-1 Sample Specialization Rules

application = 'EssDemoApp' AND (definition = 'JobDefinition://mypackage/Job_essdemo1' OR definition = 'JobDefinition://mypackage/LongRunningJob')

requestCategory ='Priority'

user = 'sam'
(requestCategory ='LongRunning') AND NOT (definition = 'JobDefinition://mypackage/LongRunningJob')

If a job request is specialized to two different work assignments, either of those work assignments may process the job request depending on resource availability. Similarly, if the same work assignment is bound to two different servers, either server may process the job request. In fact, different stages of the same request may be processed on different servers, such as pre-processing on one server and job execution on another server.

Note that the requestCategory value can be several label terms separated by a comma. In this way you can specify labels that mimic the behavior of tags, with specializations based on combinations of labels.

For example, you could define the following labels:

Example 11-2 Request Category Labels That Combine Terms

",NODE1,CRITICAL,"
",NODE1,STANDARD,"
",NODE1,IMPORTANT,"

Assuming the preceding labels, you could write a requestCategory expression such as the following examples:

Example 11-3 requestCategory Expressions That Use Multiple Combined Labels

(requestCategory contains ',NODE1,') AND (requestCategory contains ',CRITICAL,')

(requestCategory contains ',STANDARD,') OR (requestCategory contains ',IMPORTANT,') OR (requestCategory contains ',CRITICAL,')

If you use commas to delimit terms, you must enclose every separate label term with the comma on both sides, as shown in Example 11-2. Your requestCategory expression must specify the full term including the commas, as shown in Example 11-3, to ensure that the expression doesn't select another term that contains the one you specify.

To create or edit a work assignment:

1. From the navigation pane, expand the Scheduling Services folder and select the Oracle Enterprise Scheduler application.

2. From the Scheduling Services menu, select Work Allocation and then select Work Assignments.
The Work Assignments page displays.

3. Click the Create or Edit buttons to create or edit a work assignment.
The Create Work Assignment page displays.

4. Enter a name and description for the work assignment in the relevant text fields.

5. Select the Enabled check box to enable the work assignment.

6. Click Create Specialization to add conditions under which the work assignment runs.

7. In the Workshifts section, click the Add icon to add one or more workshifts to the work assignment.

8. Click OK to save the work assignment.

11.4.2.4 Viewing Historical Oracle Enterprise Scheduler Reports

The Oracle Enterprise Scheduler Historical Reports page displays completed job requests by user, application and work assignment.

To view historical Oracle Enterprise Scheduler reports:

1. From the Scheduling Service menu, choose Performance > Historical Reports.

2. From the View list, choose one of the following report views:

- Completed Request Statistics By Job Name

- Completed Request Statistics By User

- Request Metrics By Work Assignment

- Completed Request Statistics

3. Adjust the filter criteria as required. The filter criteria vary depending on the report view you choose.

Table 11-3 Completed Request Statistics by Job Name

Filter Criterion

What to Do...

Application

From the list, choose the application whose statistics you want to view.

Minimum Run Time

Enter the shortest run time period for jobs whose statistics you want to view. Use the text field to enter a number, and select a unit of time from the list: Seconds, Minutes, Hours or Days.

Completed between

Use the calendar icons on either side of the text fields to select a start and end date and time.

Table 11-4 Completed Request Statistics by User

Filter Criterion

What to Do...

Application

From the list, choose the application whose statistics you want to view.

Minimum Total Run Time

Enter the shortest total time period for jobs whose statistics you want to view. Use the text field to enter a number, and select a unit of time from the list: Seconds, Minutes, Hours or Days.

Completed between

Use the calendar icons on either side of the text fields to select a start and end date and time.

Table 11-5 Request Metrics By Work Assignment

Filter Criterion

What to Do...

Application

From the list, choose the application whose statistics you want to view.

Completed after

Use the calendar icon to choose the date and time after which the work assignment has completed.

Table 11-6 Completed Request Statistics

Filter Criterion

What to Do...

Application

From the list, choose the application whose statistics you want to view.

Completed between

Use the calendar icons on either side of the text fields to choose a start and end date and time.

4. Click Go to search for and display the historical data.

11.4.2.5 Viewing Oracle Enterprise Scheduler Metrics

You can view performance metrics for specific components of Oracle Enterprise Scheduler. Each set of metrics displays performance data that is relevant to the component.

To view Oracle Enterprise Scheduler performance metrics:

1. From the Scheduling Service menu, choose Performance > Service Summary.

2. Click Key Performance Indicators.

3. Click Show Metric Palette and select the metrics you want to display for each component.

11.4.2.6 Managing Chart Sets

You can save or delete the chart set displayed in the Oracle Enterprise Scheduler Performance Summary page. You can also re-organize the order of a chart and revert to an old chart set.

This section contains the following topics:

- Section 11.4.2.6.1, "Saving a Chart Set"

- Section 11.4.2.6.2, "Deleting a Chart Set"

- Section 11.4.2.6.3, "Reordering Charts"

- Section 11.4.2.6.4, "Reverting to an Old Chart Set"

11.4.2.6.1 Saving a Chart Set

You can save the chart set displayed in the Oracle Enterprise Scheduler Performance Summary page. Saving a chart set allows preserving a specific set of metrics selected for display, as opposed to the default metrics.

To save a chart set:

1. Display the Oracle Enterprise Scheduler Performance Summary page.

2. Choose View > Save Chart Set.

3. In the Save Chart Set dialog box, enter a name for the chart set and click OK.

4. When you have saved the chart set, you can display it by choosing Chart Set > My Chart Set.

11.4.2.6.2 Deleting a Chart Set

You can delete saved chart set files created in the Oracle Enterprise Scheduler Performance Summary page.

To delete a chart set:

1. Display the Oracle Enterprise Scheduler Performance Summary page.

2. Choose View > Delete Chart Sets.

3. In the Delete Chart Sets dialog box, select the name of the chart set to be deleted and click OK.

11.4.2.6.3 Reordering Charts

You can organize the display of performance charts in the Oracle Enterprise Scheduler Performance Summary page. Charts can be moved up or down, or removed entirely.

To reorder chart sets:

1. Display the Oracle Enterprise Scheduler Performance Summary page.

2. Choose View > Reorder Charts.

3. In the Reorder Charts popup window, select the chart you want to move and click Move Up or Move Down, respectively.
To delete a chart from the Performance Summary page, select the chart and click Delete.

4. Click OK.

11.4.2.6.4 Reverting to an Old Chart Set

If you have re-organized your chart sets, you can can revert to the chart set as you had originally saved it.

To revert chart sets:

1. Display the Oracle Enterprise Scheduler Performance Summary page.

2. From the Chart Set list, choose the chart you want to revert to its original display.

3. Choose View > Revert Chart Set.

11.4.2.7 Selecting the Performance Time Period

In the Oracle Enterprise Scheduler Performance Summary page, you can change the time period for which the performance summary displays.

To select the performance time period:

1. Display the Oracle Enterprise Scheduler Performance Summary page.

2. Change the duration for which job requests display.

- All: Click to display all job requests within a specified, finite period.

- 2 hours: Click to display all job requests within the past two hours.

- 15 minutes: Click to display all job requests within the past fifteen minutes.

- Slider: Click to display a slider that enables scrolling horizontally to show job requests from a specified period. The slider defaults to whichever time segment is selected, all, 2 hours, or 15 minutes.

- Calendar: Click the calendar icon to select a time period for which you want to display job requests.

11.4.3 Monitoring Oracle Identity Manager Performance Metrics

To monitor performance metrics for Oracle Identity Manager with Fusion Applications Control:

1. From the navigation pane, expand Identity and Access and OIM.

2. Select the Oracle Identity Management server.

3. From the Oracle Identity Management home page, view the overall metrics.

4. From the Oracle Identity Manager menu, choose Performance Summary to view detailed performance metrics.
The Performance Summary page displays. For more information about using this page, see Section 2.5.7.

11.4.4 Locating Key Performance Metrics for Specific Components

For each component in the Oracle Fusion Applications environment, there are performance metrics. This section helps you locate the key performance metrics related to software monitoring and configuration.

This section contains the following topics:

- Section 11.4.4.1, "Monitoring Key Performance Metrics for Oracle WebLogic Server"

- Section 11.4.4.2, "Monitoring Key Performance Metrics for Oracle SOA Suite"

- Section 11.4.4.3, "Monitoring Key Performance Metrics for Oracle Enterprise Scheduler"

11.4.4.1 Monitoring Key Performance Metrics for Oracle WebLogic Server

Use Table 11-7 to locate the key performance metrics for Oracle WebLogic Server.

Table 11-7 Oracle WebLogic Server Key Performance Metrics

Category

Metric Name

Location in Fusion Applications Control

JMS

Messages Pending

Messages Received

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose Performance Summary.

4. From the Performance Summary page, click Show Metric Palette.

5. From the Metric Palette, expand the JMS Server Metrics folder.

6. Select the metrics to view the charts.

JDBC

Available Connections

Connection Leaks (per minute)

Connection Pool Size

Connection Requests (per minute)

Connections Requests Waiting

Connections in Use

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose Performance Summary.

4. From the Performance Summary page, click Show Metric Palette.

5. From the Metric Palette, expand the Datasource Metrics folder.

6. Select the metrics view the charts.

JVM Memory

Heap Usage (MB)

Non Heap Usage (MB)

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose JVM Performance.

4. In the Memory section, view the charts.

JVM Garbage Collections

Collections (per minute)

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose JVM Performance.

4. In the Memory section, view the Collections (per minute) in the Garbage Collectors table.

Heap Usage (%)

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose Performance Summary.

4. From the Performance Summary page, click Show Metric Palette.

5. From the Metric Palette, expand the JVM Metrics folder.

6. Select the metric to view the chart.

Oracle WebLogic Server

CPU Usage (%)

Active Threads

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose Performance Summary.

4. From the Performance Summary page, click Show Metric Palette.

5. From the Metric Palette, expand the JVM Metrics folder.

6. Select the metric to view the chart.

Deadlocked Threads

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose Performance Summary.

4. From the Performance Summary page, click Show Metric Palette.

5. From the Metric Palette, expand the JVM Threads folder.

6. Select the metric to view the chart.

Threads

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose JVM Performance.

4. View the thread metrics in the Threads section.

Server Work Manager

Work Manager Pending Requests

Work Manager Requests (per minute)

Work Manager Stuck Threads

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain.

2. Select the Managed Server.
The Managed Server home page displays.

3. From the WebLogic Server menu, choose Performance Summary.

4. From the Performance Summary page, click Show Metric Palette.

5. From the Metric Palette, expand the Work Manager folder.

6. Select the metrics to view the charts.

11.4.4.2 Monitoring Key Performance Metrics for Oracle SOA Suite

Use Table 11-8 to locate the key performance metrics for Oracle SOA Suite.

Table 11-8 Oracle SOA Suite Key Performance Metrics

Metric Name

Location in Fusion Applications Control

Audit Trail Threshold (for BPEL)

1. From the navigation pane, select soa-infra.

2. From the SOA Infrastructure menu, choose SOA Administration > BPEL Properties.

3. From the BPEL Service Engine Properties page, view the Audit Trail Threshold.

From the BPEL Service Engine Properties page, adjust the Audit Trail Threshold to bolster BPEL engine performance and avoid performance overheads of capturing audit information. From the Audit Level list, you can also level of information collected by the instance tracking infrastructure.

Composite-level rate metrics

1. From the navigation pane, select soa-infra.

2. Expand the partitions.

3. Select a specific SOA composite application.

4. From the SOA Composite menu, choose Monitoring > Performance Summary.

5. From the BPEL Service Engine Properties page, view the Audit Trail Threshold.

Dispatcher System Threads

Dispatcher Invoke Threads

Dispatcher Engine Threads (for BPEL)

1. From the navigation pane, select soa-infra.

2. From the SOA Infrastructure menu, choose SOA Administration > BPEL Properties.

3. From the BPEL Service Engine Properties page, view the settings for Dispatcher System Threads, Dispatcher Invoke Threads, and Dispatcher Engine Threads.

Adjust these thresholds when the response-time is high.

Tune the thread configuration to either increase or decrease the number depending upon the BPEL engine processing requirement.

Average Request Processing Time (synchronous requests)

Average Request processing time (asynchronous requests)

1. From the navigation pane, select soa-infra.

2. From the SOA Infrastructure menu, choose Monitoring > Request Processing.

3. From the Request Processing page, in the Service Engines and Service Infrastructure sections, view the Average Request Processing Time - Synchronous Requests and the Average Request Processing Time - Asynchronous Requests columns.

Audit trail

1. From the navigation pane, select soa-infra.

2. Expand the partitions.

3. Select a specific SOA composite application.

4. In the Oracle SOA Composite page, in the Recent Instances section, select an instance.

5. In the Flow Trace window, select a component instance in the Trace section.
The audit trail for the instance displays.

State (for a BPEL instance)

1. From the navigation pane, select soa-infra.

2. Expand the partitions.

3. Select a specific SOA composite application.

4. In the Oracle SOA Composite page, in the Component Metrics section, select a BPEL instance.

5. In the BPEL Component page, in the Recent Instances table, view the State column.

State (for an Oracle Mediator instance)

1. From the navigation pane, select soa-infra.

2. Expand the partitions.

3. Select a specific SOA composite application.

4. In the Oracle SOA Composite page, in the Component Metrics section, select an Oracle Mediator instance.

5. In the Mediator Component page, in the Recent Instances table, view the State column.

11.4.4.3 Monitoring Key Performance Metrics for Oracle Enterprise Scheduler

Use Table 11-9 to locate the key performance metrics for Oracle Enterprise Scheduler.

Table 11-9 Oracle Enterprise Scheduler Key Performance Metrics

Metric Name

Location in Fusion Applications Control

Number of active processor threads for each instance

1. From the navigation pane, expand Scheduling Services.

2. Select the Oracle Enterprise Scheduler component.

3. From the Scheduling Service menu, choose Performance > Current Activity.

4. From the View list, choose Workload by Work Assignment.

5. In the work assignments with active workshift report, view the Thread Allocation columns.

Processing Time (for jobs)

Wait Time

1. From the navigation pane, expand Scheduling Services.

2. Select the Oracle Enterprise Scheduler component.

3. From the Scheduling Service menu, choose Performance > Historical Reports.

4. In the Historical Reports page, from the View list, choose Request Metrics By Work Assignment.

5. In the Results section, view the Wait Time and Processing Time columns.

Job running time

1. From the navigation pane, expand Scheduling Services.

2. Select the Oracle Enterprise Scheduler component.

3. From the Scheduling Service home page, in the Top 10 Long Running Request tab, select a job.

4. In the Request Detail page, under Execution Trail, view the Run Time metric.

11.5 Performing Proactive Performance Monitoring with Cloud Control

Managing applications and the underlying middleware technology can be difficult and IT organizations often have to rely on a variety of specialized tools. This can lead to inefficiency and may introduce complexities and risks.

Cloud Control enables you to discover middleware targets. To access these pages, see the following topic:

- Section 11.5.1, "Monitoring Middle Tier Targets"

In addition to drilling down to specific targets for performance metrics, Oracle recommends the following best practices:

- Section 11.5.2, "Creating Monitoring Templates"

- Section 11.5.3, "Creating Blackouts"

- Section 11.5.4, "Setting Up Notifications"

11.5.1 Monitoring Middle Tier Targets

After you have added a middle tier target through discovery, you can view general information about the targets, including their status and availability on the Middleware page. You can select a specific type of target, such as Oracle WebLogic Server domain, to narrow the view. You then can drill down into each target to get further details like how the target is performing, where it is deployed, the version, location of its home directory, and so on.

You can also view the number of critical, warning, and error alerts generated for the past 24 hours. These alerts indicate that a particular metric condition has been encountered. For example, an alert is triggered when a metric threshold is reached. Using these details, you can drill down to investigate the target and the problem that triggered the alert.

Figure 11-1 Middleware Target Home Page of Cloud Control

To access the Middleware target home page in Cloud Control:

1. From the Targets menu, choose Middleware.

2. From the Search area, click Advanced Search.

3. From the Type list, choose a specific target type to monitor, and then click Search. In Figure 11-1, the target selected is Oracle WebLogic Domain.

For more information about discovering and monitoring middleware targets, see the chapters in the "Managing Oracle Fusion Middleware" part in the Oracle Enterprise Manager Getting with Fusion Middleware Management.

11.5.2 Creating Monitoring Templates

Monitoring templates simplify the task of setting up monitoring for large numbers of targets by allowing you to specify the monitoring and policy settings once and applying them as often as needed. You can save, edit, and apply these templates across one or more targets or groups. A monitoring template is specified for a particular target type and can only be applied to targets of the same type. For example, you can configure a monitoring template for Oracle WebLogic Server domains.

To create a monitoring template from Cloud Control:

1. From the Enterprise menu, choose Monitoring > Monitoring Templates to access the Monitoring Templates main page.

2. Modify a pre-built monitoring template, or create a new template without any data from another template:
To modify a pre-build monitoring template:

1. In the Template Name field, enter Fusion Apps or FMW.

2. Click option Display Oracle provided templates and Oracle Certified templates.

3. Click Go.

4. From the table, select the template, and click Edit.

To create a new template, click Create.

3. Fill out the tabs accordingly.
In the Metric Threshold tab, select the metrics to add to the template. Use the following tables in the Oracle Fusion Applications Performance and Tuning Guide for tips on recommended metrics to add to the template:

- Host Metrics

- Oracle Enterprise Scheduler Metrics

- Oracle HTTP Metrics

- Oracle Identity Manager Metrics

- Oracle Internet Directory Metrics

- Oracle SOA Composite Metrics

- Oracle SOA Infrastructure Metrics

- Oracle WebLogic Server Metrics

11.5.3 Creating Blackouts

Blackouts allow you to suspend collection of metrics on a target when performing scheduled maintenance on the target. Blacking out a target suspends monitoring on the target for the duration of the blackout. Blackouts are named entities that mainly consist of a list of targets that participate in the blackout and the schedule that defines when the blackout is in effect. Blackouts may be defined on a single target or on aggregate targets such as groups, hosts, systems, or web applications.

To create a blackout from Cloud Control:

1. From the Enterprise menu, choose Monitoring > Blackouts to access the Blackouts main page.

2. From the table, click Create.
Cloud Control displays a wizard page to guide you through the steps required to create a blackout. Click Help from any wizard page for more information on specific steps.

11.5.4 Setting Up Notifications

You can associate corrective actions with metrics whose alerts trigger them.

To register corrective actions for these notifications from Cloud Control. From the Setup menu, choose Notifications > Notification Methods access the Notifications Methods page.

See the "Notifications" chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide to complete the configuration.

11.6 Tuning Middle Tiers for Oracle Fusion Applications

One of the most challenging aspects of performance tuning is knowing where to begin. Start with the following documentation resources:

- Oracle Fusion Applications Performance and Tuning Guide

- Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework

- "Managing Log Files and Diagnostic Data" in the Oracle Fusion Middleware Administrator's Guide

12 Monitoring and Tuning Oracle Database for Oracle Fusion Applications

This chapter describes how to monitor, diagnose, tune, and test changes to Oracle Database using Oracle Enterprise Manager Database Control. Oracle Database provides several tools that enable you to monitor performance, diagnose and tune problems, and test database changes on a test system before implementing them to a production system. Most of these tools are accessible using Oracle Enterprise Manager Database Control.

This chapter includes the following sections:

- Section 12.1, "Monitoring Oracle Database"

- Section 12.2, "Tuning Oracle Database"

- Section 12.3, "Testing Oracle Database Changes"

12.1 Monitoring Oracle Database

Instructions for how to monitor Oracle Database using Database Control is provided in the following topics:

- Section 12.1.1, "Database Statistics"

- Section 12.1.2, "Monitoring Database Alerts"

- Section 12.1.3, "Monitoring User and Session Activity"

- Section 12.1.4, "Monitoring the Database Instance"

- Section 12.1.5, "Monitoring the Host System"

12.1.1 Database Statistics

Database statistics provide information about the type of load on the database and the internal and external resources used by the database. To accurately diagnose performance problems with the database using Automatic Database Diagnostic Monitor (ADDM), statistics must be available.

Oracle Database generates many types of cumulative statistics for the system, sessions, and individual SQL statements. Oracle Database also tracks cumulative statistics about segments and services. Automatic Workload Repository (AWR) automates database statistics gathering by collecting, processing, and maintaining performance statistics for database problem detection and self-tuning purposes.

By default, the database gathers statistics every hour and creates an AWR snapshot, which is a set of data for a specific time that is used for performance comparisons. The delta values captured by the snapshot represent the changes for each statistic over the time period. Statistics gathered by AWR are queried from memory. The gathered data can be displayed in both reports and views.

The database statistics collected and processed by AWR include:

- Time model statistics
Time model statistics measure the time spent in the database by operation type. The most important time model statistic is database time (DB time). Database time represents the total time spent in database calls by foreground sessions, and is an indicator of the total instance workload.

- Wait event statistics
Wait events are incremented by a session to indicate that the session had to wait for an event to complete before being able to continue processing. When a session has to wait while processing a user request, the database records the wait by using one of a set of predefined wait events. The events are then grouped into wait classes.

- Session and system statistics
A large number of cumulative database statistics are available on a system and session level. Some of these statistics are collected by AWR.

- Active session history statistics
The Active Session History (ASH) statistics are samples of session activity in the database. The database samples active sessions every second and stores them in a circular buffer in the System Global Area (SGA). Any session that is connected to the database and using CPU, or is waiting for an event that does not belong to the idle wait class, is considered an active session.

- High-load SQL statistics
SQL statements that are consuming the most resources produce the highest load on the system, based on criteria such as elapsed time and CPU time.

For more information about database statistics, see the "Gathering Database Statistics Using the Automatic Workload Repository" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.1.2 Monitoring Database Alerts

Oracle Database includes a built-in alerts infrastructure to notify you of impending problems with the database. By default, Oracle Database enables the following alerts:

- Tablespace Usage

- Snapshot Too Old

- Recovery Area Low on Free Space

- Resumable Session Suspended

In addition to these default alerts, you can use performance alerts to detect any unusual changes in database performance.

This section contains the following topics:

- Section 12.1.2.1, "Configuring Database Alerts"

- Section 12.1.2.2, "Responding to Database Alerts"

For more information about database alerts, see the "Monitoring Performance Alerts" chapter in the Oracle Database 2 Day + Performance Tuning Guide.

12.1.2.1 Configuring Database Alerts

A metric is the rate of change in a cumulative statistic. This rate can be measured against a variety of units, including time, transactions, or database calls. For example, the number of database calls per second is a metric. You can set thresholds on a metric so that an alert is generated when the threshold is passed.

Performance alerts are based on metrics that are performance-related. These alerts are either environment-dependent or application-dependent.

Environment-dependent performance alerts may not be relevant on all systems. For example, the AVERAGE_FILE_READ_TIME metric generates an alert when the average time to read a file exceeds the metric threshold.

Application-dependent performance alerts are typically relevant on all systems. For example, the BLOCKED_USERS metric generates a performance alert when the number of users blocked by a particular session exceeds the metric threshold.

To obtain the most relevant information from performance alerts, set the threshold values of performance metrics to values that represent desirable boundaries for your system. You can then fine-tune these values over time until your system meets or exceeds your performance goals.

To set thresholds for alerts, use the Metric and Policy Settings page, accessible from Related Links on the Database Home page.

12.1.2.2 Responding to Database Alerts

When an alert is generated by Oracle Database, it appears under Alerts on the Database Home page.

To respond to a database alert, locate the alert that you want to investigate under Alerts on the Database Home page and click the Message link. Follow the recommendations provided on the page.

After taking the necessary corrective measures, you can acknowledge an alert by clearing or purging it. Clearing an alert sends the alert to the Alert History, which can be viewed from the Database Home page under Related Links. Purging an alert removes it from the Alert History.

12.1.3 Monitoring User and Session Activity

The Database Performance page displays information in three sections that enable you to assess the overall performance of the database in real time.

The Average Active Sessions chart of the Performance page shows the average load on the database. The average active sessions for a time period equals the total DB time of all sessions during this period divided by the elapsed time (wall clock time) for this period. The chart shows which active sessions are running on the CPU or waiting on an event.

The wait classes show how much database activity is consumed by waiting for a resource such as disk I/O. Values that use a larger block of active sessions represent bottlenecks caused by a particular wait class, as indicated by the corresponding color in the legend. To identify each wait class, move your cursor over the block in the Average Active Sessions chart corresponding to the class.

Click the block of color on the chart or its corresponding wait class in the legend to drill down to the wait class. The Active Sessions Working page for the wait class appears. From this page, you can view the details of wait classes in the following dimensions:

- Top SQL
On the Active Sessions Working page, the Top Working SQL table shows the database activity for actively running SQL statements that are consuming CPU resources. If one or several SQL statements are consuming most of the activity, then you should investigate them.

- Top sessions
On the Active Sessions Working page, the Top Working Sessions table displays the top sessions waiting for the corresponding wait class during the selected time period.

A session is a logical entity in the database instance memory that represents the state of a current user login to the database. A session lasts from the time a user logs in to the database until the user disconnects. If a single session is consuming the majority of database activity, then you should investigate it.

- Top services
The Top Services table displays the top services waiting for the corresponding wait event during the selected time period.

A service is a group of applications with common attributes, service-level thresholds, and priorities. If a service is using the majority of the wait time, then you should investigate it.

- Top modules
The Top Modules table displays the top modules waiting for the corresponding wait event during the selected time period.

Modules represent the applications that set the service name as part of the workload definition. If a single module is using the majority of the wait time, then it should be investigated.

- Top actions
The Top Actions table displays the top actions waiting for the corresponding wait event during the selected time period.

Actions represent the jobs that are performed by a module. If a single action is using the majority of the wait time, then you should investigate it.

- Top clients
The Top Clients table displays the top clients waiting for the corresponding wait event during the selected time period. A client can be a Web browser or any client process that initiates requests for an operation to be performed by the database. If a single client is using the majority of the wait time, then you should investigate it.

- Top PL/SQL
The Top PL/SQL table displays the top PL/SQL subprograms waiting for the corresponding wait event during the selected time period. If a single PL/SQL subprogram is using the majority of the wait time, then you should investigate it.

- Top files
The Top Files table displays the average wait time for specific files during the selected time period. This data is available from the Active Sessions Waiting: User I/O page.

- Top objects
The Top Objects table displays the top database objects waiting for the corresponding wait event during the selected time period. This data is available from the Active Sessions Waiting: User I/O page.

For more information about monitoring user and session activity, see the "Monitoring User Activity" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.1.4 Monitoring the Database Instance

In the Average Active Sessions section of the Performance page, you can use the instance charts to monitor database instance activity in the following dimensions:

- Throughput
Database throughput measures the amount of work the database performs in a unit of time. The Throughput charts show any contention that appears in the Average Active Sessions chart. The Throughput charts on the Performance page display:

- Number of logons, transactions, physical reads, and redo size per second

- Number of physical reads and redo size per transaction

Compare the peaks on the Throughput charts with the peaks on the Average Active Sessions chart. If the Average Active Sessions chart displays a large number of sessions waiting, indicating internal contention, and throughput is low, then consider tuning the database.

- I/O
The I/O charts show I/O statistics collected from all database clients. The I/O wait time for a database process represents the amount of time that the process could have been doing useful work if a pending I/O had completed. Oracle Database captures the I/O wait times for all important I/O components in a uniform fashion so that every I/O wait by any Oracle process can be derived from the I/O statistics.

The Latency for Synchronous Single Block Reads chart shows the total perceived I/O latency for a block read, which is the time difference between when an I/O request is submitted and when the first byte of the transfer arrives. Most systems are performing satisfactorily if latency is fewer than 10 milliseconds.

You can also monitor I/O by function, type, and consumer groups using the various charts provided.

- Parallel executions
The Parallel Execution charts show system metrics related to parallel queries. Metrics are statistical counts per unit. The unit could be a time measure, such as seconds, or per transaction, or session.

A parallel query divides the work of executing a SQL statement across multiple processes. The charts show parallel queries that were waiting for a particular wait event that accounted for the highest percentages of sampled session activity.

- Services
The Services charts show services waiting for the corresponding wait event during the time period shown. Services represent groups of applications with common attributes, service-level thresholds, and priorities. Only active services are shown.

For more information about monitoring the database instance, see the "Monitoring Instance Activity" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.1.5 Monitoring the Host System

The Host chart on the Performance page displays utilization information about the system hosting the database.

Using the Host chart, you can view CPU, memory, and disk utilization for the host system. To determine if the host system has enough resources available to run the database, establish appropriate expectations for the amount of CPU, memory, and disk resources that your system should be using. You can then verify that the database is not consuming too many of these resources.

For more information about monitoring the host system, see the "Monitoring Host Activity" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.2 Tuning Oracle Database

Performance tuning is an iterative process. Removing the first bottleneck (a point where resource contention is highest) may not lead to performance improvement immediately because another bottleneck might be revealed that has an even greater performance impact on the system.

Oracle Database provides several tools that enable you to diagnose and tune performance problems. Automatic Database Diagnostic Monitor (ADDM) analyzes statistics to provide automatic diagnosis of major performance problems. You can also perform your own analysis using statistics from AWR and ASH reports, wait events, and SQL trace files to identify other bottlenecks in the database.

Instructions for diagnosing and tuning performance problems are provided in the following sections:

- Section 12.2.1, "Creating a Baseline of the Database"

- Section 12.2.2, "Diagnosing and Tuning Database Performance Problems Using ADDM"

- Section 12.2.3, "Diagnosing and Tuning Database Performance Problems Reactively"

- Section 12.2.4, "Tuning SQL Statements"

12.2.1 Creating a Baseline of the Database

Before you can tune your database, you need to have an established performance baseline that can be used for comparison if a performance problem arises. Oracle Database automatically maintains a system-defined moving window baseline that contains all AWR data within the AWR retention period, which by default is 8 days. Using Database Control, you can also create your own baseline by specifying and preserving a pair or a range of snapshots as a baseline. The snapshots contained in a baseline are excluded from the automatic AWR purging process and are retained indefinitely.

Before creating a baseline, carefully consider the time period you choose as a baseline because it should represent the database operating at an optimal level. In the future, you can compare these baselines with other baselines or snapshots to compare performance. You can create a single baseline captured at a single, fixed time interval, or a repeating baseline that repeats during a time interval over a specific period.

To create a baseline of the database, use the AWR Baselines page in Database Control, accessible from the Statistics Management section of the Server tab.

For more information about creating a baseline of the database, see the "Managing Baselines" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.2 Diagnosing and Tuning Database Performance Problems Using ADDM

Automatic Database Diagnostic Monitor (ADDM) is self-diagnostic software built into Oracle Database. ADDM examines and analyzes data captured in the AWR to identify possible database performance problems.

An ADDM analysis is performed after each AWR snapshot (every hour by default), and the results are saved in the database. The results of ADDM analysis are displayed as ADDM findings under Diagnostic Summary on the Database Home page in Oracle Database Control.

Each ADDM finding belongs to one of three types: problem, symptom, and information. Each problem finding is quantified with an estimate of the portion of DB time that resulted from the performance problem. When a specific problem has multiple causes, ADDM may report multiple findings. In this case, the impacts of these multiple findings can contain the same portion of DB time.

A problem finding can be associated with a list of recommendations for reducing the impact of a performance problem. Each recommendation has a benefit that is an estimate of the portion of DB time that can be saved if the recommendation is implemented. When multiple recommendations are associated with an ADDM finding, the recommendations may contain alternatives for solving the same problem. If this is the case, then choose the easiest solution to implement that yields the greatest benefit.

Recommendations are composed of actions and rationales. You must apply all the actions of a recommendation to gain its estimated benefit. The rationales explain why the set of actions was recommended, and provide additional information for implementing them.

You should review ADDM findings and implement the recommendations as part of regular database maintenance. Even when the database is operating at an optimal performance level, you should continue to use ADDM to monitor database performance on an ongoing basis.

For more information about using ADDM, see the "Automatic Database Performance Monitoring" chapter in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.3 Diagnosing and Tuning Database Performance Problems Reactively

While ADDM enables you to proactively diagnose database performance problems when they happen, there may be times when you want to identify database performance problems reactively. For example, you may want to compare database performance over time, or analyze a very short duration for short-lived performance problems. You may also want to examine wait events to determine if user response time can be improved by reducing the time that is spent waiting by server processes.

Oracle Database provides various tools, aside from ADDM, to enable you to diagnose and tune database performance problems reactively. The instructions are provided in the following topics:

- Section 12.2.3.1, "Comparing Database Performance Over Time Using AWR Reports"

- Section 12.2.3.2, "Identifying Transient Performance Problems Using ASH Reports"

- Section 12.2.3.3, "Identifying Wait Time Using Wait Events"

12.2.3.1 Comparing Database Performance Over Time Using AWR Reports

Performance degradation of the database occurs when your database was performing optimally in the past, such as 6 months ago, but has gradually degraded to a point where it becomes noticeable to the users. The Automatic Workload Repository (AWR) Compare Periods report enables you to compare database performance between two periods of time to identify any performance degradation that may have occurred over time.

The AWR Compare Periods report compares a new baseline or a pair of snapshots to an existing baseline. Before generating this report, you should have an existing baseline that represents the system operating at an optimal level, as described in "Creating a Baseline of the Database". If an existing baseline is unavailable, you can use this report to compare two periods of time using two pairs of snapshots. To generate the AWR Compare Periods report, use the Automatic Workload Repository page in Database Control, accessible from the Database Server page.

For more information about generating AWR Compare Periods reports, see the "Running the AWR Compare Periods Reports" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.3.2 Identifying Transient Performance Problems Using ASH Reports

ADDM tries to report the most significant performance problems during an analysis period in terms of their impact on DB time. If a particular problem lasts for a very short duration, then its severity might be averaged out or minimized by other performance problems in the analysis period. Therefore, the problem may not appear in the ADDM findings. Whether a performance problem is captured by ADDM depends on its duration compared to the interval between the AWR snapshots.

To capture a detailed history of database activity, Oracle Database samples active sessions each second with the Active Session History (ASH) sampler. ASH gathers sampled data at the session level rather than at the instance level. By capturing statistics for only active sessions, the size of the sampled data is directly related to the work being performed.

To generate the ASH report, under Average Active Sessions on the Database Performance page, click Run ASH Report.

For more information about generating ASH reports, see the "Running Active Session History Reports" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.3.3 Identifying Wait Time Using Wait Events

Wait events are statistics that are incremented by a server process or thread to indicate that it had to wait for an event to complete before being able to continue processing. Whenever an Oracle Database process waits for something, it records the wait using one of a set of predefined wait events. Wait event data reveals various symptoms of problems that might be impacting performance, such as latch contention, buffer contention, and I/O contention.

Wait event statistics include the number of times an event was waited for and the time waited for the event to complete. To minimize user response time, reduce the time spent by server processes waiting for event completion. Not all wait events have the same wait time. Therefore, it is more important to examine events with high wait time rather than wait events with a high number of occurrences.

You can query wait event statistics from various V$ dynamic performance views. For more information about using wait events, see the "Using Wait Event Statistics to Drill Down to Bottlenecks" section in the Oracle Database Performance Tuning Guide.

12.2.4 Tuning SQL Statements

When Oracle Database executes a SQL statement, the query optimizer (also called the optimizer) first determines the best and most efficient way to retrieve the results. It compares the cost of all possible approaches and chooses the approach with the least cost. The access method for physically executing a SQL statement is called an execution plan, which the optimizer is responsible for generating. The determination of an execution plan is an important step in the processing of any SQL statement, and can greatly affect execution time

The optimizer can also help you tune SQL statements. By using SQL Tuning Advisor and SQL Access Advisor, you can run the optimizer in advisory mode to examine a SQL statement or set of statements and determine how to improve their efficiency. SQL Tuning Advisor and SQL Access Advisor can make various recommendations. SQL Access Advisor is primarily responsible for making schema modification recommendations, such as adding or dropping indexes and materialized views. SQL Tuning Advisor makes other types of recommendations, such as creating SQL profiles and restructuring SQL statements. Using Database Control, you can accept and implement many of these recommendations.

Review the following topics for information on tuning SQL statements:

- Section 12.2.4.1, "Collecting Optimizer Statistics"

- Section 12.2.4.2, "SQL Tuning Sets"

- Section 12.2.4.3, "SQL Profiles"

- Section 12.2.4.4, "Using SQL Tuning Advisor"

- Section 12.2.4.5, "Using SQL Access Advisor"

- Section 12.2.4.6, "Using SQL Tracing"

12.2.4.1 Collecting Optimizer Statistics

Oracle Database can execute an SQL statement in many different ways. The optimizer determines the most efficient way to execute an SQL statement after considering many factors related to the objects referenced and the conditions specified in the query. For the query optimizer to produce an optimal execution plan, the statistics in the data dictionary should accurately reflect the volume and data distribution of the tables and indexes.

Oracle Fusion Applications uses the DBMS_STATS package to automatically gather optimizer statistics. In this case, the database automatically collects optimizer statistics for tables with absent or stale statistics. If fresh statistics are required for a table, then the database collects them both for the table and associated indexes. For any on-demand gathering statistics on a particular table, you can use Database Control.

The output from the optimizer is an execution plan that describes an optimal method of execution. The plans shows the combination of the steps Oracle Database uses to execute an SQL statement. Each step either retrieves rows of data physically.

For more information about the optimizer, see "The Query Optimizer" chapter in the Oracle Database Performance Tuning Guide.

Note:

Oracle Fusion Applications require several database initialization parameters to be set correctly to ensure optimal performance. For more information about these database initialization parameters and Fusion Applications best practices, see MOS document 1270340.1.

12.2.4.2 SQL Tuning Sets

A SQL tuning set is a database object that includes one or more SQL statements and their execution statistics and context. You can use the set as an input for advisors such as SQL Tuning Advisor, SQL Access Advisor, and SQL Performance Analyzer. You can load SQL statements into a SQL tuning set from different SQL sources, such as AWR, the cursor cache, or high-load SQL statements that you identify. SQL tuning sets are transportable, enabling SQL workloads to be transferred between databases for remote performance diagnostics and tuning. When high-load SQL statements are identified on a production system, it may not be desirable to perform investigation and tuning activities directly on this system. This feature enables you to transport the high-load SQL statements to a test system, where they can be safely analyzed and tuned.

To create a SQL tuning set, use SQL Tuning Sets page, accessible from Additional Monitoring Links on the Database Performance page.

For more information about SQL tuning sets, see the "Managing SQL Tuning Sets" in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.4.3 SQL Profiles

A SQL profile is a set of auxiliary information that is built during automatic tuning of a SQL statement. A SQL profile is to a SQL statement what statistics are to a table.

During SQL profiling, the optimizer uses the execution history of the SQL statement to create appropriate settings for optimizer parameters. After SQL profiling completes, the optimizer uses the information in the SQL profile and regular database statistics to generate execution plans. The additional information enables the database to produce well-tuned plans for corresponding SQL statements.

After running a SQL Tuning Advisor task with a comprehensive scope, a SQL profile may be recommended. If you accept the recommendation, then the database creates the SQL profile and enables it for the SQL statement.

To manage SQL profiles, use the Plan Control tab, accessible from the SQL Details page of the SQL statement that is using a SQL profile.

For more information about SQL profiles, see the "Managing SQL Profiles" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.4.4 Using SQL Tuning Advisor

Oracle Database can generate SQL tuning reports automatically. Automatic SQL Tuning runs during system maintenance windows as an automated maintenance task, searching for ways to improve the execution plans of high-load SQL statements.

ADDM also automatically identifies high-load SQL statements. If ADDM identifies such statements, then click Schedule/Run SQL Tuning Advisor on the Recommendation Detail page to run SQL Tuning Advisor on these statements.

For more information about SQL Tuning Advisor, see the "Tuning SQL Statements Using SQL Tuning Advisor" section in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.4.5 Using SQL Access Advisor

To achieve optimal performance for data-intensive queries, materialized views and indexes are essential for SQL statements. However, implementing these objects does not come without cost. Creation and maintenance of these objects can be time-consuming. Space requirements can be significant. SQL Access Advisor enables you to optimize query access paths by recommending materialized views and view logs, indexes, SQL profiles, and partitions for a specific workload.

To run SQL Access Advisor, use the SQL Access Advisor link on the SQL Advisors page, accessible from the Advisor Central page under Related Links on the Database Home page.

For more information about SQL Access Advisor, see the "Optimizing Data Access Paths" chapter in the Oracle Database 2 Day + Performance Tuning Guide.

12.2.4.6 Using SQL Tracing

You can use the SQL Trace facility to monitor Oracle Fusion Applications running against Oracle Database by assessing the efficiency of the SQL statements that Oracle Fusion applications are running. The SQL Trace facility provides performance information for individual SQL statements and generates detailed statistics for each statement.

You can then run the TKPROF program to format the contents of the SQL trace file and place the output into a readable output file. TKPROF reports each statement executed with the resources it has consumed, the number of times it was called, and the number of rows which it processed. This information lets you easily locate SQL statements that are using the greatest resource.

For more information about using SQL tracing, see the "Using the SQL Trace Facility and TKPROF" section in the Oracle Database Performance Tuning Guide.

If a performance problem is reported for a particular business transaction for a given session in Oracle Fusion Applications, you can instruct the user of the session to enable a SQL trace for that transaction.

To enable SQL trace for a specific business transaction that is reported to be causing performance problem:

1. Sign in to Oracle Fusion Applications with a user account that is provisioned with the necessary role. Contact your security administrator for details.

2. From the Help menu, choose Troubleshooting, then Troubleshooting Options.

3. In the Options page, select Database Trace.

4. Select Capture bind variables, Capture wait events as appropriate.

5. Click Save and Close.

This enables SQL trace for the selected transaction and does not affect transactions that belong to other sessions.

12.3 Testing Oracle Database Changes

Oracle Real Application Testing enables you to perform real-world testing of Oracle Database. By capturing production workloads and assessing the impact of system changes on a test system before production deployment, Oracle Real Application Testing minimizes the risk of instabilities associated with changes.

See the following sections for more information about Oracle Real Application Testing:

- Section 12.3.1, "Testing SQL Changes"

- Section 12.3.2, "Testing Database Changes"

12.3.1 Testing SQL Changes

System changes—such as a upgrading a database or adding an index—may cause changes to execution plans of SQL statements, resulting in a significant impact on SQL performance. In some cases, the system changes may cause SQL statements to regress, resulting in performance degradation. In other cases, the system changes may improve SQL performance. Being able to accurately forecast the potential impact of system changes on SQL's performance by identifying regressed and improved SQLs, enables you to tune the system beforehand.Also we can validate and measure the performance gain of the SQL and the system.

SQL Performance Analyzer automates the process of assessing the overall effect of a change on the full SQL workload by identifying performance divergence for each SQL statement. A report that shows the net impact on the workload performance due to the change is provided. For regressed SQL statements, SQL Performance Analyzer also provides appropriate executions plan details along with tuning recommendations. Thus, you can remedy any negative changes before the end users are affected.

To use SQL Performance Analyzer, under Real Application Testing on the Software and Support page, click SQL Performance Analyzer.

For more information about SQL Performance Analyzer, see the "SQL Performance Analyzer" part in the Oracle Database Real Application Testing User's Guide.

12.3.2 Testing Database Changes

Before system changes are made, such as hardware and software upgrades, extensive testing is usually performed in a test environment to validate the changes. However, despite the testing, the new system often experiences unexpected behavior when it enters production because the testing was not performed using a realistic workload. The inability to simulate a realistic workload during testing is one of the biggest challenges when validating system changes.

Database Replay enables realistic testing of system changes by essentially re-creating the production workload environment on a test system. Using Database Replay, you can capture a workload on the production system and replay it on a test system with the exact timing, concurrency, and transaction characteristics of the original workload. This enables you to fully assess the impact of the change, including undesired results, new contention points, or plan regressions. Extensive analysis and reporting is provided to help identify any potential problems, such as new errors encountered and performance divergence.

To use Database Replay, under Real Application Testing on the Software and Support page, click Database Replay.

For more information about Database Replay, see the "Database Replay" part in the Oracle Database Real Application Testing User's Guide

13 Managing Oracle Fusion Applications Log Files

This chapter describes how to use incidents, log files, and QuickTrace to support normal operations for Oracle Fusion Applications and to prepare for future troubleshooting.

This chapter contains the following topics:

- Section 13.1, "Overview of Oracle Fusion Applications Incidents, Logging, and QuickTrace"

- Section 13.2, "Understanding Oracle Fusion Applications Log Files and Log Messages"

- Section 13.3, "Viewing and Searching Log Files During Normal Operation"

- Section 13.4, "Configuring Settings for Log Files During Normal Operation"

For information about using diagnostics tests to support normal operations for Oracle Fusion Applications, see Chapter 14. For information about troubleshooting using log settings, log files, the QuickTrace feature (in-memory logging), diagnostic tests, and incidents, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.1 Overview of Oracle Fusion Applications Incidents, Logging, and QuickTrace

Incidents, log files, and QuickTrace can all help you administer Oracle Fusion Applications. If your Oracle Fusion Applications environment includes Oracle Enterprise Manager Cloud Control (Cloud Control), then you can also use Support Workbench to help you investigate, report, and resolve problems.

Incidents are collections of information about error conditions. Some incidents are created and gather information automatically when problems occur. For example, the information associated with an automatically created incident may include detailed operational information collected by the QuickTrace (in-memory logging) feature for Oracle Fusion Applications. For problems that do not automatically create incidents, administrators or help desk personnel can manually create incidents and manually gather and add related system information.

Note:

Preparing to process incidents is a key part of normal operations. It is strongly recommended that you follow Information Technology Infrastructure Library (ITIL) best practices by establishing a help desk or service desk within your organization to support Oracle Fusion Applications, and have the help desk personnel use incidents to track the troubleshooting and resolution of all problems.

Log files contain information about both normal and problematic events. Log files can help you both to monitor normal operations and to diagnose and address some problems yourself. For example, log messages that state that a service cannot be reached might indicate a hardware failure. If you discover a more complex issue, then Oracle Support personnel may use log files to trace the execution code paths of relevant requests, as part of diagnosing the problem. Log files are particularly helpful if your Oracle implementation contains custom code that needs debugging, especially when using a debugger is not feasible, such as on a production system.

The QuickTrace (in-memory logging) feature continuously records a specified level of log detail in an area of memory. The memory is recycled on an ongoing basis, with the oldest information being deleted or overwritten first. Because QuickTrace writes to memory instead of to a log file, it can gather operational information continuously without significantly affecting system performance. The information that QuickTrace stores in memory is written to disk only when an incident occurs or when an administrator manually dumps the contents of a QuickTrace buffer.

In Cloud Control, Support Workbench helps you investigate, report, and resolve problems (critical errors). You can use Support Workbench to perform the following kinds of operations:

- View summary information about recent problems and incidents.

- View detailed diagnostic data that was gathered automatically.

- Manually trigger additional dumps of diagnostic data.

- Connect to the Oracle Fusion Applications Diagnostic Dashboard application (Diagnostic Dashboard), which provides you with additional diagnostic tests that you can run. For information about using Diagnostic Dashboard, see Chapter 14 and the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

- Create or update service requests with Oracle Support, including uploading diagnostic data to Oracle

For information about using Support Workbench to administer Oracle Fusion Applications targets, specifically, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide. For general information about using Support Workbench, see the topic "Support Workbench Page" in the Cloud Control online help and the chapter on investigating, reporting, and resolving problems in Oracle Database 2 Day DBA.

13.2 Understanding Oracle Fusion Applications Log Files and Log Messages

Log files can help you administer and support Oracle Fusion Applications over time. Oracle developers use mechanisms such as application programming interface (API) calls in Oracle Fusion Applications code to record application operations in log files and to provide error messages as appropriate.

You can set system log levels to determine how much information is logged. For more information about setting log levels, see Section 13.4.

For more information about monitoring log files, see Section 13.3 and Section 13.4.4. For more information about using logs to help diagnose a problem, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

It is important to be familiar with the following additional concepts that are related to log files:

- Seed data is information that Oracle provides to you in the form of database records. Error messages are included in seed data.

- Profiles are settings that you can select to determine details of how the application operates. Oracle Fusion applications include profile options that affect how much information to log either for an entire site or for a specific user. Oracle Fusion applications that are written in Java also support some profile options that affect how much information to log for a specific product.
For more information about profiles, see Section 13.4 and the chapter about maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

13.2.1 Standard Log File Administration Tasks and Tools

Under ordinary circumstances, the following administrative tasks are part of the necessary setup and maintenance of Oracle Fusion Applications log files:

- Tuning system performance by adjusting configuration settings for logs

- Reviewing log files for general monitoring of system health

- Searching for specific information in log files

- Managing available disk space for log files

If your Oracle Fusion Applications environment includes Cloud Control, then you may find it convenient to use Cloud Control to monitor log files in multiple domains, simultaneously.

You can use the Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) user interface to complete all of the tasks listed in this section, but only for one WebLogic domain at a time. In particular, you can use Fusion Applications Control to configure log profile option values for Oracle Fusion Applications, although you can also configure profile options by using the Manage Administrator Profile Values screen in the Setup and Maintenance work area. You can use either Cloud Control or Fusion Applications Control to view and search Oracle Fusion Applications log files.

Note:

Fusion Applications Control and Cloud Control are compliant with Information Technology Infrastructure Library (ITIL) best practices.

During troubleshooting activities, additional log administration tasks may include downloading log files from servers and packaging incidents for transmittal to Oracle Support. For more information about these activities and the tools for accomplishing them, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.2.2 Log Files and Settings

Oracle provides settings that determine the amount of information that is gathered into the log files for your Oracle Fusion applications. You can either use the default setting values or change one or more values to adjust how much information is gathered. When your system is operating correctly, you may need log entries only for particularly important kinds of events. If your system experiences a problem, then you can temporarily increase the amount of information that is logged to get more detailed information while you attempt to reproduce and resolve the problem.

Most Oracle Fusion applications write log output in Oracle Diagnostic Logging (ODL) format. For information about the attributes that appear in standard log files for Oracle Fusion Applications, see the "Understanding ODL Messages and ODL Log Files" section in the Oracle Fusion Middleware Administrator's Guide.

Some Oracle Fusion applications use nonstandard logging mechanisms that are disabled by default. For these applications, you must turn on the logging facility when you need it and specify the kind of information that you want to record in the log file. For more information about these special logging mechanisms, see Section 13.4.6.

13.2.3 Log Message Structure

A typical log message consists of three parts:

- Attributes that are logged by the Oracle Fusion Middleware layer or the Oracle Database layer

- Attributes that are logged by logging APIs for Oracle Fusion Applications, including AppsLogger

- Message text

13.2.3.1 Log Message Attributes Supplied by the Oracle Fusion Middleware and Oracle Database Layers

The log message attributes logged by the Oracle Fusion Middleware layer or the Oracle Database layer may include the following:

- Date/time: The date and time when the message was recorded in the log.

- Component ID: The component or Oracle WebLogic Server (WebLogic Server) instance from which the message originated. For the Oracle Fusion Middleware layer, a typical value is the name of the Oracle WebLogic Server that was executing the Oracle Fusion application when the message was generated. For the database layer, a typical value is rdbms.

- Message Type:Level: Shows the level being logged for the particular message

- Message ID: A unique identifier for a seeded message, composed of the product code and a message number. A typical value for a message ID might be FND-12343.

- Module ID: The system or application module that generated the message. This is usually the name of the logger object that generated the message. In some cases, the logger name may reflect the full Java class name of the application code module that was executing when the message was logged. In other cases, the logger object may generate messages for multiple Java classes.

- Execution context ID (ECID): A global unique identifier and a sequence number of the thread of execution in which the originating component participates. The identifier can be used to correlate messages from several components that may be involved in the same thread of execution.

- Host: The name of the host from which the message originates. For Java, this should be the value returned by the java.net.InetAddress.getLocalHost().getHostName() method.

- Thread ID (TID): A unique identifier for the thread within the Java process where the message was generated.

- Java EE application name: Name of a Java EE application that was executing when the message was logged.

- User name: A unique identifier that the user enters when signing in to an Oracle Fusion application. This attribute is logged both by Oracle Fusion Middleware and by the logging APIs for Oracle Fusion Applications.

- Selective trace ID (labeled ODL_TRACE_ID in the log file): An identifier for operations in the Oracle Fusion Middleware layer that match criteria an administrator supplied as part of a request to log additional information.

Note:

Selective trace operations do not affect the information that is logged from the Oracle Fusion Applications layer, but the Oracle Fusion Middleware log messages that selective tracing operations obtain are stored in the same log files as log messages from the Oracle Fusion Applications layer. Similarly, log messages from the Oracle Fusion Applications layer are listed with Oracle Fusion Middleware log messages in selective trace output if those log messages match the trace criteria that the administrator specified. For more information about selective tracing, see the "Configuring and Using Selective Tracing" section in the Oracle Fusion Middleware Administrator's Guide.

13.2.3.2 Log Message Attributes Supplied by Logging APIs for Oracle Fusion Applications

The log message attributes logged by logging APIs for Oracle Fusion Applications include the following:

- User Name: A unique identifier that the user enters when signing in to an Oracle Fusion application. This attribute is logged both by Oracle Fusion Middleware and by the logging APIs for Oracle Fusion Applications.

- User GUID: A global unique identifier representing the user.

- Role IDs: A list of IDs representing the job roles granted to the user.

- Session ID: A unique identifier for the application user session.

- Thread Name: A name that identifies the thread generating the log in Java Virtual Machine (JVM). Applies only to Oracle Fusion applications that are written in Java. Logging APIs for Oracle Fusion applications that are written in C and PL/SQL do not populate this attribute.

- Apps Source: The portion of the Oracle Fusion Applications code that is executing when the message is logged.

- Apps Auto Log: Indicates whether the message being logged was logged implicitly.

- DB Connection URL: The URL connection string for the application database data source.

Depending on the value of the AFLOG_EXTENDED_ENABLED profile option, the following supplemental attributes may also be logged:

- Message Cause: The reason that the message is being logged.

- Admin Action: Recommended follow-up action for Oracle Fusion Applications administrators.

- Admin Details: Additional information for administrators about the condition being logged.

- User Action: Recommended follow-up action for Oracle Fusion Applications users.

- User Details: Additional information for users about the condition being logged.

For more information about how the AFLOG_EXTENDED_ENABLED profile option affects the logging of these supplemental attributes, see Section 13.4.1.

13.2.3.3 Log Message Attributes Supplied by the Application Session

The log message attributes logged by the application session include the following:

- Product Family: The name of the group of Java EE applications specific to Oracle Fusion Applications that contains the application that is executing when the message is logged.

- Product: The name of the product that is executing when the message is logged.

13.2.3.4 Log Message Attributes Supplied by Oracle Enterprise Scheduler Job Requests

The following attributes appear in the log if the log entry is written from an Oracle Enterprise Scheduler job request.

- Job Request ID: The identifier of the Oracle Enterprise Scheduler job request that is being executed when this message is logged.

- Job Definition Name: The name of the Oracle Enterprise Scheduler job definition. A job definition is the smallest unit of work that is performed in the context of the client application.

- Job Package Name: The package location of the Oracle Enterprise Scheduler job definition that is executing when this message is logged.

- Job Definition Application: The application that owns the Oracle Enterprise Scheduler job.

13.2.3.5 Log Message Attributes Supplied by SOA

The following attributes appear in the log if the log entry is written from SOA:

- SOA Composite Name: The name of the SOA Composite that is executing when the message is logged

- SOA Component Name: The name of the SOA Component that is executing when the message is logged

- SOA Composite Instance ID: The instance ID of the SOA Composite that is executing when the message is logged

- SOA Component Instance ID: The instance ID of the SOA Component that is executing when the message is logged

- Log Token Map: One or more primary key values for the logical entity that a BPEL process is handling when the message is logged. Oracle Support may require this information for troubleshooting purposes.

13.3 Viewing and Searching Log Files During Normal Operation

To view and search Oracle Fusion application log files effectively, it is important to be familiar with the software that is available for working with log files. You may also find it helpful to know where log files are stored for various application modules.

Note:

Each Oracle Fusion Applications module is written in one of the following code languages: Java, SOA, PL/SQL, or C. Details of logging vary depending on the coding language of the application module.

In general, you can administer logging for Oracle Fusion Applications without knowing which programming language implements particular modules. However, it is important to become familiar with the configuration settings and log file locations used for each language, so you can monitor or adjust all relevant parts of the system when necessary.

13.3.1 Viewing Logs from Fusion Applications Control

When you want to view log files for one Oracle Fusion Applications product family or product that uses standard logging functionality, one typical way that you can view the log files is to use Fusion Applications Control.

By default, you can use Fusion Applications Control to view standard log files for the Oracle WebLogic Servers that host Oracle Fusion applications and standard log files generated by Java code within Oracle Fusion applications. In addition, you can configure your system to allow Fusion Applications Control to view log files generated by PL/SQL or C code within Oracle Fusion applications. For more information about how to configure this capability, see Section 13.4.7.

From Fusion Applications Control, you can view log messages for different system components by selecting different targets. In the product family part of the navigation tree, the following target types allow viewing of log messages for Oracle Fusion Applications:

- An entire product family. When you select this target type and view log files, you view the aggregated logs for all of the servers and clusters in the selected product family's domain.

- A particular Oracle Fusion application, such as Procurement, sometimes called an Oracle Fusion Applications cluster application. When you select this target type and view log files, you view the aggregated logs for all of the servers in the selected cluster.

- A particular instance of an Oracle Fusion application deployed to a Managed Server. When you select this target type and view log files, you view the log for the selected individual Managed Server.

The Fusion Applications Control page also gives you access to log files for the following target types in the farm part of the navigation tree, but the functionality used to view those logs is part of Fusion Middleware Control.

- A particular Oracle WebLogic Server domain

- A particular server cluster

- A particular server within a particular server cluster

To view the contents of Oracle Fusion Applications logs from Fusion Applications Control:

1. From the navigation pane, select the target for which you want to display log contents.
In the part of the navigation tree for the product family, you can display logs for the following kinds of targets:

- A product family target lets you display the aggregated log entries for all of the Oracle Fusion applications in the selected product family. For example, Financials is a product family target that appears as a top-level folder in the navigation tree.

- An Oracle Fusion Applications cluster application target lets you display the aggregated logs for all of the Managed Servers that run the selected application, including the logs for any other Oracle Fusion applications that run on those Managed Servers. For example, if you expand the product family, Financials, and then expand Fusion Applications, then PayablesApp is a cluster application target.

- An Oracle Fusion application instance target lets you display the log entries for the selected application on the selected sever. For example, if you expand the product family, Financials, and then expand Fusion Applications, and then expand PayablesApp, then PayablesApp (PayablesServer_1) is an application instance target.

Note:

When you select a target, the header of the context pane displays a dropdown menu name that depends on the target type:

- For a product family target, the menu name is Product Family.

- For an Oracle Fusion Applications cluster application target, the menu name is Fusion Cluster Application.

- For an Oracle Fusion application instance target, the menu name is Fusion J2EE Application.

Alternatively, if you want to view a log file for an Oracle Fusion Middleware target, then you can select such a target from the farm part of the navigation tree. For more information about viewing log files for Oracle Fusion Middleware components, see the "Viewing Log Files and Their Messages Using Fusion Middleware Control" section in the Oracle Fusion Middleware Administrator's Guide.

2. In the context pane, from the dynamic target menu, choose Logs > View Log Messages to display the log messages screen.

13.3.2 Searching for Specific Information in Log Files within a Single Domain

For most Oracle Fusion applications, you can use Fusion Applications Control to search for log messages that have specific characteristics. Searches that use Fusion Applications Control are similar to searches that use Fusion Middleware Control.

By default, you can use Fusion Applications Control to search standard log files for Oracle Fusion applications that are written in Java and the Oracle WebLogic Servers that host those applications. You can configure your system to allow Fusion Applications Control to search log files for Oracle Fusion applications that are written in PL/SQL or C. For more information about the necessary configuration steps for PL/SQL and C logs, see Section 13.4.7.

To search standard Oracle Fusion Applications log files using Fusion Applications Control:

1. From the navigation pane for Fusion Applications Control, select the target for which you want to search log contents.

For your target, you can select a product family such as Financials, an Oracle Fusion Applications cluster application such as LedgerApp, or an Oracle Fusion application instance such as LedgerApp (LedgerServer_1). For information about searching log files in multiple domains, using a Fusion Instance target, see Section 13.3.3.

Note:

When you select a target, the header of the context pane displays a dropdown menu name that depends on the target type:

- For a product family target, the menu name is Product Family.

- For an Oracle Fusion Applications cluster application target, the menu name is Fusion Cluster Application.

- For an Oracle Fusion application instance target, the menu name is Fusion J2EE Application.

For example, if you want to search the aggregated log entries for all of the Oracle Fusion applications in the Financials product family, then you select the Financials entry in the navigation tree. The Product Family dropdown menu appears under Financials in the context pane header.

If you want to search the aggregated logs for the Ledger cluster application, then you expand the Financials entry in the navigation tree, then expand the Fusion Applications entry, and then select LedgerApp. The Fusion Cluster Application dropdown menu appears under LedgerApp in the context pane header.

If you would rather search the Ledger application log entries for only a particular server, then you expand the Financials entry in the navigation tree, then expand the Fusion Applications entry, then expand the LedgerApp entry, and then select the individual LedgerApp Managed Server for the log you want to search. The Fusion J2EE Application dropdown menu appears under LedgerApp in the context pane header.

2. In the context pane, from the dynamic target menu, choose Logs > View Log Messages.
If you selected an Oracle Fusion application as your target, then the content pane displays the aggregated log messages from all of the servers for the Oracle Fusion application that you selected.

If you selected an individual Oracle Fusion application instance running on a particular Managed Server as your target, then the content pane displays the log messages for the selected Oracle Fusion application operations that were handled by the selected server.

If you selected a product family such as Financials as your target, then the content pane displays the aggregated log messages for all of the Managed Servers that handle Oracle Fusion applications in the selected product family.

3. If necessary, expand the Search area of the content pane.

4. If you selected an Oracle Fusion application instance in Step 1, skip to Step 5.
If you selected a product family or Oracle Fusion Applications cluster application in Step 1, then complete the following substeps to determine which members of the selected target will be included in the log search:

1. Expand the Selected Targets section of the Search area.

2. If you want to search the log files for only some of the listed target members, then select the ones you want to omit from the search and click Remove.

3. If you want the log search operation to search log files that are not currently listed, then click Add, select the additional targets that you want to search, and click Select.

4. Go to Step 5.

5. Enter or select applicable search criteria in any visible search fields, such as the following fields that are visible by default:

- In the Date Range fields, specify the time period for which you want to display log messages.
To specify a specific number of the most recent minutes, hours, or days, select Most Recent from the dropdown list, enter your preferred number, and select the appropriate time units.

To specify the time period using starting and ending dates and times, select Time Interval from the dropdown list and enter the starting and ending dates and times.

- In the Message Types field, select one or more checkboxes to specify the kinds of log messages that you want to display.

- In the Message fields specify some or all of the message text in the log messages that you want to display.
If you select either the matches search operator or the does not match search operator, then you must either specify the full text of the message, or you must use a standard Java language expression to specify the characteristics of the missing text. For example, in standard Java expressions, the period (.) acts as a wildcard that matches most single characters, and the combination of a period and an asterisk (.*) acts as a wildcard to match any string of characters.

In contrast, the following search operators contain implicit wildcard semantics. You do not need wildcard characters or other Java expressions when you use any of these operators to search for a part of the text of a message:

- contains

- does not contain

- starts with

- does not start with

- ends with

- does not end with

Note:

If you search for multiple values within a single search field, using commas to separate the values, then the search results display log entries that match any of the criteria specified for that field (logical OR). However, if you specify criteria in multiple search fields, then the search results display only log entries that match specified criteria in all of those search fields (logical AND).

6. If you want to use search criteria in fields that are not currently visible, then complete the following substeps; otherwise, skip this step.

1. Click Add Fields.

2. Select one or more checkboxes for the additional fields you want to use in your search, and then click Add.
For example, you might select ECID to search for all log messages that are associated with a particular execution context identifier.

3. In each field that you added, specify the value that you want the search to match.
For example, you might enter the ECID value of 004bYSyedEi3v1A5Jb8Dyf0002kx003XFf.

7. Click Search.

13.3.3 Searching for Specific Information in Log Files Across Multiple Domains

If your Oracle Fusion Applications environment includes Cloud Control, then you can use Cloud Control to search for information in the log files of multiple domains within a single Fusion instance.

To search standard Oracle Fusion Applications log files in multiple domains using Cloud Control:

1. In Cloud Control, from the Target menu, choose Fusion Applications.

2. In the list of Oracle Fusion instances and Oracle Fusion Applications product families, click the name of the instance that interests you.

3. From the dynamic Fusion Instance target menu, choose Logs > View Log Messages.

4. If it is collapsed, then expand the Search area of the Log Messages pane.

5. Expand the Selected Targets part of the Search area, and make sure that it lists the targets for all of the log files that you want to search:

- If you want to search the log files for only some of the listed target members, then select the ones you want to omit from the search and click Remove.

- If you want the log search operation to search log files that are not currently listed, then click Add, select the additional targets that you want to search, and click Select.

6. Enter or select applicable search criteria in any of the visible search fields, such as the following fields that are visible by default:

- In the Date Range fields, specify the time period for which you want to display log messages.
To specify a specific number of the most recent minutes, hours, or days, select Most Recent from the dropdown list, enter your preferred number, and select the appropriate time units.

To specify the time period using starting and ending dates and times, select Time Interval from the dropdown list and enter the starting and ending dates and times.

- In the Message Types field, select one or more checkboxes to specify the kinds of log messages that you want to display.

- In the Message fields, specify some or all of the message text in the log messages that you want to display.
If you select either the matches search operator or the does not match search operator, then you must either specify the full text of the message, or you must use a standard Java language expression to specify the characteristics of the missing text. For example, in standard Java expressions, the period (.) acts as a wildcard that matches most single characters, and the combination of a period and an asterisk (.*) acts as a wildcard to match any string of characters.

In contrast, the following search operators contain implicit wildcard semantics. You do not need wildcard characters or other Java expressions when you use any of these operators to search for a part of the text of a message:

- contains

- does not contain

- starts with

- does not start with

- ends with

- does not end with

Note:

If you search for multiple values within a single search field, using commas to separate the values, then the search results display log entries that match any of the criteria specified for that field (logical OR). However, if you specify criteria in multiple search fields, then the search results display only log entries that match specified criteria in all of those search fields (logical AND).

7. If you want to use search criteria in fields that are not currently visible, then complete the following substeps; otherwise, skip this step.

1. Click Add Fields.

2. Select one or more checkboxes for the additional fields you want to use in your search, and then click Add.
For example, you might select ECID to search for all log messages that are associated with a particular execution context identifier.

3. In each field that you added, specify the value that you want the search to match.
For example, you might enter the ECID value of 004bYSyedEi3v1A5Jb8Dyf0002kx003XFf.

8. Click Search.

13.3.4 Saving Log Search Criteria for Reuse

If your Oracle Fusion Applications environment includes Cloud Control, then you can use Cloud Control to save log search criteria so that repeating the same search is more convenient in the future.

To save log search criteria using Cloud Control:

1. Make sure that you are logged into Cloud Control as the user who will need to reuse the criteria that you plan to save.

Only the user who saves a set of log search criteria can reuse that set.

2. Decide upon the target for which you expect to need repeated log searches.
For example, you might want to save a log search for a target about which you have repeatedly received alert notifications.

Note:

For maximum flexibility when reusing search criteria, you may want to use the highest level target that you expect to be applicable. Such a saved log search can be reused for the selected target or any target beneath it in the hierarchical navigation tree.

For example, if you save log search criteria for a particular Oracle Fusion Applications cluster application, then you can reuse those saved search criteria for that same cluster application or for any Managed Server within that cluster.

3. Use either of the following methods to navigate to a screen where you can specify log search criteria for your preferred target:

- From the Target menu, choose Fusion Applications, and then expand the hierarchical navigation tree, select your preferred target, and choose Logs > View Log Messages from the dynamic target menu.

- From the Enterprise menu, choose Monitoring > Logs, and then expand the Selected Targets section and add your preferred target.

4. Enter or select the desired search criteria in all applicable search fields.
For more information about these fields, see Section 13.3.3.

5. Click Search.

6. Review the search results to make sure that you specified the target and search criteria that you want to save, then click Save Search.
A confirmation message appears, including the default name for the saved search, which can include lengthy information about the criteria you used.

Note:

If the Save Search button is not available, then the system has not detected any change in target or search criteria since your last log search. To reenable the Save Search button, select a different target or specify different search criteria.

7. To assign the saved search a more convenient name, complete the following sub-steps:

1. From the Saved Searches dropdown list, select Manage Saved Searches.

2. In the Manage Favorites dialog, click the first column of the table row that lists the saved search that you want to rename.
If the list of saved searches is long, you can click the query by example button and use standard techniques to help you locate the saved search that interests you.

3. In the Name field, enter a new name for the saved search.
Saved log search names can be up to 256 characters long. It is recommended that you specify a name that will help you remember the target that the search applies to, as well as the search criteria.

Note:

The name is the only characteristic of a saved log search that you can modify. To save different search criteria, or to save the same criteria for a different target, you must create a new saved search by repeating all steps of this procedure, starting with Step 1.

4. Click OK.

For information about reusing saved log search criteria, see Section 13.3.5

13.3.5 Reusing Saved Log Search Criteria

If your Oracle Fusion Applications environment includes Cloud Control, then you can reuse saved log search criteria. For information about saving log search criteria, see Section 13.3.4.

To repeat a log search that you previously saved using Cloud Control:

1. Make sure that you are logged into Cloud Control as the user who saved the search criteria that you want to reuse.
Only the user who saved a set of log search criteria can reuse that set.

2. Use either of the following methods to navigate to a screen where you can specify log search criteria for your preferred target:

- From the Target menu, choose Fusion Applications, and then expand the hierarchical navigation tree, select your preferred target, and choose Logs > View Log Messages from the dynamic target menu.

- From the Enterprise menu, choose Monitoring > Logs, and then expand the Selected Targets section and add your preferred target.

Note:

For the search to be effective, the target that you select must be either the target for which the search criteria were originally saved, or a target that is below the original target in the hierarchical navigation tree.

For example, if you originally saved the search for a cluster application target, you can reuse that search only for the same cluster or for a Managed Server that belongs to that cluster.

3. From the Saved Searches dropdown list, select the saved search for the search criteria that you want to reuse.

Note:

The Saved Searches dropdown list contains all of the log searches that the current user previously saved, regardless of the saved or current target contexts.

Provided that the current target is either the target for which the selected search was saved or a target that is below the original target in the hierarchical navigation tree, then the search is reexecuted as soon as you select the saved search that you want to reuse.

If the current target is below the originally saved target in the navigation tree, then the reexecuted search uses only the saved search criteria that apply to the subsidiary target.

If the current target is not either the target for which the selected search was saved or a target that is below the original target in the hierarchical navigation tree, then the search is not executed.

4. If some of the saved search criteria did not apply to your currently selected target, and if you want to save just the applicable search criteria and current target context, then click Save Search.

5. To assign the new saved search a more convenient name, complete the following sub-steps:

1. From the Saved Searches dropdown list, select Manage Saved Searches.

2. In the Manage Favorites dialog, click the first column of the table row that lists the saved search that you want to rename.
If the list of saved searches is long, you can click the query by example button and use standard techniques to help you locate the saved search that interests you.

3. In the Name field, enter a new name for the saved search.
It is recommended that you choose a name that will help you remember the target that the search applies to, as well as the search criteria.

4. Click OK.

13.3.6 Typical Log File Locations

Note:

The following information is provided for reference purposes. For maximum clarity and convenience, it is recommended that you use Fusion Applications Control to work with Oracle Fusion Applications log files, rather than working directly with the log files.

Each Oracle Fusion application runs in one or more logical Managed Servers. Each Managed Server is dedicated to a single Oracle Fusion application. Different Managed Servers do not typically share log files with each other, even if they are running on the same physical server computer.

Most Oracle Fusion Applications code modules use standard logging code. On each Managed Server, all Java and SOA application code modules that use standard logging code write log entries to a single file. The location of this file is specified by a log_handler entry in a logging.xml file. The default location for the logging.xml file is as follows, where DOMAIN_HOME is the path to your Oracle WebLogic Server (WebLogic Server) domain, and WebLogic_Server_Name is the name of the WebLogic Server that uses the logging.xml file:

DOMAIN_HOME/config/fmwconfig/servers/WebLogic_Server_Name/logging.xml

The following example shows a typical log_handler entry in the logging.xml file, which includes the path and file name of the log file.

Example 13-1 Typical log_handler Entry Showing Log File Name and Location

<log_handlers>
<log_handler name='apps-handler' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
<property name='path' value='${domain.home}/servers/${weblogic.Name}/logs/apps/
${weblogic.Name}-diagnostic.log'/>
<property name='maxFileSize' value='10485760'/>
<property name='maxLogSize' value='104857600'/>
<property name='encoding' value='UTF-8'/>
<property name='supplem8entalAttributes' value='APPS_USER_NAME,
APPS_SESSION_ID, APPS_THREAD_NAME, APPS_SOURCE, APPS_USER_ID, APPS_AUTO_LOG,
APPS_JOB_REQUEST_ID, APPS_JOB_DEFINITION_NAME, APPS_JOB_PACKAGE_NAME,
APPS_JOB_DEFINITION_APP, APPS_COMPOSITE_NAME, APPS_COMPONENT_NAME,
APPS_COMPOSITE_INSTANCE_ID, APPS_COMPONENT_INSTANCE_ID, APPS_PRODUCT_FAMILY,
APPS_PRODUCT, APPS_INDUSTRY, APPS_TERRITORY, APPS_DB_CONNECTION_URL,
APPS_MESSAGE_CAUSE, APPS_USER_ACTION, APPS_ADMIN_ACTION, APPS_USER_DETAILS,
APPS_ADMIN_DETAILS, APPS_LOG_TOKEN_MAP'/>
</log_handler>
</log_handlers>

The following example shows the default location for the standard log file is as follows, for Oracle Fusion application that are implemented in Java and SOA, where DOMAIN_HOME is the path to your Oracle WebLogic Server domain:

Example 13-2 Default Log File Location for Oracle Fusion Applications Implemented in Java and SOA

DOMAIN_HOME/servers/domain_name/logs/apps/server_name-diagnostic.log

For Oracle Fusion Applications code modules that are implemented in PL/SQL, the location of the standard log file is set by the AFLOG_PLSQL_FILENAME profile option. By default, the value of this profile option is APPLLOG_DIR/diagnostic.log, where APPLLOG_DIR is a directory object that was defined as a custom variable with the Oracle Fusion Applications Repository Creation Utility during installation.

If you do not have a record of the location of the APPLLOG_DIR directory, you can connect to the database for Oracle Fusion Applications using a database client, and use the following SQL query to obtain the location:

select DIRECTORY_PATH from ALL_DIRECTORIES where DIRECTORY_NAME = 'APPLLOG_DIR';

For Oracle Fusion Applications code modules that are implemented in C, the location of the standard log file is set by the AFLOG_FILENAME profile option. By default, the value of this profile option is diagnostic.log, but it is recommended that you set the value to directory_path/Cdiagnostic.log, where directory_path is a location that can be written to by all system users and by the Managed Server where Oracle Enterprise Scheduler is deployed for your Oracle Fusion applications. For example, you might set the value of directory_path to /tmp, or to an explicitly specified directory path that corresponds to the value of the APPLCP_DIR custom variable that was defined with the Oracle Fusion Applications Repository Creation Utility during installation.

By default, the following Oracle Fusion Applications code modules do not write log entries. If you configure these modules to write log entries, then the entries for those modules are written to nonstandard log file locations. These modules do not specify any configuration settings using the standard logging.xml file:

- Oracle Fusion Global Payroll

Note:

For optimum performance, it is recommended that you use the logging functionality that is available in the Oracle Fusion Global Payroll application only when troubleshooting an existing problem. For more information about using this feature and viewing the results, see the "Adjusting Oracle Fusion Global Payroll Log Settings for Troubleshooting" section and the "Viewing Special Log Output for Oracle Fusion Global Payroll" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

- The following kinds of batch jobs for Oracle Fusion Incentive Compensation:

- Calculation

- Classification

- Collection

- Crediting

- Rollup

Note:

For optimum performance, it is recommended that you use the logging functionality that is available for these kinds of Oracle Fusion Incentive Compensation batch jobs only when troubleshooting an existing problem. For more information about using this feature and viewing the results, see the "Adjusting Oracle Fusion Incentive Compensation Batch Jobs Log Settings for Troubleshooting" section and the "Viewing Special Log Output for Oracle Fusion Incentive Compensation" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

- The following kinds of batch jobs for Oracle Fusion General Ledger:

- OpenPeriod

- Posting

- Translation

- Close Process - Create Income Statement Closing Journals

- Close Process - Create Balance Sheet Closing Journals

Note:

For optimum performance and log file sizes, it is recommended that you use the logging functionality for these kinds of Oracle Fusion General Ledger batch jobs only when troubleshooting an existing problem. For more information about using this feature and viewing the results, see the "Adjusting Oracle Fusion General Ledger Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

- The AutoInvoice portion of the Oracle Fusion Receivables application

Note:

The amount of information that is logged for AutoInvoice depends on the value of the Log File Message Level system option setting for each business unit. Any AutoInvoice log messages that meet the level requirements are written to the standard log file for Oracle Enterprise Scheduler.

For more information about configuring the Log File Message Level system option setting, see Section 13.4.6.4. For more information about adjusting this setting for troubleshooting and viewing the results, see the "Adjusting Oracle Fusion Receivables AutoInvoice Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.3.7 Location of Logged Information When Using Multiple Managed Servers

Note:

The following information is provided for reference purposes. For maximum clarity and convenience, it is recommended that you use Fusion Applications Control to work with Oracle Fusion Applications log files, rather than working directly with the log files.

If an Oracle Fusion application is deployed to multiple Managed Servers in a cluster domain, each Managed Server records log entries in its own log file, for the transactions or other operations handled by that server.

For your convenience in monitoring Oracle Fusion applications that run on multiple Managed Servers, Fusion Applications Control lets you view either individual standard log files for individual Managed Servers or the aggregated contents of the standard log files of all of the servers in the cluster domain. The aggregated log is especially useful if you need to find a particular log entry but do not know which Managed Server recorded it. For more information about viewing log files, see Section 13.3.1.

Fusion Applications Control does not currently support viewing the contents of any nonstandard log files generated by Oracle Fusion Incentive Compensation, Oracle Fusion General Ledger, or the AutoInvoice portion of the Oracle Fusion Receivables application.

For information about viewing nonstandard log files for Oracle Fusion Incentive Compensation, see the "Viewing Special Log Output for Oracle Fusion Incentive Compensation" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

For information about viewing nonstandard log files for Oracle Fusion General Ledger, see the "Adjusting Oracle Fusion General Ledger Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

Log entries for the AutoInvoice portion of Oracle Fusion Receivables are placed in the standard log file for Oracle Enterprise Scheduler. For information about viewing Oracle Fusion Middleware log files, including log files for Oracle Enterprise Scheduler, see the "Viewing and Searching Log Files" section in the Oracle Fusion Middleware Administrator's Guide. For information about viewing nonstandard log files for Oracle Fusion Global Payroll, see the "Viewing Special Log Output for Oracle Fusion Global Payroll" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

Note:

When an Oracle Fusion application is deployed to multiple Managed Servers in a cluster domain, it is recommended that you set the log level to the same value for all of the Managed Servers, so that all of the servers will log comparable amounts and kinds of information. However, you can configure each Managed Server's log level independently, if you have a reason to do so.

13.4 Configuring Settings for Log Files During Normal Operation

Although critical business logic sections of Oracle Fusion applications may write more information to log files than less critical areas of the application code, the amount of information that Oracle Fusion applications log depends primarily on how the environment is configured. Oracle supplies default values for log settings, but you can specify different setting values if you want to adjust the amount of information to be logged. Most Oracle Fusion Applications components use a standard set of log configuration settings. For information about the selected components that use nonstandard log settings, see Section 13.4.6.

The concepts of logging levels and profile options apply to most Oracle Fusion applications. Logging levels are thresholds that can be set to control how much information to log.

To set logging levels either for a whole site or for a particular user, administrators change profile option values from either the Log Configuration dialog in Fusion Applications Control or the Manage Administrator Profile Values screen in the Setup and Maintenance work area. For more information, see Section 13.4.5.

To set logging levels for a particular product (for Oracle Fusion applications written in Java, only), administrators change profile option values from the Manage Administrator Profile Value screen in the Setup and Maintenance work area. For more information, see Section 13.4.5.

Under certain specific conditions, Oracle Fusion Applications users can set their own profile option for logging levels, from the Troubleshooting Options dialog available in the Troubleshooting section of the Oracle Fusion Applications Settings and Actions menu. Setting a logging level for a particular user is useful if you want only that user to gather more detailed log information while attempting to reproduce a problem. However, the Settings and Actions menu displays the Troubleshooting Options command only for Oracle Fusion Applications users who have a job role that is mapped to the following three duty roles:

- Supportability Level Management Duty (CRM) (FND_SET_SUPPORTABILITY_LEVEL_DUTY_CRM)

- Supportability Level Management Duty (FSCM) (FND_SUPPORTABILITY_LEVEL_MANAGEMENT_DUTY_FSCM)

- Supportability Level Management Duty (HCM) (FND_SUPPORTABILITY_LEVEL_MANAGEMENT_DUTY_HCM)

Note:

Oracle Fusion Applications seed data includes a preconfigured job role, BUSINESS FLOW TROUBLESHOOTING, that maps to these three duty roles. You can either assign this job role to any Oracle Fusion Applications user who needs temporary access to the Troubleshooting Options dialog box, or you can define a similar job role when you first need to give such a user access to the Troubleshooting Options dialog. Whichever way you proceed, you can reuse the same job role for other users who subsequently need the same access.

For more information about making the Troubleshooting Options command and dialog available to selected Oracle Fusion Applications users, and about working with those users to gather troubleshooting data, see the "Assisting Users in Gathering Data Using Troubleshooting Options" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

The following types of settings affect how logging is done, including the effective logging level:

- AFLOG_SettingName profile option values. For information about the AFLOG_SettingName profile options, see Section 13.4.1 through Section 13.4.5. For general information about working with profile options at both the SITE and USER levels, see the "Setting and Accessing Profile Values" and "Managing Profile Definitions" sections in the Oracle Fusion Applications Developer's Guide.

Note:

Among AFLOG_SettingName profile options, the following options currently support the use of the PRODUCT level in Oracle Fusion applications that are coded in Java or SOA: AFLOG_ENABLED, AFLOG_LEVEL, AFLOG_MODULE, and FND_MESSAGE_MODE.

- Oracle Diagnostics Logging Level: The log level for Oracle Fusion applications that are written in Java or SOA. The value for this setting is specified in each Managed Server's logging.xml file, in the oracle.apps.appslogger entry. Log levels for most entries are adjusted using the Managed Server's Log Configuration page in Fusion Middleware Control, rather than by directly editing the logging.xml file. However, the log level for the oracle.apps.appslogger entry should remain set to the default value of All unless Oracle Support gives you specific instructions to change it.

Caution:

The logging framework for Oracle Fusion Applications is designed to work with the Log Level for the oracle.apps.appslogger logger set to the default value of All. If you use other values for this setting, the diagnostic framework may not appear to work correctly, because setting values other than All can interfere with normal logging operations.

Related Links

The following document provides additional information related to subjects discussed in this section:

- For more information about profile options, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

13.4.1 Default System Log Settings

The seed data for Oracle Fusion Applications contains default values for many profile option settings. Normal operation settings for log files are described in the following table. For information about default system settings for incidents and QuickTrace, see the "Default System Settings for Incident Creation and QuickTrace" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

Table 13-1 Profile Options for Oracle Fusion Applications Logging

Profile Option Name
(and Display Name)

Environment

Description

Possible
Values or
Example

Applicable
Profile
Hierarchy
Levels

Default
Value for Site Level

AFLOG_BUFFER_MODE

(FND: Buffer Mode for PL/SQL)

PL/SQL only

Asynchronous buffer mode for PL/SQL logging. A value of 0 disables buffering; a value greater than 0 enables buffering for messages that have levels lower than WARNING. PL/SQL log messages that have SEVERE level or WARNING level are not buffered.

You may want to use asynchronous buffering if you have set your log levels to collect detailed information and find that your system is running slowly. When asynchronous buffering is enabled, log messages from PL/SQL code that are at the INFO log level or below are written to a buffer rather than being immediately written to a log file. This reduces disk I/O activity. The buffer is written to the log file only when it contains the number of records specified in the AFLOG_BUFFER_SIZE setting.

0, 1

Site, User

0

AFLOG_BUFFER_SIZE

(FND: Buffer Size for PL/SQL)

PL/SQL only

Number of PL/SQL log records that are buffered in memory before they are written to the log file, when AFLOG_BUFFER_MODE is set to enable asynchronous buffering. Increasing the number of records to be buffered may improve performance by reducing disk I/O activity.

1024

Site, User

1000

AFLOG_ENABLED

(FND: Log Enabled)

Java, PL/SQL, C, and SOA

Enables or disables standard logging functionality for Oracle Fusion Applications. If the value of this profile option is N, and if the profile option sets the effective logging level, then standard Oracle Fusion Applications logging does not occur at runtime for application modules written in Java, PL/SQL, SOA, or C. This profile option does not affect the configuration for Oracle Fusion Middleware.

Y, N

Site, User

Product level is supported for Oracle Fusion applications that are coded in Java or SOA.

Y

AFLOG_EXTENDED_ENABLED

(FND: Log Extension Enabled)

Java, PL/SQL, C, and SOA

Determines whether to log the following extended attributes:

- Message cause
(APPS_MESSAGE_CAUSE)

- User action
(APPS_USER_ACTION)

- User details
(APPS_USER_DETAILS)

- Admin action
(APPS_ADMIN_ACTION)

- Admin details
(APPS_ADMIN_DETAILS)

When the value of this profile option is Y, all of these extended attributes are logged. When the value of this profile option is N, none of these extended attributes are logged.

Y, N

Site

Y

AFLOG_FILENAME

(FND: Log File for C)

C only

Full path and file name of the log file for all of the Oracle Fusion applications that are written in C and that use standard logging functionality.

It is recommended that you set the value of this profile option to directory_path/
Cdiagnostic.log, where directory_path is a location that can be written to by all system users and by the Managed Server where Oracle Enterprise Scheduler is deployed for your Oracle Fusion applications. For example, you might set the value of directory_path to /tmp, or to an explicitly specified directory path that corresponds to the value of the APPLCP_DIR custom variable that was defined through use of the Oracle Fusion Applications Repository Creation Utility during installation.

If you do not set a directory path for this log file, the file is written to the default location specified by Oracle Enterprise Scheduler.

/temp/
Cdiagnostic.log

Site, User

diagnostic.log

AFLOG_LEVEL

(FND: Log Level)

Java, PL/SQL, C, and SOA

Minimum level of information detail to be logged for Oracle Fusion applications that use standard logging functionality. If no value is set for this profile option, the default value is 1000 (SEVERE).

For more information about log levels, see Section 13.4.3.

1000, 900, 800, 700, 500, 400, 300

Site, User

Product level is supported for Oracle Fusion applications that are coded in Java or SOA.

1000

AFLOG_MAX_FILE_SIZE

(FND: Maximum size for log file in MB.)

PL/SQL

Specifies the size in megabytes beyond which the current standard log file for Oracle Fusion applications that are written in PL/SQL is automatically renamed and a new log file is started.

10

Site

10

AFLOG_MODULE

(FND: Log Module Filter)

Java, PL/SQL, C, and SOA

Specifies the Oracle Fusion applications for which logging takes place. Use a comma-separated list of modules for the value of this setting, and use % as a wildcard. If no value is specified, all modules are logged.

%, %financial%

Site, User

Product level is supported for Oracle Fusion applications that are coded in Java or SOA.

%

AFLOG_NUMBER_OF_LOG_FILES

(FND: Number of old log files)

PL/SQL

The maximum number of PL/SQL log files the system keeps at any one time.

Any integer greater than 0.

Site

10

AFLOG_PLSQL_FILENAME

(FND: Log File for PL/SQL)

PL/SQL only

The location and name of the log file for standard Oracle Fusion Applications log messages that are generated from PL/SQL. The location must be expressed as a directory object.

By default, the SITE level value for this profile option is set to APPLLOG_DIR/
diagnostic.log, where APPLLOG_DIR is a directory object that was defined using the Oracle Fusion Applications Repository Creation Utility during installation.

If you want the log file name to indicate that the log messages are generated from PL/SQL, then you can change the AFLOG_PLSQL_FILENAME profile option value to a value such as APPLLOG_DIR/
plsqldiagnostic.log.

For more information about the location of APPLLOG_DIR, see Section 13.3.6.

APPLLOG_DIR/
mylog.log

Site, User

APPLLOG_DIR/
diagnostic.log

FND_MESSAGE_MODE

(Message Mode)

Java, PL/SQL, C, and SOA

For error conditions that use messages from the message dictionary, this setting determines whether administrator-level or user-level message details and suggested actions are displayed and logged.

ADMIN, USER

Site, Product, User

Product level is supported for Oracle Fusion applications that are coded in Java or SOA.

User

13.4.2 When Changes to Log File Configuration Settings Take Effect

For PL/SQL and C processes such as scheduled jobs, changes to log file profile options take effect in the same ways as changes to any Oracle Fusion Applications profile option values. For more information, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

For user sessions, users may need to log out from an Oracle Fusion application and log in again to have changes to log profile options take effect.

13.4.3 Standard Logging Levels

Seven severity levels are used for log messages in Oracle Fusion Applications, and each level is associated with a number. In circumstances where the effective logging level depends on the AFLOG_LEVEL logging profile option (rather than a lower odlLevel setting value), then, after the profile option level is set, only application messages that have a predefined severity level greater than or equal to the value of the AFLOG_LEVEL profile option are logged.

You can set the value of the AFLOG_LEVEL profile option to one value for the site as a whole and to another value for any user whose operations you want to log at a different level of detail. For Oracle Fusion applications that are written in Java or SOA, you can also set a separate value for the AFLOG_LEVEL profile option for a specific product.

For example, setting the level to the lowest severity, 300 (FINEST), for a particular user means that messages of all seven severities are logged for that user's operations. Similarly, setting the level to the lowest severity, 300 (FINEST), for a particular product means that messages of all seven severities are logged for that product's operations. Setting the level to 900 (WARNING) for the site means that logging occurs for 900 (WARNING) and 1000 (SEVERE) messages for all site operations except for operations of users or products that have different values for the AFLOG_LEVEL profile option.

Note:

The default severity level for the site level of Oracle Fusion Applications is 1000 (SEVERE). For optimum performance, it is recommended that you use this logging level for your sites unless you need to investigate a problem that specifically requires a change to a site's severity level. Gathering detailed log information for an entire site (rather than a single user) can decrease system performance and make it difficult to find relevant information in a log file.

The following table describes the three severity levels that are used for logging failures and normal events in Oracle Fusion Applications. The messages in the log file identify the severity of errors using the ODL Message Type/Level value.

Note:

Oracle Fusion applications that are written in PL/SQL have logging level names that start with LEVEL_. Oracle Fusion applications that are written in Java, SOA, and C do not use this LEVEL_ prefix for level names. For example, the log level that is called LEVEL_SEVERE in PL/SQL application code is comparable to the log level that is called SEVERE in Java, SOA, or C code.

Table 13-2 Severity Levels for Logging Failures and Normal Events

ODL Message Type/Level (in Log Files)

Log Level Name (in Oracle Enterprise Manager Fusion Applications Control and Settings and Actions > Troubleshooting Options)

AFLOG_LEVEL Profile Option Value (internal values stored in database tables)

Usage and Examples

ERROR:1

SEVERE

1000

Highest severity level. Unexpected errors that occur during normal execution. Irrecoverable exceptions or any other serious problems that require immediate attention from the System Administrator. An error at this level may also create an incident. For example, the following error messages might be associated with this log level:

The process cannot be started now because another process is using the data.

The participant's rate could not be found. Contact your benefits administrator to validate the standard rate for this compensation object.

WARNING:1

WARNING

900

Internal software failures. Exceptions or errors that allow processing to continue without requiring immediate attention from an administrator. Any potential problem that should be reviewed by the System Administrator.

For example, the following error message might be associated with this log level:

You must change your password before date.

NOTIFICATION:1

INFO

800

Errors, warnings, and other kinds of information that allow processing to continue. May include key flow steps, high-level functional progress messages, and major life cycle events such as the activation or deactivation of a primary subcomponent or feature.

Table 13-3 describes the four severity levels that are used for tracing and reporting progress in Oracle Fusion Applications. The messages in the log file identify the severity of errors using the ODL Message Type/Level value.

Note:

Oracle Fusion applications that are written in PL/SQL have logging level names that start with LEVEL_. Oracle Fusion applications that are written in Java, SOA, and C do not use this LEVEL_ prefix for level names. For example, the log level that is called LEVEL_CONFIG in PL/SQL application code is comparable to the log level that is called CONFIG in Java, SOA, or C code.

Most log levels provide information that is useful to Oracle Fusion Applications administrators. However, the information that is logged at the FINER and FINEST log levels is primarily intended for use by Oracle.

Table 13-3 Severity Levels for Tracing and Reporting Progress in Logs

ODL Message Type/Level (in Log Files)

Log Level Name (in Oracle Enterprise Manager Fusion Applications Control and Settings and Actions > Troubleshooting Options)

AFLOG_LEVEL Profile Option Value (internal values stored in database tables)

Usage and Examples

NOTIFICATION:16

CONFIG

700

Configuration properties and environment settings. This is a finer level of granularity for reporting normal events.

TRACE:1

FINE

500

High-level technical progress messages; more detailed than INFO level. Trace or debugging information for events that are meaningful to users of the product, such as public application programming interface (API) entry or exit points.

For example, the following error message might be associated with this log level:

User has chosen to cancel the Purge operation.

TRACE:16

FINER

400

Logging messages that are called at the beginning and end of a routine. Detailed trace or debugging information that can help Oracle Support diagnose problems with a particular subsystem.

For example, the following error message might be associated with this log level:

Entering validateLogin.

TRACE:32

FINEST

300

Very detailed trace or debugging information that would be useful to an Oracle developer who is working on the product and who is familiar with implementation details of the subsystem that generates the message.

For example, the following error message might be associated with this log level:

Copying string from buffer xyz to
buffer zzz.

Note:

Whenever an incident is created, a different log level, INCIDENT_ERROR, automatically appears in the corresponding log entry. This is the only context in which the INCIDENT_ERROR log level is used. For more information about working with incidents, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.4.4 Managing Log File Size and Disk Space Usage

In busy computing environments, the amount of disk space used by log files can become a concern. Large log files can also affect system performance. Oracle Fusion applications that are written in Java, SOA, or PL/SQL address this concern using automatic log file rotation.

Note:

Oracle Fusion applications that are written in C require you to monitor the space used and manually discard log files that are no longer needed.

13.4.4.1 Managing Rotating Log File Space Usage for Java and SOA Applications

For Oracle Fusion Applications modules that are implemented using Java or SOA and that use standard logging, when a the log file reaches a specific size or when a specific time period has passed, the file is automatically renamed, and a new log file is created.

To adjust the settings that determine the maximum log file size and the maximum length of time that a log file covers, use Fusion Middleware Control commands to change the log rotation policies for the oracle.apps.appslogger logger. For more information, see the "Specifying Log File Rotation Using Fusion Middleware Control" section in the Oracle Fusion Middleware Administrator's Guide.

The maxFileSize or Maximum Log File Size setting determines the maximum size that a standard Java or SOA log file can reach before being renamed. The default value is 10,485,760 bytes.

The rotationFrequency or Frequency setting determines the maximum amount of time that can pass before a standard Java or SOA log file is renamed. There is no default value for this setting. If no value is specified, then the log file is not renamed after any particular time period, but only when it reaches its maximum allowed size. Valid values for the rotationFrequency setting are numbers representing the length of the time period in minutes, and the following case-insensitive values:

- Hourly

- Daily

- Weekly

When a standard Java or SOA log file is renamed, the new name is of the format log_file_name-n.log, where n is a positive integer and log_file_name is the file name specified for the path property of the apps-handler log handler in the logging.xml file. (By default, log_file_name is set to server_name-diagnostic.log.)

In log_file_name-n.log, the value of n depends on the names of the log files that are already present in the directory. If the directory contains no previously renamed log files, then the first renamed log file is called log_file_name-1.log. If other log files exist, then n is set to the next higher integer after the highest integer that is already in use. For example, if the directory contains log_file_name-1.log through log_file_name-8.log at the time when log_file_name.log reaches a time or size limit, then the log_file_name.log file is renamed to log_file_name-9.log

When the aggregated size of current and older log files reaches a specific value, older log files are deleted automatically, to keep the disk space usage of the log file directory below that specific value.

The maxLogSize or Maximum Size of All Log Files setting determines the directory size at which older log files begin to be deleted. The default value is 104,857,600 bytes.

Related Links

The following document provides additional information related to subjects discussed in this section:

- For information about using Oracle WebLogic Scripting Tool (WLST) Log Configuration commands to adjust the settings that determine the maximum log file size and the maximum length of time that a log file covers, see the section about the configureLogHandler command in the chapter on logging commands in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference and "Specifying Log File Rotation Using WLST" in the Oracle Fusion Middleware Administrator's Guide. (Using WLST commands to change log rotation policies for the apps-handler log handler is a possible alternative to using Fusion Middleware Control commands change the log rotation policies for the oracle.apps.appslogger logger.)

13.4.4.2 Managing Rotating Log File Space Usage for PL/SQL Applications

For Oracle Fusion Applications modules that are implemented using PL/SQL, when a diagnostic.log file reaches a specific size, the diagnostic.log file is automatically renamed, and a new diagnostic.log file is created. If the AFLOG_PLSQL_FILENAME profile option is set so that the logging framework uses a log file name other than diagnostic.log, then the file name that the profile option specifies is used, instead of diagnostic.log.

Use the following profile options settings to specify the maximum log file size:

- AFLOG_MAX_FILE_SIZE: This setting specifies the size in megabytes beyond which a PL/SQL log file name is automatically renamed and a new log file is started. The default value is 10 megabytes.

Note:

If the AFLOG_BUFFER_MODE profile option is set to a value larger than 0, enabling asynchronous buffering of PL/SQL log entries, then the actual maximum size of any single PL/SQL log file is the value of AFLOG_MAX_FILE_SIZE plus the number of megabytes that are flushed from the buffer. This value is approximate, because the amount of information that can accumulate in the buffer is set using the AFLOG_BUFFER_SIZE setting, which specifies a specific number of log records, rather than a specific number of megabytes.

- AFLOG_NUMBER_OF_LOG_FILES: This setting specifies the maximum number of PL/SQL log files the system keeps at any one time. The default value is 10 files.

PL/SQL log rotation is currently done only on the basis of file size, not on the basis of the passage of a specified amount of time.

When a PL/SQL log file is renamed, the new name depends on whether the AFLOG_PLSQL_FILENAME profile option is set:

- If the profile option is set, then the new log file name is of the format AFLOG_PLSQL_FILENAME_value-n.log, where n is a positive integer.

- If the profile option is not set, then the new log file name is of the format diagnostic-n.log, where n is a positive integer.

The value of n depends on the names of the log files that are already present in the directory. If the directory contains no previously renamed log files, then the first renamed log file is called diagnostic-1.log or AFLOG_PLSQL_FILENAME_value-1.log. If other log files exist, then n is set to the next higher integer after the highest integer that is already in use. For example, if the directory contains diagnostic-1.log through diagnostic-8.log at the time when the diagnostic.log file surpasses the size limit set in the AFLOG_MAX_FILE_SIZE profile option, then the diagnostic.log file is renamed to diagnostic-9.log.

When the number of log files reaches the value specified using the AFLOG_NUMBER_OF_LOG_FILES profile option, then older log files are deleted automatically, to prevent the disk space usage of the log file directory from getting too large.

Over time, the value of n in diagnostic-n.log or AFLOG_PLSQL_FILENAME_value-n.log can become large enough to cause usability challenges or exceed the number of characters that the operating system allows in a file name. If you want to have the value of n start over at 1, you can move all existing log files except the currently active diagnostic.log file or AFLOG_PLSQL_FILENAME_value.log file into another directory. When the active file surpasses the size limit and the log rotation code finds no previously renamed log files in the directory, the active file is renamed using a value of 1 for n.

Note:

If your Oracle Fusion Applications environment includes multiple database nodes such as Oracle Real Application Clusters (RAC), then each database node corresponds to a server instance that has its own location for log files.

If an incident is created, then the server instance that creates the incident handles all subsequent jobs related to that incident. Identifiers for incidents are unique within a specific instance, but not across instances. For more information about working with incidents, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.4.4.3 Managing Log File Space Usage for C Applications

Oracle Fusion Applications modules that are implemented in C currently produce log files that continually increase in size.

To manage log file space usage for log files created by Oracle Fusion Applications modules that are written in C:

1. Navigate to the directory that contains the log files:

- If the AFLOG_FILENAME profile option is set, then navigate to the location designated by the profile option value.

- If the AFLOG_FILENAME profile option is not set, then navigate to the location set by Oracle Enterprise Scheduler Service.
You can use Fusion Applications Control to determine the location of Oracle Enterprise Scheduler log files, as follows:

1. In the navigation pane, expand the farm part of the navigational tree, then expand Scheduling Services, and then select an Oracle Enterprise Scheduler server as your target.

2. In the context pane, from the Scheduling Service dropdown menu, choose Logs > View Log Messages.

3. Click Target Log Files to view a list of log files associated with the selected server.
For example, a typical path and file name might be the following, where DOMAIN_HOME is the domain home directory, SERVER_HOME is the server home directory, and serverName is the name of the Oracle Enterprise Scheduler server:

DOMAIN_HOME/servers/SERVER_HOME/logs/serverName-diagnostic.log

2. Rename the log file that is currently in use.
For example, if the current log file is called Cdiagnostic.log, you might rename it to Cdiagnostic_MMDDYYYY.log, where MMDDYYYY is the current date.

3. Delete any previously renamed log files that you no longer need.

13.4.5 Using Profile Options to Configure Standard Log Settings

Oracle Fusion applications that use standard logging functionality use profile option values to configure how much information to log. Ordinarily, these profile options are set at the Site level, but some can also be set at the Product or User level, to gather more information into the log file for a particular product or user.

Note:

For information about configuring profile option values for incident and QuickTrace settings, see the "Configuring Log, QuickTrace, and Incident Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

You can use either Fusion Applications Control or the Setup and Maintenance work area to configure most profile options for standard Oracle Fusion Applications logging functionality. However, some settings may be available in only one of those two locations. For example, you can set the AFLOG_FILENAME profile option for an individual user by using the Manage Administrator Profile Values screen in the Setup and Maintenance work area, but not by using Fusion Applications Control. For information about how to use the Setup and Maintenance work area for setting profile option values, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

Note:

To set logging profile option values that affect other users, you must log in as a user who has the Manage All Application Profile Values function security privilege. By default, this privilege is carried by the Applications Common Application Profile Value Administration Duty role, which the predefined Application Administrator job role inherits. You can use Oracle Identity Manager to determine whether you have the Application Administrator job role.

If you want to change profile option values for others without being provisioned with the Application Administrator job role or the Applications Common Application Profile Value Administration Duty role, then you can use Oracle Authorization Policy Manager to determine which other duty roles have the Manage All Application Profile Values function security privilege and which job roles inherit those duty roles. You can use Oracle Identity Manager to make sure that you have a job role that inherits one of those duty roles.

For more information about working with roles and privileges, see the Oracle Fusion Middleware User's Guide for Oracle Identity Manager and the Oracle Fusion Applications security guides.

To use Fusion Applications Control to configure profile options for standard Oracle Fusion Applications logging functionality:

1. From the navigation pane, select any of the following target types:

- A product family target that lets you configure the log profile options for all of the Oracle Fusion applications in the selected product family. For example, you could select the Financials product family target.

- An Oracle Fusion Applications cluster application target that lets you configure the log profile options for the selected application on all of the servers in the selected cluster. For example, you could expand Financials and Fusion Applications and then select the PayablesApp cluster application target.

- An Oracle Fusion application instance target that lets you configure the log profile options for the selected application on the selected sever. For example, you could expand Financials and Fusion Applications and PayablesApp and then select the PayablesApp (PayablesServer_1) application instance target.

To configure logging profile options at the product level, skip to Step 6.

2. In the context pane, from the target type dropdown menu, choose Logs > Log Configuration.

3. In the Logging Profile Configuration dialog, click one of the following tabs to determine whether you set the logging level for the whole site or for a single user:

- Site-Level

- User-Level

4. If you clicked Site-Level, then skip to Step 5.
If you clicked User-Level, then complete the following substeps:

1. Inspect the table on the User-Level tab for the user name for which you want to change logging levels.
If the user name is listed, then select it and click Edit to display the Edit User-Level Configuration dialog.

If the user name is not listed, then click Add and enter it in the Name field of the Add Logging Profile Configuration dialog.

2. From the Log Level dropdown list, select the log level that corresponds to the kinds of information you want to gather.
For more information, see Table 13-2 and Table 13-3.

3. In the Logging Enabled field, make sure that the checkbox is selected.

4. In the Module Filters field, indicate if you want Oracle Fusion Applications to log only for a particular code module for the selected user—by default, log entries are written for all Oracle Fusion Applications code modules that use standard logging implementation for Oracle Fusion Applications.

Note:

If you specify that logging for the selected user should be done only for a particular code module, that setting will not affect the information that is logged for other users.

5. If you want to change whether PL/SQL modules buffer log entries of levels lower than Warning, then expand the Advanced profile configuration section of the dialog and select Enabled or Disabled for the Buffer Mode setting.

6. If Buffer Mode is set to Enabled and you want to change the number of PL/SQL log records that will be buffered in memory before they are written to the log file, then enter the number of records to buffer in the Buffer Size field.

7. If you want PL/SQL log records to be written to a log file location other than the default, then enter the path and file name in the File Name field in the PL/SQL Settings section.

Note:

If you want a particular user's C log records to be written to a log file location other than the default, then you must change the value of the user's AFLOG_FILENAME profile option using the Manage Administrator Profile Values screen in the Setup and Maintenance work area, rather than Fusion Applications Control. For information about how to use the Setup and Maintenance work area for setting profile option values, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

8. Click OK.

Skip all remaining steps of this procedure.

5. If you clicked Site-Level, complete the following substeps:

1. From the Log Level dropdown list, select the log level that corresponds to the kinds of information you want to gather.
For more information, see Table 13-2 and Table 13-3.

2. Make sure that both Logging Enabled and Incident Enabled are selected.

3. In the Module Filters field, indicate if you want Oracle Fusion Applications to log only for a particular code module—by default, log entries are written for all Oracle Fusion Applications code modules that use standard logging implementation for Oracle Fusion Applications.

4. Expand the Advanced profile configuration section of the dialog.

5. In the Java Settings section of the dialog, for purposes of normal operation, verify that the QuickTrace Enabled checkbox is selected and that QuickTrace Level is set to Fine.
For more information about changing QuickTrace settings for troubleshooting, see the "Adjusting QuickTrace Configuration Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

6. If you want to change whether PL/SQL modules buffer log entries of levels lower than Warning, then select Enabled or Disabled for the Buffer Mode setting.

7. If Buffer Mode is set to Enabled and you want to change the number of PL/SQL log records that will be buffered in memory before they are written to the log file, then enter the number of records to buffer in the Buffer Size field.

8. If you want PL/SQL log records to be written to a log file location other than the default, then enter the path and file name in the File Name field in the PL/SQL Settings section.

9. If you want C log records to be written to a log file location other than the default, then enter the path and file name in the File Name field in the C Settings section.

10. Click Apply.

11. Skip all remaining steps of this procedure.

6. To configure logging profile options at the product level, complete the following sub-steps:

1. From the Tools section of the Navigator menu, choose Setup and Maintenance.

2. In the Overview screen that appears, click the All Tasks tab.

3. In the Match field of the Search panel, select All.

4. In the Search field, select Task Lists and Tasks.

5. In the Name field, enter Manage Administrator Profile Values.

6. Click Search.

7. In the Search Results panel, click the Go to Task icon for Manage Administrator Profile Values.
The following log profile options currently support the use of the product level in Oracle Fusion applications that are coded in Java or SOA: AFLOG_ENABLED, AFLOG_LEVEL, AFLOG_MODULE, and FND_MESSAGE_MODE.

8. In the Profile Option Code field of the Search: Profile Option pane, enter AFLOG% or FND_MESSAGE_MODE and then click Search.

9. In the Search Results pane, locate and select the profile option that you want to set at the product level.

10. Scroll down and inspect the pane that lists the values of the selected profile option.
If there is a row in which the Profile Level column contains the value Product, and in which the Product Name column contains the name of the product for which you are changing settings, then enter your chosen value in the Profile Value field for that row.

If there is no row in which the Profile Level column contains the value Product, and in which the Product Name column contains the name of the product for which you are changing settings, then click the plus sign icon (+) to create a new row, and complete the fields.

11. Click Save or Save and Close.

13.4.6 Using Additional Settings to Configure Logs for Selected Components

Some functionality areas in Oracle Fusion Applications use nonstandard logging mechanisms that are disabled by default. For these areas, you must turn on the logging facility when you need it and specify the kind of information that you want to record in the log file. Some other functionality areas use nonstandard logging mechanisms that are usually set to gather minimal amounts of information. You may want to change those settings when troubleshooting.

13.4.6.1 Configuring Additional Log Settings for Oracle Fusion Global Payroll

The logging functionality for the Oracle Fusion Global Payroll application is separate from the standard logging functionality for Oracle Fusion Applications. By default, the Oracle Fusion Global Payroll application does not write log entries. For optimum performance and log file sizes, it is recommended that you use Oracle Fusion Global Payroll logging functionality only when troubleshooting an existing problem. For more information, see the "Adjusting Oracle Fusion Global Payroll Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.4.6.2 Configuring Additional Log Settings for Oracle Fusion Incentive Compensation Batch Jobs

The logging functionality for certain Oracle Fusion Incentive Compensation batch jobs is separate from the standard logging functionality for Oracle Fusion Applications. By default, the following kinds of Oracle Fusion Incentive Compensation batch jobs do not write log entries:

- Calculation

- Classification

- Collection

- Crediting

- Rollup

For optimum performance and log file sizes, it is recommended that you use the logging functionality for these areas only when troubleshooting an existing problem. For more information, see the "Adjusting Oracle Fusion Incentive Compensation Batch Jobs Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.4.6.3 Configuring Additional Log Settings for Oracle Fusion General Ledger

In the Oracle Fusion Financials product family, some logging functionality for the Oracle Fusion General Ledger application is separate from the standard logging functionality for Oracle Fusion Applications. By default, the following kinds of Oracle Fusion General Ledger batch jobs do not write log entries:

- OpenPeriod

- Posting

- Translation

- Close Process - Create Income Statement Closing Journals

- Close Process - Create Balance Sheet Closing Journals

For optimum performance and log file sizes, it is recommended that you use the logging functionality for these areas only when troubleshooting an existing problem. For more information, see the "Adjusting Oracle Fusion General Ledger Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

13.4.6.4 Configuring Additional Log Settings for Oracle Fusion Receivables AutoInvoice

In the Oracle Fusion Financials product family, logging functionality for the AutoInvoice portion of the Oracle Fusion Receivables application is separate from the standard logging functionality for Oracle Fusion Applications. The amount of information that is logged for AutoInvoice depends on the value of the Log File Message Level system option setting.

To set the amount of information that the Oracle Fusion Receivables application logs for the AutoInvoice functionality area:

1. In the Oracle Fusion Receivables application, choose Setup and Maintenance from the Navigator menu.

2. Complete the following substeps to navigate to the Edit System Options screen for the Manage Receivables System Options task.

1. On the All Tasks tab, expand the Search pane.

2. Enter Manage Receivables System Options in the Name field and click Search.

3. In the Manage Receivables System Options row of the Search Results table, click Go to Task.

4. In the Search area of the Manage Receivables System Options screen, select Business Unit from the dropdown list, enter the name of a business unit for which you want to set up the amount of AutoInvoice information to be logged, and then click Search.
Alternately, you can click Search without specifying a business unit name to display a list of the available business units.

5. In the Search Results table, click the name of the business unit for which you want to set up the amount of AutoInvoice information to be logged.

3. In the Edit System Options screen, scroll down to display the AutoInvoice area of the screen, and then set Log File Message Level to the value of 0, which is the recommended value for normal operations.

Note:

For optimum performance and log file sizes, it is recommended that you keep the Log File Message Level system option set to the lowest value that meets your everyday needs, and increase the value of the setting only when troubleshooting an existing problem. For more information about using this setting when troubleshooting, see the "Adjusting Oracle Fusion Receivables AutoInvoice Log Settings for Troubleshooting" section in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

4. Click Save or Save and Close to put your changes into effect.
Repeat this entire procedure for each additional business unit for which you want to configure AutoInvoice system options.

For information about configuring the Maximum Memory in Bytes system option for AutoInvoice, see your product-specific documentation in Oracle Fusion Applications Help.

13.4.7 Configuring Access to Logs for Fusion Applications Control

By default, you can use Fusion Applications Control to view log file entries that are generated by Java code in Oracle Fusion applications. To make it possible to view log file entries that are generated by PL/SQL or C code, you must perform the following configuration steps.

To make PL/SQL and C log file entries visible in Fusion Applications Control:

1. Determine the locations of the PL/SQL and C log files written by your Oracle Fusion applications.

If the values of the AFLOG_PLSQL_FILENAME and AFLOG_FILENAME profile options have been set, then those values determine log file locations for PL/SQL and C log files, respectively. For more information about these profile options and the log file locations that are used when these profile options are not set, see Section 13.3.6 and Section 13.4.1.

2. Decide which Managed Server you want to use to view PL/SQL log files, C log files, or both, and make sure that the server has read access to all of the log file locations that you determined in Step 1.

It is recommended that you use an Oracle WebLogic Server that runs Oracle Enterprise Scheduler for this purpose.

Note:

If you want to use more than one Managed Server to view PL/SQL log files, C log files, or both, then you can do so, provided that each server has read access to the log files that you want to view through that server. However, it is not especially valuable to use multiple servers to view a particular log file, because each server is providing access to the same data.

3. On the Managed Server that you picked in Step 2, navigate to the following location, where DOMAIN_HOME is the domain home for the Managed Server and server_name is the name of the Managed Server:

DOMAIN_HOME/config/fmwconfig/servers/server_name/diagnostics-registration

If this location does not currently exist, create it now.

4. In the diagnostics-registration subdirectory, for each log file that you determined in Step 1 and want to view using this server, use a text editor to create and save a file that contains the following lines, using any file name that has the format yourChosenFileName.xml:

<?xml version='1.0' encoding='UTF-8'?>
<logs xmlns='http://www.oracle.com/iAS/EMComponent/ojdl'>
<log path="path_to_log_file">
<logreader class="oracle.core.ojdl.reader.ODLLogReaderFactory">
</logreader>
</log>
</logs>

Substitute the full path and name of the log file for path_to_log_file, using the form of the path that is correct for the current server to use when accessing the file:

- For a PL/SQL log, make sure that the value for path_to_log_file corresponds to the same location and file name as the value that you have set for the AFLOG_PLSQL_FILENAME profile option.

Note:

You must resolve and enter the full path to the path_to_log_file location, explicitly, rather than entering the directory object that is used to set the value of the AFLOG_PLSQL_FILENAME profile option.

- For a C log, make sure that the value for path_to_log_file indicates the same location and file name as the value that you have set for the AFLOG_FILENAME profile option.

Repeat this step, as needed, to create an individual .xml file for each log file that you determined in Step 1 and want to view using this server. You can save each file using any unique valid file name that ends in .xml. For example, the file name might be plsqlfndlog.xml for a PL/SQL log and cfndlog.xml for a C log.

5. In Fusion Applications Control, verify that each log file from Step 1 is now listed in an appropriate Target Log Files list:

1. From the navigation pane, select a target for which you created an .xml file.

For example, you might expand the Financials product family entry, and then expand the Fusion Applications and PayablesApp entries, and then select the PayablesApp (PayablesServer_1) application instance target.

2. In the context pane, from the dynamic target menu, choose Logs > View Log Messages to display the log messages for the selected target.

3. Click Target Log Files.

4. Verify that the resulting list includes the all of the log files that are applicable for the selected target, including any applicable log files for which you created .xml files.

The View Log Message page includes information from all log files that appear on this list.

6. Repeat Step 5 for any other targets for which you created an .xml file.

14 Managing Oracle Fusion Applications Diagnostic Tests

This chapter describes how to use diagnostics tests to support normal operations for Oracle Fusion Applications and to prepare for future troubleshooting.

This chapter contains the following topics:

- Section 14.1, "Understanding Oracle Fusion Applications Diagnostic Tests and the Diagnostic Framework"

- Section 14.2, "Configuring the Diagnostic Testing Framework for Normal Operation"

- Section 14.3, "Using Diagnostic Tests to Monitor Normal System Health"

For information about troubleshooting using diagnostic tests, incidents, log files, and QuickTrace, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide. For more information about configuring and using log files and about configuring incident and QuickTrace settings for normal operation, see Chapter 13.

14.1 Understanding Oracle Fusion Applications Diagnostic Tests and the Diagnostic Framework

Diagnostic tests are executables that are designed to exercise particular aspects of Oracle Fusion applications, to determine whether they are operating correctly and to help identify and resolve any problems. The Oracle Fusion Applications Diagnostic Testing Framework (Diagnostic Testing Framework) lets you execute diagnostic tests and collects the results into detailed diagnostic reports. Oracle provides diagnostics tests that are installed along with Oracle Fusion Applications releases and patches.

You can use diagnostic tests along with information from log files and the collections of error condition information that are called incidents.

14.1.1 Relationships Between Diagnostic Tests, Incidents, and Log Messages

Oracle developers create diagnostic tests that you can use to help diagnose and resolve Oracle Fusion application problems.

Oracle developers use mechanisms such as application programming interface (API) calls in Oracle Fusion Applications code to record application operations in log files and to provide error messages as appropriate. A diagnostic test may or may not be associated with a particular error message.

If an Oracle Fusion application handles a particular error in a way that triggers the creation of an incident, then any diagnostic tests that are associated with the error message for the incident run automatically. Oracle developers accomplish this by setting the value of each diagnostic test's APPS_MSG_ID tag to match the identifier of any error message that should trigger the automatic execution of that test. There is no configuration setting for disabling this automatic execution of diagnostic tests.

The results of any automatically run diagnostic test are automatically associated with the related incident, and the identity of the user who received the error message is recorded.

For more information about using diagnostic tests and log files to help diagnose a problem, see the "Troubleshooting Oracle Fusion Applications Using Incidents, Logs, QuickTrace, and Diagnostic Tests" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide. For more information about configuring and using log files during normal operation, see Chapter 13.

It is important to be familiar with the following additional concept that is related to diagnostic tests:

Seed data is information that Oracle provides to you in the form of database records. Diagnostic tests are included in seed data.

14.1.2 Standard Diagnostic Testing Administration Tasks and Tools

Under ordinary circumstances, the following administrative tasks are associated with Oracle Fusion Applications diagnostic tests:

- Configuring security to provide appropriate access to diagnostic tests. You can assign job roles to particular users to grant those users the ability to perform various diagnostic operations. For more information, see Section 14.2.1.

Note:

In the current release, a job role for diagnostic operations grants the user the ability to perform the specified operations for all diagnostic tests that are provided with Oracle Fusion Applications. When choosing whether to grant a diagnostic job role to specific users, be aware that some diagnostic tests may include sensitive information in their results.

- Running diagnostic tests. You can use diagnostic tests for the following purposes:

- Routinely checking the health of your Oracle Fusion applications

- Troubleshooting a problem with an Oracle Fusion application

- Collecting detailed data that may help Oracle Support to resolve a problem for you

Some diagnostic tests require a specific Oracle Fusion application to be running while the test is performed—these diagnostic tests are called internal diagnostic tests. Other diagnostic tests can perform their functions even if the Oracle Fusion application to be tested is not running—these tests are called external diagnostic tests.

The distinction between internal and external tests is important because it affects both when you can run the tests and which interfaces you can use to run the tests. The Diagnostic Testing Framework provides two interfaces:

- The Oracle Fusion Applications Diagnostic Dashboard application (Diagnostic Dashboard) provides a graphical user interface that lets you perform the following tasks:

- Execute and monitor both internal and external diagnostic tests for Oracle Fusion applications

- Purge diagnostic test results

- Register any special-purpose diagnostic tests that Oracle Support may provide to you

- The diagctl command-line interface lets you perform the following tasks:

- Execute external diagnostic tests (tests that do not require a specific Oracle Fusion application to be running)

Note:

Technical constraints prevent the diagctl command-line interface from returning useful results for internal diagnostic tests (tests that require a specific Oracle Fusion application to be running when the test is performed). You must use Diagnostic Dashboard to run any internal diagnostic tests.

You must also use Diagnostic Dashboard to determine whether a particular test is an internal or an external test. For more information about making this determination, see Step 9 through Step 11 in Section 14.3.1.1.

- View diagnostic test results

- Register any special-purpose diagnostic tests that Oracle Support may provide to you

14.2 Configuring the Diagnostic Testing Framework for Normal Operation

You can use diagnostic tests to check normal system health and to troubleshoot system problems. You can configure your Oracle Fusion Applications environment to run all Oracle Fusion Applications diagnostic tests using the Diagnostic Dashboard application, and to run external diagnostic tests using the diagctl command-line interface.

Note:

Technical constraints prevent the diagctl command-line interface from returning useful results for internal diagnostic tests (tests that require a specific Oracle Fusion application to be running when the test is performed). You must use Diagnostic Dashboard to run any internal diagnostic tests.

You must also use Diagnostic Dashboard to determine whether a particular test is an internal or an external test. For more information about making this determination, see Step 9 through Step 11 in Section 14.3.1.1.

Both the Diagnostic Dashboard application and the diagctl command-line interface are automatically installed as part of the Oracle Fusion Applications installation. However, you must assign appropriate job roles to specific users to give them the ability to display and perform operations using the Diagnostic Dashboard application. Access to the diagctl command-line interface is controlled at the level of the server operating system. For more information about granting appropriate access, see Section 14.2.1.

For proper operation of the diagctl command-line interface, you must also set certain environment variables. For more information about setting these variables, see Section 14.2.3.

To help you locate diagnostic tests for specific purposes, the diagnostic tests that you receive with Oracle Fusion applications are all assigned to predefined categories.

Note:

You cannot change the tag name and tag value assignments that Oracle uses to categorize diagnostic tests, and you cannot remove those tag names or tag values from the database. The following related links in the Task pane of the Diagnostic Dashboard application are intended for use by Oracle personnel only:

- Add New Tag

- Add New Tag Value

- Assign Tags to Tests

- Unassign Tags from Tests

- Remove Tag

- Remove Tag Value

Caution:

Do not attempt to modify the diagnostic test seed data provided to you by Oracle. Unauthorized modification of this seed data may prevent diagnostic tests from functioning correctly, lengthening the amount of time required to resolve both current and future problems.

14.2.1 Controlling Access to Diagnostic Testing Functionality

Access to diagnostic testing functionality is controlled separately for Diagnostic Dashboard and the diagctl command-line interface.

For the diagctl command-line interface, access is controlled at the level of the server operating system. If a user can log in to the server where diagctl is stored, and if that user has operating system permissions to read and execute diagctl, then that user can use diagctl to perform all diagnostic operations that the command-line interface supports.

For Diagnostic Dashboard, you can use Oracle Identity Manager to assign specific users to any of the four preconfigured job roles that grant users access to Diagnostic Dashboard. Each of these four job roles provides access to a different amount of the functionality of the dashboard.

Note:

Oracle Fusion applications display the Troubleshooting section and the Run Diagnostic Tests command in the Settings and Actions menu only for users who are associated with the preconfigured job roles that grant access to Diagnostic Dashboard operations.

- The Diagnostic Viewer job role can view and analyze diagnostic test results for Oracle Fusion applications.

- The Diagnostic Regular User job role can execute diagnostic test runs and view diagnostic test results for Oracle Fusion applications, and cancel diagnostic test runs that were started by the current user.

- The Diagnostic Advanced User job role can schedule and execute diagnostic test runs, view diagnostic test results, attach test results to application incidents for Oracle Fusion applications, and cancel diagnostic test runs that were started by the current user. In general, this job role is recommended for running Oracle Fusion Applications diagnostic tests, because its added capabilities allow users to work with administrators more flexibly during troubleshooting.

- The Diagnostic Administrator job role can use all of the diagnostic testing functionality provided for Oracle Fusion applications, including purging test results from the database and canceling test runs started by other users.

Note:

In the current release, any job role for diagnostic operations grants the user the ability to perform the role's specified operations for all diagnostic tests that are provided with Oracle Fusion applications. When choosing whether to grant any diagnostic job role to specific users, be aware that some diagnostic tests may include sensitive information in their results.

To grant specific users permission to use Diagnostic Dashboard:

1. Decide which users need the capabilities of each of the four preconfigured job roles for diagnostic operations.

2. Use Oracle Identity Manager to assign the appropriate job role to each user.

14.2.2 Navigating to the Diagnostic Dashboard Application

The Diagnostic Dashboard application for Oracle Fusion Applications provides a graphical user interface that lets you execute and monitor diagnostic tests, display and purge test results, and register any special-purpose diagnostic tests that Oracle Support may provide to you. Each product family within Oracle Fusion Applications has its own instance of Diagnostic Dashboard. Provided that you are assigned to an appropriate job role, you can navigate to Diagnostic Dashboard from any Oracle Fusion application or from Oracle Enterprise Manager Cloud Control (Cloud Control).

14.2.2.1 Navigating to the Diagnostic Dashboard Application from an Oracle Fusion Application

If you want to use Diagnostic Dashboard to execute or monitor diagnostic tests or display or purge test results while you are using an Oracle Fusion application, you can navigate to Diagnostic Dashboard directly from the application.

To display the Diagnostic Dashboard application from an Oracle Fusion application:

1. Sign in to the relevant Oracle Fusion application as a user who has access to the specific Diagnostic Dashboard operations that you need.
For more information about the job roles that grant access to Diagnostic Dashboard operations, see Section 14.2.1.

2. From Troubleshooting section of the Settings and Actions menu in the application, choose Run Diagnostic Tests to display Diagnostic Dashboard.

Note:

Oracle Fusion applications display the Troubleshooting section and the Run Diagnostic Tests command in the Settings and Actions menu only for users who are assigned to the preconfigured jobs roles that grant access to Diagnostic Dashboard operations. For more information about these job roles, see Section 14.2.1.

14.2.2.2 Navigating to the Diagnostic Dashboard Application from Cloud Control

If you want to use the Diagnostic Dashboard application to execute or monitor diagnostic tests or display or purge test results while you are using Cloud Control, such as while you are using Support Workbench to gather additional information about an existing incident, you can navigate to Diagnostic Dashboard directly from Cloud Control.

To display to Diagnostic Dashboard from Cloud Control:

1. In Oracle Enterprise Manager, select the product family or cluster application for which you want to run diagnostic tests or view diagnostic test results.

2. From the dynamic dropdown menu, choose Diagnostics > Fusion Applications Diagnostic Dashboard.
A login screen for Diagnostic Dashboard appears in a new window.

3. Log in using an account for the Oracle Fusion Applications product family that you intend to test.
The account that you use must also be assigned to a job role that provides access to Diagnostic Dashboard. For more information, see Section 14.2.1.

14.2.3 Configuring Required Variables for the diagctl Command Line Interface

To operate properly, the diagctl command-line interface requires you to set certain environment variables.

Note:

You must set the required environment variables for each session that plans to use the diagctl command-line interface. For your convenience, you may want to add the commands that define these variables to the .profile or .bashrc files of all users who will run diagctl.

To set environment variables for a user of the diagctl command-line interface:

1. Log in to the operating system of the Administration Server of the Common domain.

2. Use a command such as the following to set the DIAGJPSCONFIGFILE environment variable to the location of the jps-config-jse.xml file, making these substitutions:
In the command, replace APPLICATIONS_CONFIG with the location of the top-level directory of Oracle Fusion Applications configuration files. For more information about APPLICATIONS_CONFIG (and APPLICATIONS_BASE, which is required in Step 3 of this procedure), see Table 1-3.

In the command, replace primordial_host_name with the host name of the Administration Server of the Common domain).

(UNIX) export DIAGJPSCONFIGFILE=APPLICATIONS_CONFIG/domains/
primordial_host_name/CommonDomain/config/fmwconfig/jps-config-jse.xml

(Windows) set DIAGJPSCONFIGFILE=APPLICATIONS_CONFIG\domains\
primordial_host_name\CommonDomain\config\fmwconfig\jps-config-jse.xml

Note:

Command syntax for UNIX environments may vary depending on which shell you are using. Whenever you define an environment variable, use the command syntax for your chosen shell.

3. Use a command such as the following to set the JAVA_HOME environment variable to the location of the directory that contains Java files, where APPLICATIONS_BASE is the top-level directory for the Oracle Fusion Applications binaries.

(UNIX) export JAVA_HOME=APPLICATIONS_BASE/fusionapps/jdk6

(Windows) set JAVA_HOME=APPLICATIONS_BASE\fusionapps\jdk6

4. Use a command such as the following to set the MW_HOME environment variable to the location of the directory that contains Oracle Fusion Middleware files.

(UNIX) export MW_HOME=APPLICATIONS_BASE/fusionapps

(WINDOWS) set MW_HOME=APPLICATIONS_BASE/fusionapps

After you complete this step, you can use the diagctl command-line interface to run diagnostic tests. For more information, see Section 14.3.1.2.

14.3 Using Diagnostic Tests to Monitor Normal System Health

Oracle Fusion Applications diagnostic tests are designed to help you to monitor the health of your system and to help you troubleshoot when necessary.

Note:

The user name that you use to sign in to an Oracle Fusion application affects which diagnostic operations are available to you. Be sure that you sign in using an account that has a job role for the diagnostic operations that you need. For more information, see Section 14.2.1.

Some diagnostic tests can be used with all Oracle Fusion applications. Other tests apply to specific product families within Oracle Fusion Applications. For information about the individual diagnostic tests that are provided with this release, see the Oracle Fusion Applications Common User Guide in Oracle Fusion Applications Help.

14.3.1 Running Diagnostic Tests

You can use either Diagnostic Dashboard or the diagctl command-line interface to run external diagnostic tests—tests that do not depend on the availability of any specific Oracle Fusion application. However, for technical reasons, you must use Diagnostic Dashboard to run internal diagnostic tests—tests that require a specific Oracle Fusion application to be running at the time when the test is run. For information about determining whether a particular test is an internal or an external test, see Step 9 through Step 11 in Section 14.3.1.1.

14.3.1.1 Using Diagnostic Dashboard to Run Diagnostic Tests

The Diagnostic Dashboard application provides a graphical user interface that lets you execute and monitor diagnostic tests, display and purge test results, and register any special-purpose diagnostic tests that Oracle Support may provide to you.

To run a diagnostic test from Diagnostic Dashboard:

1. Navigate to Diagnostic Dashboard for the Oracle Fusion applications you are administering, and log in using an account for the application you intend to test that has one of the following job roles:

- Diagnostic Regular User

- Diagnostic Advanced User

- Diagnostic Administrator

For more information about these job roles, see Section 14.2.1. For more information about navigating to Diagnostic Dashboard, see Section 14.2.2.

2. In the Regional area on the left side of Diagnostic Dashboard, locate, and, if necessary, expand one of the following panels:

- Search by Tests

- Search by Tags

3. In the search panel, use standard Oracle query techniques to specify the test characteristics that you want to search for, and then click Search.
For information about the kinds of test characteristics that you can specify, see Section 14.3.2.

The results of the search appear in a table below the Search button.

Note:

In the current release, you can search for and display information about all diagnostic tests that are associated with a tag name that you specify. You cannot currently limit those searches to particular pairs of tag names and tag values. If you need to locate diagnostic tests that are associated with a particular tag name and tag value, you must search for the tag name and then scan the results for the tag value you require.

4. In the search results table, select the checkbox for each test that you want to run, then click Add To Run.
The Choose Tests to Run and Supply Inputs table appears in the upper Local area of the screen, listing characteristics of the tests you selected.

5. From the View menu, use standard techniques to adjust how the table displays its data.
If you want to display nested tests and test steps, you can also expand the tree structure in the Choose Tests to Run and Supply Inputs table.

6. In the Choose Tests to Run and Supply Inputs table, inspect the Input Status column and perform the appropriate action for the value you find:

- For any root level test that displays the message Required Input Values Missing, either clear the checkbox to omit that test (and its nested tests and test steps) from the test run and skip to Step 8, or click the alert icon in the Input Status column to display the Input Parameters dialog and go to Step 7.

- For any root level test that displays the message Required Input Values Validated or the message Input Values Validated, consider whether you want to inspect the parameter values the test is currently set to use. If so, or if you know that you want to change an existing input parameter value, click the check mark icon in the Input Status column to display the Input Parameters dialog and go to Step 7.

Note:

You can use the Input Parameters dialog to override current input parameter values, including in tests that have a valid input status.

- For any root level test that displays the message No Inputs Required, skip to Step 8. A test that displays this message does not use input parameters.

7. If you clicked the alert icon in the Input Status column to display the Input Parameters dialog, specify new parameter values as needed, according to the parameter type, as follows; otherwise, skip this step.

- For Boolean parameters, click the appropriate button in the New Value field.

- For numerical parameters and general text parameters, enter the appropriate value in the New Value field.

- For date parameters, click the icon in the New Value field to display a calendar pop-up menu, and then select an appropriate year, month, and day.

- For parameters that must be supplied from a list of values (LOV), click the magnifying glass icon in the New Value field to display the Search and Select dialog. In the Search and Select dialog, select the appropriate value for the parameter and click OK.

Note:

The values that are available in the list of values are determined in the metadata for the diagnostic test.

- If you want to save your current input values for convenient future use, then click Save to display the Save As Input Set dialog. Supply a name for the set of values that you are saving, plus any additional information about the input set that you want to store, and then click OK.

- If you want to use a set of previously stored input values, then select the appropriate set from the Input Set dropdown list, and click Load.

- If you want to revert to the default values for all parameters in the current test, then click Defaults. The Diagnostic Test Framework removes all values for text parameters and resets other parameter types to default values.

After you finish setting input parameters for the current test, click OK.

8. Repeat Step 6 through Step 7 for any other tests that are missing input values, or that have parameter values that you want to override in your test run.

9. From the View menu for the Choose Tests to Run and Supply Inputs table, choose Availability to display the Diagnostic Test Availability dialog.

10. In the Select a Diagnostic Test for Details table, select each test and inspect the icon displayed in its Availability column:

- If the Availability column shows a check mark icon, then the selected test is currently available to be run.

- If the Availability column shows a triangular warning icon, or if you want to determine whether the test is internal or external, then click Detach in the Available Details table header to display the Available Details table in a larger window, and then go to Step 11.

If all of the listed tests are available to be run and if you do not need to know whether they are internal or external, then skip to Step 13.

11. Inspect the expanded Detached Table for messages about whether the selected test depends on particular Oracle Fusion applications or about why the test is not available, and take the appropriate action:

- If you want to know whether the selected test is internal or external, then inspect the Details of Required Test Components column of the Web Applications Accessible row.

- If that cell of the Detached Table contains the name of an Oracle Fusion application, then the test is an internal diagnostic test that you can run only by using Diagnostic Dashboard when the specified application is available. You cannot run an internal diagnostic test by using the diagctl command-line interface or when the application is not present.

- If that cell of the Detached Table does not list an application, then the test is an external diagnostic test.

- If the Error column in the expanded Detached Table contains an error message, then make a note of the message and see Section 14.3.3 for information about resolving problems that are associated with specific error messages.

12. If you have not already done so, close the Detached Table window and the Diagnostic Test Availability dialog, repeat Step 9 and Step 10 to verify that all listed tests are now available to be run, and then go to Step 13.

13. If you wish, enter a name for your test run in the Run Name field in the control bar.

Note:

Do not use the word error in your test run name. If you use the word error, or if you leave the Run Name field blank, the Diagnostic Testing Framework automatically assigns the test run a name. For information about the formats used in automatically assigned test run names, see Section 14.3.10.

14. When the Input Status column of the Choose Tests to Run and Supply Inputs table displays Required Input Values Validated in all of the selected rows, choose one of the following from the Run Options menu:

- Run Now: Runs the selected test or tests immediately after you click Run.

Note:

Do not click Run until you have completed Step 15 and Step 16.

- Run Later: Schedules when the test or tests will be run. This option is integrated with Oracle Enterprise Scheduler Service.

Note:

The ability to schedule diagnostic tests is supported only if the Oracle Fusion Applications configuration that you have provisioned includes Oracle Enterprise Scheduler.

When you select this option, the Run button on the toolbar changes to a Schedule Run button. Complete the following substeps to schedule when the test or tests will be run:

1. Click the Schedule Run button to display a Schedule Tests dialog.

2. Click the Schedule tab and then select Use a schedule.

3. From the Frequency dropdown list, select how often to run the selected test or tests.

4. In the Start field, specify the date and time to start the testing.

5. Click Submit.

15. Adjust option settings to determine whether to run the prerequisite tests for the diagnostic tests you selected:

- If you want to run prerequisite tests, make sure that the No Prerequisites option in the Run Options menu is not selected.

- If you do not want to run prerequisite tests, make sure that the No Prerequisites option in the Run Options menu is selected.

16. Adjust option settings to determine how many threads to use when running the selected diagnostic tests:

- To use multiple threads, choose Run in Parallel from the Run Options menu. Then choose Number of Threads from the Run Options menu and select a value from 2 through 5. The default number of threads for running in parallel is 3.

- To use a single thread, choose Run Synchronously from the Run Options menu.

17. If you chose Run Now in Step 14, then click Run to start executing the test run.
If you chose Run Later in Step 14, then the test run starts executing at the time you set in the Schedule Tests dialog.

14.3.1.2 Using the diagctl Command-Line Interface to Run Diagnostic Tests

The Diagnostic Test Framework command-line utility, diagctl, lets you specify which tests to run in several different ways: by test name, by associated product codes, by associated tag names and tag values, and by associated module IDs or module keys.

You can run one or more diagnostic tests using a single diagctl command. It is particularly appropriate to use diagctl when you do not have access to a WebLogic Server.

Note:

Technical constraints prevent the diagctl command-line interface from returning useful results for internal diagnostic tests (tests that require a specific Oracle Fusion application to be running when the test is performed). You must use Diagnostic Dashboard to run any internal diagnostic tests.

You must also use Diagnostic Dashboard to determine whether a particular test is an internal or an external test. For more information about making this determination, see Step 9 through Step 11 in Section 14.3.1.1.

To run Diagnostic Tests from the diagctl command-line interface:

1. Obtain the user name and password for the Oracle Fusion Applications account that will run the diagnostic test or tests, and the password for that account.

A user name and password is required for any diagnostic test that you run using the diagctl command-line interface. The command-line syntax for specifying the user name and password is un=user_name and pwd=password.

2. Decide which of the following methods to use to specify the diagnostic test or tests that you want to run:

- Specify a single test name: To run a single specific test without specifying input parameters, the command-line syntax is test=test_name

- Specify a test name and parameters: To run a single specific test with one or more input parameters, the command-line syntax is test=test_name input:parameter_name1=parameter_value1 input:parameter_name2=parameter_value2

- Specify multiple test names: To run several specific tests, the command-line syntax is test=test_name1,test_name2,test_name3

Note:

If you are specifying multiple tests on a single command line, then you cannot specify input parameters on that command line.

- Specify by product codes: To run all of the tests that are associated with one or more specific product codes in the Applications taxonomy, the command-line syntax is app=product_code1,product_code2,product_code3

- Specify by module ID: To run all of the tests that are associated with specific module IDs in the Applications taxonomy, and all of the tests that are associated with child modules of the module that you specify, the command-line syntax is modid=moduleID1,moduleID2,moduleID3

- Specify by module key: To run all of the tests that are associated with specific module keys in the Applications taxonomy, the command-line syntax is modkey=module_key1,module_key2,module_key3

- Specify by tag name and tag value: To run all of the tests that are associated with a specific tag and tag value in the diagnostic test repository, and to run any tests that are associated with any child tag values of the tag name and tag value that you specify, the command-line syntax is tag:tagname1=tagvalue1 tag:tagname2=tagvalue2 tag:tagname3=tagvalue3

You must use at least one of these options in each command to run a diagnostic test from diagctl. You can include more than one of these options in a single command, if you prefer.

3. Decide whether to use any, some, or all of the following additional options for the test run:

- Specify a test run name: To specify a particular name for the test run, use the command-line syntax runname=run_name.

Note:

Do not include the word error in your test run name. If you include the word error, or if you do not specify a test run name, the command-line utility automatically generates a name for the test run. Automatically generated test run names start with the test name, product code, module ID, module key, or tag name and value that you specified, followed by a colon, a timestamp, another colon, and a sequence number.

- Specify whether to test recursively: To run all of the specified tests recursively, use the command-line syntax recurse=Y. The default value is N.

- Specify whether to run prerequisite tests: To identify and run any tests that are prerequisites before running the specified tests, use the command-line syntax prereq=Y. The default value is N.

- Specify the monitoring interval: To specify how often the status of the test run is uploaded to the test repository, use the command-line syntax moninterval=time_in_seconds. The default value is 30 seconds.

- Specify the number of threads: To specify the number of parallel threads to spawn for processing this test run, use the command-line syntax nthreads=number_of_threads. The default value is 5. A value of 1 directs the utility to run the tests serially.

4. Log in to the operating system of the Administration server and make sure that the following required environment variables are correctly set for the current session:

- DIAGJPSCONFIGFILE

- JAVA_HOME

- MW_HOME

For information about setting these variables, see Section 14.2.3.

5. At an operating system command prompt, navigate to the location of the diagctl executable:

(UNIX) ATGPF_ORACLE_HOME/bin/diagctl.sh
(Windows) ATGPF_ORACLE_HOME\bin\diagctl.cmd

6. Enter diagctl.sh run (for UNIX) or diagctl run (for Windows) followed by the user name and password from Step 1 and the options that you decided upon in Step 2 and Step 3, using the syntax described in those steps.

Note:

You can list command arguments that appear after the word run in any order. If you do not specify the password on the command line, the utility prompts you to supply it. For detailed help about running diagnostic tests, enter diagctl.sh run help (for UNIX) or diagctl run help (for Windows)

For example, to run a single test with two input parameter values specified, you enter a command such as the following:

(UNIX) diagctl.sh run test=oracle.apps.fnd.appltest.sampleTest
input:param1=value1 input:param2=value2 un=sysadmin

(WINDOWS) diagctl run test=oracle.apps.fnd.appltest.sampleTest
input:param1=value1 input:param2=value2 un=sysadmin

Note:

If you specify an invalid parameter value, the command-line interface returns an error message and does not run the test.

To run all of the tests that belong to the Application Object Library (FND) and Oracle Fusion General Ledger products, and to run them recursively and with prerequisite analysis, you enter a command such as:

(UNIX) diagctl.sh run app=FND,GL recurse=Y prereq=Y un=sysadmin
(WINDOWS) diagctl run app=FND,GL recurse=Y prereq=Y un=sysadmin

To run all of the tests that are associated with the given module ID, you enter:

(UNIX) diagctl.sh run modid=module1,module2 un=sysadmin
(WINDOWS) diagctl run modid=module1,module2 un=sysadmin

14.3.2 Searching for Diagnostic Tests by Name, Categorization Tag, or Module

You can use Diagnostic Dashboard to search for available diagnostic tests.

One way you can search is to use Search by Tags to search for diagnostic tests that are associated with a particular categorization tag name that you specify.

Another way you can search is to use Search by Tests to search for tests with values that you specify for one or more of the following characteristics:

- Test name

- Test description

- Name of the Oracle Fusion Applications code module that the test checks.

The Diagnostic Testing Framework treats any search value that you enter as a case-insensitive matching pattern, returning the result if the pattern appears anywhere in the specified field. However, if you specify more than one search value to match, the framework returns results only for diagnostic tests that match all of the values that you specify (logical AND).

In general, searching for diagnostic tests is done as a portion of the process of running diagnostic tests from Diagnostic Dashboard. For more information, see Section 14.3.1.1.

14.3.3 Ensuring that Diagnostic Tests Are Available

Whether you can run a diagnostic test at any given time depends on both the specific requirements of the test and the current state of your Oracle Fusion Applications system. Any of the following factors can prevent a test from being available:

- Java class availability

- PL/SQL procedure availability

- Oracle Fusion Applications accessibility

- Execution privileges for the test

- Report viewing privileges for the test

In general, checking the availability of diagnostic tests is done as a portion of the process of running diagnostic tests. For more information about running diagnostic tests, see Section 14.3.1.1.

Note:

Some diagnostic tests require a specific Oracle Fusion application to be running while the test is performed—these diagnostic tests are called internal diagnostic tests. Other diagnostic tests can perform their functions even if the Oracle Fusion application to be tested is not running—these tests are called external diagnostic tests.

If you check for availability of one or more diagnostic tests and encounter an error message in the expanded Detached Table from the Diagnostic Test Availability dialog, then one of the following actions may help you resolve the problem:

- If the text in the Error column is "The following Java classes were not loadable," then this message indicates that the diagnostic testing framework cannot locate the JAR file that contains the selected test. Contact your help desk for assistance in searching for a solution in the My Oracle Support Knowledge Base. If the Knowledge Base does not provide a solution, ask your help desk to open an Oracle Support service request.

- If the text in the Error column is "The following PL/SQL procedures were not located in the database," then this message indicates that the diagnostic testing framework cannot locate the test code for the selected PL/SQL diagnostic test in your database. Contact your help desk for assistance in searching for a solution in the My Oracle Support Knowledge Base. If the Knowledge Base does not provide a solution, ask your help desk to open an Oracle Support service request.

- If the text in the Error column is "The following Web Applications were inaccessible," then use the Oracle WebLogic Server console or Fusion Applications Control to check whether the listed applications are running correctly. This message indicates that the Diagnostic Testing Framework must have access to running instances of the listed Oracle Fusion applications to run the selected diagnostic test—the test is an internal test.
For more information about installing and deploying Oracle Fusion Applications, see the "Provisioning a New Applications Environment" chapter of the Oracle Fusion Applications Installation Guide.

If the problem persists when the listed Oracle Fusion applications and the relevant database instance are all running, contact Oracle Support for assistance.

- If the text in the Error column is "The current user does not have execution privileges for the following tests," then you must log in as a user who has appropriate privileges to execute the selected test. For information about the privileges required, see Section 14.2.1.

- If the text in the Error column is "The current user does not have privileges to view reports for the following tests," then you must log in as a user who has appropriate privileges to view the results of the selected test. For information about the privileges required, see Section 14.2.1.

Note:

It is possible to have the necessary privileges to view diagnostic test results without having the necessary privileges to run those tests. Use an appropriate user account for the actions you want to perform.

14.3.4 Providing Input Parameters for Diagnostic Tests

Diagnostic tests often have input parameters. Oracle supplies default values for some input parameters. When you are preparing to run one or more diagnostic tests, you can change the values for input parameters that have default values and enter values for input parameters that do not have default values. If you know that you will use the same parameter values more than once, you can save those values into an input set that you can reuse for later test runs.

All required input parameters must have values assigned before you can run a diagnostic test. If there are required parameter values missing, the Diagnostic Dashboard application displays Required Input Values Missing in the Input Status column of the Choose Tests to Run and Supply Inputs table.

To specify input parameter values, click the icon in the Input Status column to display the Input Parameters dialog. Then, you can either enter parameter values individually in the New Value column of the Edit Input Set table, or you can select a previously saved set of values from the Input Set dropdown list. After you specify all of the required input parameters, the Diagnostic Dashboard application displays a check mark icon with the message Inputs Edited: Required Input Values Validated. For more information, see Section 14.3.1.1.

14.3.5 Running Diagnostic Tests Immediately

You can use either Diagnostic Dashboard or the diagctl command-line interface to run diagnostic tests immediately.

In Diagnostic Dashboard, you specify that you want to run a diagnostic test immediately by choosing Run Now from the Run Options menu.

For the diagctl command-line interface, you specify that you want to run a diagnostic test immediately by entering the command to run the test from an interactive session prompt.

For more information, see Section 14.3.1.

14.3.6 Scheduling Diagnostic Tests to Run Later

If the Oracle Fusion Applications configuration that you have provisioned includes Oracle Enterprise Scheduler, you can specify a particular time to run diagnostic tests.

In Diagnostic Dashboard, you schedule diagnostic tests by choosing Run Later from the Run Options menu. For more information, see Section 14.3.1.1.

To run a delayed diagnostic test using the diagctl command-line interface, create a script that calls diagctl.sh (for UNIX) or diagctl.cmd (for Windows), and then use standard Oracle Enterprise Scheduler techniques to schedule when the script runs. For information about submitting and monitoring Oracle Enterprise Scheduler jobs, see Chapter 6.

14.3.7 Checking the Status of a Diagnostic Test

You can check the status of a diagnostic test from Diagnostic Dashboard or from the diagctl command-line interface. The command-line interface is primarily intended for use if the Diagnostic Dashboard application is temporarily unavailable.

14.3.7.1 Using the Diagnostic Dashboard Application to Check the Status of a Diagnostic Test

In Diagnostic Dashboard, the Diagnostic Test Run Status table displays two types of status information:

- Execution Status: This column displays status information about whether a test run request can be executed successfully.

- Diagnostic Status: This column displays status information about whether individual diagnostic tests detect problems.

Note:

After running a diagnostic test using Diagnostic Dashboard, you may need to click Refresh to display the latest status information, including rows for the following kinds of test runs:

- Test runs that were run immediately from Diagnostic Dashboard

- Test runs that were scheduled to be run later from Diagnostic Dashboard

- Test runs that were submitted using the diagctl command-line interface

When you click Refresh, Diagnostic Dashboard lists any additional test runs that you or other users have submitted in your current Oracle WebLogic Server domain. If your Oracle Fusion Applications deployment uses Global Single Instance (GSI), then Diagnostic Dashboard also lists test runs that were submitted in other domains.

To check the status of a diagnostic test using Diagnostic Dashboard:

1. If you started the diagnostic test from your current Diagnostic Dashboard application session, then the Diagnostic Test Run Status table automatically displays in the lower right portion of the screen after you click Run. Skip to Step 4.

2. If you are not already displaying Diagnostic Dashboard for the Oracle Fusion applications you are administering, navigate to the dashboard and log in using an account for the application you are testing. For more information, see Section 14.2.2.

3. In the Regional area of your screen, expand the Tasks panel and click Run Status.

4. If you want the Diagnostic Test Run Status table to display only certain types of rows, then select one of the following options from the Find dropdown list:

- All Runs Submitted in Last Hour

- All Runs Submitted in Last 24 Hours

- All Running

- All Running Submitted in Last Hour

- All Runs with Diagnostic Failures in Last 24 Hours

- All Runs with Diagnostic Failures

- All Runs with Diagnostic Warnings

- All Runs with Execution Errors

- All Completed

- All Completed with No Issues

- All Runs

- All Runs Run By the Current User in the Last Hour

- All Runs Run By the Current User

5. If you want to search for specific rows in the Diagnostic Test Run Status table, then click the Search Test Runs icon, enter the search criteria, and click OK.
The available search criteria include:

- Test run dates

- Test run names

- Test display names

- User names of those who started test runs

- Execution status

6. If you want to display additional columns in the Diagnostic Test Run Status table, then choose the additional columns from the View menu.

7. Expand the test run nodes as needed to view the list of test executions for each test, and then inspect the Execution Status column for information about whether tests and test runs have completed or encountered execution errors.

8. Inspect the Diagnostic Status column for information about whether completed tests and test runs encountered any issues before completing.

9. For additional information about any test execution, click the icon in the Report column of the appropriate row of the table.

14.3.7.2 Using the diagctl Command-Line Interface to Check the Status of a Diagnostic Test

The Diagnostic Test Framework command-line utility, diagctl, provides three different ways that you can specify the diagnostic test for which you want status information: by test run name, by test run ID, and by test execution ID.

To check the status of a diagnostic test using the diagctl command-line interface:

1. Obtain the user name and password for the Oracle Fusion Applications account that will run the diagnostic test or tests, and the password for that account.

A user name and password is required whenever you use the diagctl command-line interface to check the status of a diagnostic test. The command-line syntax for specifying the user name and password is un=user_name and pwd=password.

2. Decide which of the following methods to use to specify the diagnostic test run for which you want status information:

- Specify a test run name: To check the status of a diagnostic test run for which you have the run name, the command-line syntax is runName=run_name

- Specify a test run ID: To check the status of a diagnostic test for which you have the test run ID, the command-line syntax is runid=run_ID

- Specify a test execution ID: To check the status of a diagnostic test for which you have the execution ID, the command-line syntax is execid=execution_ID

You must use at least one these options in each command to check the status of a diagnostic test using diagctl.

3. Decide whether you want to view the status of nested test runs.

To check the status of all diagnostic tests that are nested within the specified test, the command-line syntax is printtree=Y. This setting defaults to a value of N, meaning that the status is reported only for the specified test.

4. At a command prompt for your operating system, navigate to the location of the diagctl executable under the fusionapps Oracle Fusion Middleware home directory:

(UNIX) FA_MW_HOME/atgpf/bin/diagctl.sh
(Windows) FA_MW_HOME\atgpf\bin\diagctl.cmd

5. Enter diagctl.sh status (for UNIX) or diagctl status (for Windows) followed by the user name and password from Step 1 and the options that you decided upon in Step 2 and Step 3, using the syntax described in those steps.

Note:

You can list command arguments that appear after the word status in any order. If you do not specify the password as part of the command, the utility will prompt you to supply it. For detailed help about getting status information, enter diagctl.sh status help (for UNIX) or diagctl status help (for Windows).

For example, to check the status of a test by using a test run name, you enter a command such as:

(UNIX) diagctl.sh status runName=TrialRun1 un=sysadmin
(Windows) diagctl status runName=TrialRun1 un=sysadmin

To check the status of a test and its nested test runs by using a run ID, you enter a command such as:

(UNIX) diagctl.sh status runid=RunID1 printtree=Y un=sysadmin
(Windows) diagctl status runid=RunID1 printtree=Y un=sysadmin

To check the status of a test by using an execution key, you enter:

(UNIX) diagctl.sh status execid=TestExecID1 un=sysadmin
(Windows) diagctl status execid=TestExecID1 un=sysadmin

14.3.8 Canceling Diagnostic Test Runs

From time to time, you may want to stop a diagnostic test or test run that is running. Several constraints affect your ability to cancel a diagnostic test or test run:

- In the current release, you must use Diagnostic Dashboard to cancel a diagnostic test or test run that is running. The diagctl command-line interface does not provide this capability.

- To cancel a test or test run that you started, you must use an account that has been assigned the Diagnostic Regular User, Diagnostic Advanced User, or Diagnostic Administrator job role.

- To cancel a test or test run that another user started, you must use an account that has been assigned the Diagnostic Administrator job role.

- When a diagnostic test is scheduled to run at a later time, it is immediately submitted to the Oracle Enterprise Scheduler Service. The procedure for canceling this type of test depends on whether the test has already started to execute when you want to cancel it:

- To cancel a scheduled diagnostic test that has not yet started to execute, use standard Oracle Enterprise Scheduler techniques to cancel the job: in the Scheduling Services area of Oracle Enterprise Manager Fusion Applications Control, select the job request and click Cancel.

- To cancel a scheduled diagnostic test that the Diagnostic Test Run Status dashboard panel indicates is already running, use Diagnostic Dashboard to cancel it in the same way that you would cancel a test that ran immediately.

When you cancel a diagnostic test or test run, the consequences may vary depending on how much of the test run has executed and the language in which the test code is written:

- If you cancel a diagnostic test run while a test step from that test run is in progress, the test step that is currently running is canceled. No additional tests or test steps in the remainder of the canceled test run are executed. The Diagnostic Test Run Status panel displays an Execution Status of Canceled for the run, and a pop-up window displays a message such as the following, but no log messages are recorded to indicate that a diagnostic test run was canceled:

Test Run "test_name" has been canceled.
Please check the test run report for further details.

- When you cancel a diagnostic test step that is implemented in Java, the diagnostic framework automatically closes the test step's database connection, using an asynchronous command to terminate the thread. However, when you cancel a diagnostic test step that is implemented using PL/SQL, the diagnostic framework cannot interrupt the test step and use the existing database connection to close that connection. To reclaim the resources allocated to a canceled PL/SQL diagnostic test step, you must establish a separate connection to the database and use an alter system kill session command to close the connection that the canceled test step was using, as described later in this section.

To cancel a diagnostic test using Diagnostic Dashboard:

1. If you started the diagnostic test from your current Diagnostic Dashboard application session, then the Diagnostic Test Run Status table automatically displays in the lower right portion of the screen after you click Run. Skip to Step 4.

2. If you are not already displaying Diagnostic Dashboard for the Oracle Fusion applications you are administering, then navigate to the dashboard and log in using an account for the application you are testing. For more information, see Section 14.2.2.

3. In the Regional area of your screen, expand the Tasks panel and click Run Status.

4. In the Diagnostic Test Run Status panel, locate and select the test run that you want to cancel, verify that its Execution Status is Running, and then click Cancel.

5. In the Diagnostic Test Run Status panel, click the Report icon for the canceled test run.

6. Inspect the test run report to determine whether the canceled test step was implemented using Java or PL/SQL.

- If the canceled test step was implemented using Java, then skip all of the remaining steps in this procedure.

- If the canceled test step was implemented using PL/SQL, then go to Step 7.

7. If the canceled test step was implemented using PL/SQL, then make a note of the session ID and serial number for the database connection that the step was using.

For example, the report might display information similar to the following:

Step Report - Diagnostics_Engine_Log
Session Information
The test test_name is using a database connection with Session Id 944 and
Serial Number 817

8. Using your preferred database client or database monitoring application and a separate connection to the database, determine whether the database connection for the canceled test step is still open.
For example, you could use a SQL client to execute the following query, substituting the session identifier and serial number values that you obtained in Step 7 for session_Id and serial_number:

select * from v$session where sid = session_Id and serial# =
serial_number

If this query returns a row that contains the session ID and serial number that you specified, then the database connection from the canceled test is still open and using resources. Go to Step 9.

If the query does not return a row that contains the session ID and serial number that you specified, then the database connection from the canceled test has been closed. In this case, skip Step 9.

9. If the database connection for the canceled test step is still open, use a command such as the following to close that connection, substituting the correct session identifier and serial number values for session_Id and serial_number.

alter system kill session 'session_Id, serial_number';

14.3.9 Viewing the Results of Diagnostic Tests

You can use either Diagnostic Dashboard or the diagctl command-line interface to view reports that show the results of diagnostic tests, whichever you prefer.

14.3.9.1 Using the Diagnostic Dashboard Application to View the Results of Diagnostic Tests

You can view the results of a diagnostic test in the dashboard by checking the status of the test and then clicking the icon in the Report column of the selected table row. For more information, see Section 14.3.7.1.

14.3.9.2 Using the diagctl Command-Line Interface to View the Results of Diagnostic Tests

The diagctl command-line utility provides three different ways of requesting the results of diagnostic test results: by test run name, by test run ID, and by test execution ID.

To view diagnostic test result reports using the diagctl command-line interface:

1. Obtain the user name and password for the Oracle Fusion Applications account that you will use to view the test results, and the password for that account.

A user name and password is required whenever you use the diagctl command-line interface to view the results of a diagnostic test. The command-line syntax for specifying the user name and password is un=user_name and pwd=password.

2. Decide which of the following methods to use to specify the diagnostic test run for which you want to view results:

- Specify a test run name: To view the results of a diagnostic test run for which you have the run name, the command-line syntax is runName=run_name. This option includes results for all of the executions in the test run.

- Specify a test run ID: To view the results of a diagnostic test for which you have the test run ID, the command-line syntax is runid=run_ID. This option includes results for all of the executions in the run.

- Specify a test execution ID: To view the results of a diagnostic test for which you have the execution ID, the command-line syntax is execid=execution_ID. This option includes results for the specified execution and any nested executions.

You must use at least one of these options in each command to view the results of a diagnostic test using diagctl.

3. Decide whether you want to use one or more of the following additional options:

- Specify a destination directory for results: To write the test results to a specific directory, the command-line syntax is destdir=destination_directory. If you do not specify a directory, reports are placed in the java.io.tmpdir/user.name/diagfwk directory where java.io.tmpdir and user.name are Java system properties.

- Specify a format for the result report: Valid values are XML and HTML. The default value is HTML. XML report files are created as a step toward creating HTML report files. These XML report files remain in the same directory as the HTML report files.

- Specify if the report should be translated: Valid values are Y and N. If the value is Y, any NLS keys that are specified in the report are translated to your session language. If the value is N, no translation is performed. The default value is Y.

4. At a command prompt for your operating system, navigate to the location of the diagctl executable under the fusionapps Oracle Fusion Middleware home directory:

(UNIX) FA_MW_HOME/atgpf/bin/diagctl.sh
(Windows) FA_MW_HOME\atgpf\bin\diagctl.cmd

5. Enter diagctl.sh report (for UNIX) or diagctl report (for Windows), followed by the user name and password from Step 1 and the options that you decided upon in Step 2 and Step 3, using the syntax described in those steps.

Note:

You can list command arguments that appear after the word report in any order. If you do not specify the password as part of the command, the utility will prompt you to supply it. For detailed help about viewing reports, enter diagctl.sh report help (for UNIX) or diagctl report help (for Windows).

For example, to view the results of a test by using a run name, and to place the results in a particular directory, you enter a command such as:

(UNIX) diagctl.sh report runName=TrialRun1 destdir=/d1/testreport un=sysadmin
(Windows) diagctl report runName=TrialRun1 destdir=/d1/testreport un=sysadmin

To view the results of a test run by using a run ID, with the results placed in the default location, you enter a command such as:

(UNIX) diagctl.sh report runid=RunID1 un=sysadmin
(Windows) diagctl report runid=RunID1 un=sysadmin

To check the status of a test by using an execution key, with the results placed in the default location, you enter:

(UNIX) diagctl.sh report execid=TestExecID1 un=sysadmin
(Windows) diagctl report execid=TestExecID1 un=sysadmin

6. Navigate to the location of the results file, and use a browser or text editor of your choice to view it.

14.3.10 Identifying Diagnostic Test Start Methods from Test Run Names

Any test run name that the Diagnostic Testing Framework supplies follows naming conventions that reflect how the test was started. If you find that an unfamiliar diagnostic test run occurred at an unexpected time, then knowing the test run naming conventions can help you to understand the circumstances in which the test run was started:

- When you submit a test run to run immediately, without specifying a run name, the name that is automatically assigned to the test run has the format TestRun_runID, where runID is a unique string of alphanumeric characters generated by the Diagnostic Testing Framework, such as TestRun_91D818BA54BB29C8E040578C495D6956. This naming convention applies both when tests are submitted from Diagnostic Dashboard and when tests are submitted using diagctl.

- When you schedule a diagnostic test run to run later, using Oracle Enterprise Scheduler Service, the name that is automatically assigned to the test run has the format [TestRunName_]ESS_requestID_timestamp, where TestRunName is an optional name that the you may specify when submitting the test, requestID is a unique identifier supplied by the Oracle Enterprise Scheduler when it schedules the job, and timestamp indicates the time when the job is scheduled to run. This naming convention applies to tests that are submitted from Diagnostic Dashboard to run later. (Tests that are submitted using diagctl always run immediately.)
For example, if you enter the test run name routine, the full test run name might be:

routine_ESS-417-2010-09-09T17:07:09.115-0700

- When a test run is submitted automatically because an incident occurred, the name that is automatically assigned to the test run has the format AppsLogger-DiagnosticTestingFrameworkIntegration_id_timestamp, where id is a number that uniquely identifies the incident, and timestamp indicates when the diagnostic test run starts.

14.3.11 Purging the Results of Selected Diagnostic Test Runs

From time to time, you may want to remove diagnostic test run results from your database, to keep the Run Status table from becoming too large.

Note:

To remove the results of one or more diagnostic test runs from your database, you must use the Diagnostic Dashboard application with an account that has been assigned the Diagnostic Administrator job role.

The diagctl command-line interface does not currently provide a way to purge test run results.

To purge selected diagnostic test run results from the database:

1. If you started the diagnostic test from your current application session, then the Diagnostic Test Run Status table automatically displays in the lower right portion of the screen after you click Run. Skip to Step 4.

2. If you are not already displaying Diagnostic Dashboard for the Oracle Fusion applications you are administering, then navigate to the dashboard and log in using an account for the application that needs its test results purged. For more information see Section 14.2.2.

3. In the Regional area of your screen, expand the Tasks panel and click Run Status.

4. In the Diagnostic Test Run Status table header, use either of the following methods to locate the test run status records that represent the test results that you want to remove from the database:

- Select any appropriate filter from the Find dropdown list.

- Click the search button, enter search criteria, and click OK.

5. After searching or filtering, inspect the listings displayed in the Diagnostic Test Run Status table, and decide whether you want to remove listed test results from the database individually or as a group:

- To remove listed test results from the database individually, go to Step 6.

- To remove all of the listed test results from the database, skip to Step 7.

6. To remove a single test run status result record from the database, complete the following substeps in the Diagnostic Test Run Status table:

1. Select the test run status record that represents the results that you want to remove from the database, and click the delete button in the Diagnostic Test Run Status table header.

2. In the Delete Test Run dialog, select Delete test run "TestRunName" and click OK.
The selected record is removed from the database immediately.

Skip Step 7 and Step 8.

7. To remove all of the listed test run status result records from the database, click the delete button in the Diagnostic Test Run Status table header.

Depending on whether you selected a record in the Diagnostic Test Run Status table, either the Delete Test Run dialog or the Confirm Test Run Delete dialog appears.

8. Complete the purge process using the appropriate instructions for the dialog displayed on your screen:

- If your screen displays the Delete Test Run dialog, then select Delete all test runs in the list and click OK to remove all of the listed test run results from the database immediately.

- If your screen displays the Confirm Test Run Delete dialog, then click Yes to remove all of the listed test run results from the database immediately.

Part IV

Advanced Administration

This part describes advanced administration tasks that involve reconfiguring the Oracle Fusion Applications environment.

Part IV contains the following chapters:

- Chapter 15, "Backing Up and Recovering Oracle Fusion Applications"

- Chapter 16, "Configuring High Availability and Scaling Out Oracle Fusion Applications"

15 Backing Up and Recovering Oracle Fusion Applications

This chapter describes recommended back up and recovery strategies and procedures for recovering your Oracle Fusion Applications environment from different types of failures and outages, such as data loss or corruption, host failure, or media failure.

This chapter contains the following topics:

- Section 15.1, "Introduction to Backup and Recovery"

- Section 15.2, "Back Up and Recovery Tools"

- Section 15.3, "Overview of Backing Up Your Environment"

- Section 15.4, "Overview of Recovering Your Environment"

- Section 15.5, "Prerequisites for Using Cloud Control to Back Up or Restore Your Environment"

- Section 15.6, "Backup and Recovery Recommendations for Oracle Fusion Applications"

- Section 15.7, "Performing a Backup"

- Section 15.8, "Creating a Record of Your Oracle Fusion Applications Configuration"

- Section 15.9, "Recovering Using Cloud Control"

- Section 15.10, "Recovering After Data Loss, Corruption, or Media Failure"

- Section 15.11, "Recovering After Loss of Host"

- Section 15.12, "A Case Study: Recovering Oracle Fusion Customer Relationship Management"

15.1 Introduction to Backup and Recovery

An Oracle Fusion Applications environment can consist of different Oracle Fusion Applications product families. It is built on Oracle Fusion Middleware, which contains Oracle WebLogic Server domains with Java components, such as Oracle SOA Suite, and system components, such as Oracle HTTP Server. It also contains a separate Oracle WebLogic Server domain with Identity Management components, such as Oracle Internet Directory and Oracle Virtual Directory.

Oracle Fusion Applications and some Oracle Fusion Middleware components use Oracle Database instances to store data and metadata.

Note that Oracle Fusion Applications uses at least three databases:

- A database that holds the LDAP repository

- A database that holds the Oracle Fusion Applications data

- A database that holds the Oracle Identity Manager repository

The installations of an Oracle Fusion Applications environment are interdependent in that they contain configuration information, applications, and data that are kept in synchronization.

It is, therefore, important to consider your entire Oracle Fusion Applications environment when performing backup and recovery. You should back up your entire Oracle Fusion Applications environment as soon as you have installed and configured it, then periodically. If a loss occurs, you can restore your environment to a consistent state.

15.2 Back Up and Recovery Tools

To back up and recover your Oracle Fusion Applications environment, you can use:

- Oracle Enterprise Manager Cloud Control
With Cloud Control, you can back up and restore the directories and databases that comprise a Oracle Fusion Applications installation. Because Cloud Control uses Oracle Secure Backup to perform Oracle Fusion Applications backups, all backups are done to tape, which is the media supported by Oracle Secure Backup.

- Any operating system or third-party tool which provides a consistent image back up of the file system, which you can later restore. If your storage has features such as storage snapshot, this is recommended. If your storage system does not provide such features, you can use file copy utilities such as copy, xcopy, tar, or jar. However, these utilities may result in an inconsistent backup unless the system is in a quiesced state.
In addition, make sure that the utilities:

For example, for UNIX, you can use tar.

- Preserve symbolic links

- Support long file names

- Preserve the permissions and ownership of the files

For example:

- On Windows, for online backups, you can use copy; for offline backups, you can use copy, xcopy, tar, or jar. Ensure that the backup utility you use can support long and unicode file names and extensions. Many of the early archiving utilities did not have this support.
For example, for online recovery on Windows, you can use copy; for offline recovery on Windows, you can use copy, xcopy, or jar. Ensure that the utility you use can support long and unicode file names and extensions. Many of the early archiving utilities did not have this support."

Note that for some versions of Windows, any file name with more than 256 characters will fail. You can use the xcopy command with the following switches to work around this issue:

xcopy /s/e  "C:\Temp\*.*"  "C:\copy"

See the xcopy help for more information about syntax and restrictions.

- On UNIX, for online and offline backup and recovery, you can use tar.

See Section 15.3.1 for descriptions of online and offline backups.

- Oracle Recovery Manager (RMAN) to back up database-based metadata repositories and any databases used by Oracle Fusion Applications. With RMAN, you can perform full backups or incremental backups. For information about backing up databases, see the Oracle Database Backup and Recovery User's Guide. For information about recovering databases, see Section 15.10.8 and Section 15.11.4.

If you want to retain your backups for a longer duration, consider backing up to tape, for example using Oracle Secure Backup.

For optimized backup time and fast restore times for the file system, you can use a storage snapshot feature provided by a storage vendor. Snapshots are point-in-time, read-only copies of the file system. Snapshots normally use copy-on-write mechanisms and hence do not occupy any space at the beginning. When new data is written, the old copy is written to the snapshot. Most of the storage vendors support an unlimited number of snapshots and allow creating snapshots manually or automatically without any user interventions. Snapshots can be taken quickly, thus reducing the time taken when performing a backup. Taking regular snapshots of the Oracle Fusion Applications configuration helps you restore the Oracle Fusion Applications environment quickly in the event of configuration corruption or data loss. Snapshots provide rollback capabilities. When a rollback occurs, any newer snapshots (and clones of newer snapshots) are destroyed, and the active data reverts to the state when the snapshot was taken.

15.3 Overview of Backing Up Your Environment

You should back up your environment when you install and configure Oracle Fusion Applications and on a regular basis. You can back up your full environment or you can back up only parts of it. You can perform the backups in online or offline mode.

This section includes the following topics:

- Section 15.3.1, "Modes of Backup"

- Section 15.3.2, "Types of Backups"

- Section 15.3.3, "Recommended Backup Strategy"

- Section 15.3.4, "Backing Up Windows Registry Entries"

15.3.1 Modes of Backup

You can back up your Oracle Fusion Applications environment offline or online:

- With an offline backup, you must shut down the environment before performing the backup. When you perform an offline backup, the Administration Server, all Managed Servers in the domain, and all system components in the Oracle instances should be shut down.
Back up the environment offline immediately after installation and after applying upgrades.

- With an online backup, you do not shut down the environment before backing up the files. To avoid an inconsistent backup, do not make any configuration changes until the backup is completed. To ensure that no changes are made in the WebLogic Server domain, lock the WebLogic Server configuration, as described in Section 2.7.2.
During an online backup, applications can continue to run during the backup, so your business is not affected.

15.3.2 Types of Backups

You should back up your Oracle Fusion Applications file system and your Oracle Fusion Applications databases.

For the Oracle Fusion Applications file system, you can perform a full backup or you can perform a partial backup. See Figure 1-6 for a graphic of the directory structure in the Oracle Fusion Applications file system.

To perform a full backup of the file system, you should back up the binary files, as well as the configuration files.

Binary files are static files and directories that do not change frequently. These include:

- The Applications base directory, which is the top-level directory containing Oracle Fusion Applications, Middleware homes, and Oracle homes.

- The Middleware home (MW_HOME). A Middleware home consists of a WebLogic Server home, an Oracle Common home, and optionally one or more Oracle homes and one or more Oracle instances.

- OraInventory

- On UNIX, the OraInst.loc file, which is located in the following directory:

(Linux and IBM AIX) /etc
(Other UNIX systems) /var/opt/oracle

- On UNIX, the oratab file, which is located in the following directory:

/etc

- The beahomelist file, which is located at:

(UNIX) user_home/bea/beahomelist
(Windows) C:\bea\beahomelist

- On Windows, the following registry key:

HKEY_LOCAL_MACHINE\Software\oracle

In addition, for system components, such as Oracle HTTP Server, you must back up the following Windows Registry key:

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services

Configuration files are those files that change frequently. Back up these files when you perform a full backup and on a regular basis. Configuration files include:

- The Applications configuration directory, which is the top-level directory containing domains and Oracle instances.

- Domain directories of the Administration Server and the Managed Servers. The Oracle Fusion Applications environment can consist of multiple domains (for example, CRMDomain and FinancialDomain). Each domain consists of an Administration Server and one or more Managed Servers.
Unless stated in the backup recommendations for a particular type of Oracle Fusion application, you do not need to back up Managed Server directories separately because the Administration Server contains information about all of the Managed Servers in its domain.

- All Oracle instance homes, which reside by default in the MW_HOME, but can be configured to be in a different location.

For the Oracle Fusion Applications database and related databases, you can perform full or incremental backups. You use Oracle Recovery Manager to back up an Oracle Database instance.

Note that you must keep the databases synchronized when you restore them.

15.3.3 Recommended Backup Strategy

This section outlines the recommended strategy for performing backups. Using this strategy ensures that you can perform the recovery procedures in this book.

Note:

Store your backups in a secure location, that is, not on the same hardware that contains your Oracle Fusion Applications environment.

- Perform a full offline backup: Back up the binary files and directories and the configuration files described in Section 15.3.2. If the Applications base directory is shared, you only need to back it up once. If the Applications base directory is not shared, back it up on each host in your Oracle Fusion Applications environment. Perform a full offline backup at the following times:

- Immediately after you install Oracle Fusion Applications

- Immediately after an operating system software upgrade.

- Immediately before upgrading your Oracle Fusion Applications environment

- Immediately after upgrading your Oracle Fusion Applications environment

- Immediately before patching your Oracle Fusion Applications environment.

- Perform an online backup of configuration files: Back up the configuration files described in Section 15.3.2. Backing up the configuration files enables you to restore your environment to a consistent state as of the time of your most recent configuration and metadata backup. You can back up the configuration files at the following granularity:

- The Applications configuration directory.

- The domain.

- The instance. You should back up the files in the following directories:

For the CRM Domain: instance/domains/host_name/CRMDomain
For the HCM Domain: instance/domains/host_name/HCMDomain
For the FIN Domain: instance/domains/host_name/FinancialDomain
For the PRJ Domain: instance/domains/host_name/PRJDomain
For the Webtier home: instance/CommonDomain_webtier
For the BI Instance: instance/BIInstance

To avoid an inconsistent backup, do not make any configuration changes until the backup completes.

Perform an online backup of configuration files at the following times:

- On a regular basis. Oracle recommends that you back up configuration files nightly.

- Before making configuration changes to an Administration Server, a Managed Server, or application.

- Immediately after patching your Oracle Fusion Applications environment.

- After making configuration changes to an Administration Server, a Managed Server, Oracle instance, or application.

- After a major change to the deployment architecture, such as creating servers or clusters.

- Perform a full or incremental backup of your databases: Use RMAN to backup your databases.

Note the following recommendations:

- To ensure that no changes are made in the WebLogic Server domains, lock the WebLogic Server configuration for all the domains in Oracle Fusion Applications environment, as described in Section 2.7.2.

- When you create the backup, name the archive file with a unique name. Consider appending the date and time to the name. For example, if you create a backup of the Applications base directory on March 2 2012, name the backup:

ApplBase_backup_030212.tar

15.3.4 Backing Up Windows Registry Entries

On Windows, you must back up Windows Registry keys related to Oracle Fusion Middleware. Which keys you back up depends on what components you have installed.

To export a key, use the following command:

regedit /E  FileName Key

Export the following entries:

- For any component, export the following registry key:

HKEY_LOCAL_MACHINE\Software\Oracle

- For system components, such as Oracle Web Cache, and for Oracle BI Enterprise Edition, export each node that begins Oracle within the following registry keys:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services
HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services
HKEY_LOCAL_MACHINE\SYSTEM\ControlSet002\Services

For example:

regedit /E C:\oracleSMP.reg HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\Oracleagent10gAgentSNMPPeerEncapsulator

Use a unique file name for the each key.

- For Oracle BI EE, export the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\ODBC

For example:

regedit /E C:\oracleregistry.reg HKEY_LOCAL_MACHINE\SOFTWARE\ODBC

You can also use the Registry Editor to export the key. See the Registry Editor Help for more information.

15.4 Overview of Recovering Your Environment

If your environment suffers from critical failures that involve actual data corruption, data loss, or loss of host, you must recover all or part of your environment.

This section includes the following topics:

- Section 15.4.1, "Types of Recovery"

- Section 15.4.2, "Recommended Recovery Strategies"

15.4.1 Types of Recovery

Recovery strategies enable you to recover from critical failures that involve actual data corruption, data loss, or loss of host. Depending on the type of loss, you can recover your Oracle Fusion Applications environment in part or in full. You can recover the following:

- The Applications base directory

- The Oracle WebLogic Server domains containing Oracle Fusion Applications

- The Administration Server for the Oracle Fusion Applications domains

- Managed Servers

- The Middleware home

- An Oracle home

- An Oracle instance home

- Any database used by Oracle Fusion Applications. You use Oracle Recovery Manager (RMAN) to recover an Oracle Database instance. See Section 15.10.8 and Section 15.11.4.

Note that with Oracle Fusion Applications, you can install all or some of the files on shared storage. Some of the procedures will differ depending on whether all files are on shared storage. The options are:

- All files are on a shared file system.

- All binary files are on a shared file system as well as all Administration Servers. Managed Servers are on local file systems.

15.4.2 Recommended Recovery Strategies

Note the following key points about recovery:

- All or part of your Oracle Fusion Applications environment must be offline while you are performing recovery.
Stop the relevant processes. The processes you stop depends on the granularity of the recovery. For example, if you are recovering only one domain, shut down the corresponding Administration Server and Managed Servers.

- Rename existing files and directories before you begin restoring the files from backup so that you do not unintentionally override necessary files.

- Although, in some cases, it may appear that only one or two files are lost or corrupted, you should restore the directory structure for the entire element, such as an Oracle instance home or a component, rather than just restoring one or two files. In this way, you are more likely to guarantee a successful recovery.

- If you need to recover a database, perform a complete recovery to recover the database to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database as close to the current time as possible. (You can use point-in-time recovery if the database is configured in Archive Log Mode. This is typically a time right before the database failure occurred.) Oracle recommends using Archive Log Mode for production databases.
You must keep the databases synchronized. See Section 15.10.9 for procedures for recovering them to the same point in time and reconciling differences.

15.5 Prerequisites for Using Cloud Control to Back Up or Restore Your Environment

Before you back up or restore an Oracle Fusion Applications environment using Oracle Enterprise Manager Cloud Control, ensure the following prerequisites are met:

- Cloud Control 12c Agents must be installed on all hosts in the Oracle Fusion Applications environment where components (such as Oracle WebLogic Server Administration and Managed Servers) are running, and the hosts must be discovered in Cloud Control. (Although it is possible to monitor an Oracle Fusion Applications environment without having Agents on every host, backup and restore requires a local Agent on each host).

- An Oracle Secure Backup domain target must be discovered in Cloud Control. This requires an Oracle Secure Backup server installation, and all hosts that are part of the Oracle Fusion Applications environment must be configured as Oracle Secure Backup client hosts.

- A Fusion Instance target representing the Oracle Fusion Applications environment must be discovered in Cloud Control. The Fusion Instance target must be discovered through a local Agent that is running on one of the hosts in the Oracle Fusion Applications environment.

- You must create a backup configuration using Cloud Control. A backup configuration contains the settings that will be used for the database and file backups, and is required to perform an Oracle Fusion Applications backup. See Section 15.7.1.1 for more details on creating a backup configuration.

- Before you perform a backup or restore through Cloud Control, you must properly shut down all Oracle WebLogic Server instances and other components in the Oracle Fusion Applications environment. Refer to Section 15.10 and Section 15.11 for details on what components must be shut down and how to shut them down. Optionally, scripts that perform the required shutdown of components on each host can be invoked as user-specified pre-backup or pre-restore scripts within the Cloud Control backup procedure. (See Section 15.7.1.2 for more details on user-specified scripts.)

- If the Oracle Fusion Applications repository or other databases are included in an Oracle Fusion Applications restore, the databases must be started in mounted mode before submitting the restore procedure. If a complete restore of the databases is required, it may be necessary to first perform a SPFILE or controlfile restore or both for the individual databases through the database Perform Recovery wizard, which can be accessed from the Availability menu on the Cloud Control database home page. (Go to the home page of the database that must be restored, select Availability, then select Backup and Recovery, then select Perform Recovery.)

For information about using Cloud Control to back up and recover your Oracle Fusion Applications environment, see:

- Section 15.7.1, "Performing a Backup Using Cloud Control"

- Section 15.9, "Recovering Using Cloud Control"

Related Links

The following documents provide additional information related to subjects discussed in this section:

- For more information on installing and configuring Cloud Control, refer to the Oracle Enterprise Manager Cloud Control Basic Installation Guide in the Oracle Enterprise Manager documentation library.

- For more information on installing Oracle Secure Backup, refer to the Oracle Secure Backup Installation and Configuration Guide in the Oracle Database documentation library.

15.6 Backup and Recovery Recommendations for Oracle Fusion Applications

The topics in this section describe backup and recovery recommendations for specific Oracle Fusion Applications components and for components that are related to Oracle Fusion Applications.

The topics include information about configuration files for each application or component. Note that the list of files in not an exhaustive list. You do not back up or recover the individual files. Generally, you back up or recover the Applications base directory, the Applications configuration directory, Middleware home, domain, Oracle home, or an Oracle instance, as described in Section 15.7, Section 15.10, and Section 15.11.

The configuration files and database schemas are for information purposes only. You must back up the entire database.

This section includes the following topics:

- Section 15.6.1, "Backup and Recovery Recommendations for Oracle Fusion Customer Relationship Management"

- Section 15.6.2, "Backup and Recovery Recommendations for Oracle Fusion Financials"

- Section 15.6.3, "Backup and Recovery Recommendations for Oracle Fusion Human Capital Management"

- Section 15.6.4, "Backup and Recovery Recommendations for Oracle Fusion Supply Chain Management"

- Section 15.6.5, "Backup and Recovery Recommendations for Oracle Fusion Project"

- Section 15.6.6, "Backup and Recovery Recommendations for Oracle Fusion Procurement"

- Section 15.6.7, "Backup and Recovery Recommendations for Oracle Fusion Incentive Compensation"

- Section 15.6.8, "Backup and Recovery Recommendations for Oracle Fusion Applications Technology"

- Section 15.6.9, "Backup and Recovery Recommendations for Oracle Fusion Setup"

- Section 15.6.10, "Backup and Recovery Recommendations for Oracle WebCenter Content"

- Section 15.6.11, "Backup and Recovery Recommendations for Oracle Enterprise Scheduler"

- Section 15.6.12, "Backup and Recovery Recommendations for Oracle Enterprise Crawl and Search Framework"

- Section 15.6.13, "Backup and Recovery Recommendations for Oracle Authorization Policy Manager"

- Section 15.6.14, "Backup and Recovery Recommendations for Java Servers for Oracle E-Mail and Web Marketing"

15.6.1 Backup and Recovery Recommendations for Oracle Fusion Customer Relationship Management

This section describes the Oracle Fusion Customer Relationship Management data that must be backed up and restored.

Configuration Files

Most configuration data is stored in the Oracle WebLogic Server domain.

In addition, Oracle Fusion Customer Relationship Management uses configuration data for Java servers for Oracle E-Mail and Web Marketing. See Section 15.6.14 for information about backing up and recovering Oracle E-Mail and Web Marketing.

Dependencies on Oracle Fusion Middleware Components

Oracle Metadata Services, Oracle Business Intelligence metadata, Oracle Real-Time Decisions, an LDAP provider such as Oracle Internet Directory, Oracle WebCenter Portal (including tagging, group spaces, and the Oracle WebCenter Portal schemas), portlet metadata, Oracle SOA Suite, Oracle ADF user interface, Oracle Essbase, Oracle WebCenter Content, Oracle Enterprise Crawl and Search Framework metadata and data, including Oracle Secure Enterprise Search, Oracle Product Data Quality

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Customer Relationship Management is deployed. Back up the standalone Java servers used for Oracle E-Mail and Web Marketing, as described in Section 15.6.14.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Recovery Recommendations

Recover the Managed Server to which the application is deployed. If needed, recover the standalone Java servers used for Oracle E-Mail and Web Marketing, as described in Section 15.6.14.

Depending upon the extent of failure, recovery should be performed at the desired granularity. For the steps to recover Oracle Fusion Customer Relationship Management, including for loss of host, see Section 15.10.10.1.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases containing the Oracle Fusion Applications, Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.2 Backup and Recovery Recommendations for Oracle Fusion Financials

This section describes the Oracle Fusion Financials data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle BPEL Process Manager, Oracle WebCenter Portal (portlets), Oracle Metadata Services, Oracle WebCenter Content: Imaging, Oracle Enterprise Scheduler, Oracle BI Enterprise Edition, Oracle Essbase, and Applications Technology Group

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing the Oracle Fusion Applications, the LDAP store, Oracle Essbase, and Oracle Fusion Middleware schemas

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Financials is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10

Back up the databases containing the Oracle Fusion Applications, Oracle Essbase, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed. For information about recovering Oracle Essbase, see Section 15.11.7.7.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.3 Backup and Recovery Recommendations for Oracle Fusion Human Capital Management

This section describes the Oracle Fusion Human Capital Management data that must be backed up and restored.

Configuration Files

Most configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle BPEL Process Manager, Oracle WebCenter Portal (portlets), Oracle Metadata Services, Oracle Enterprise Scheduler, Oracle Business Intelligence Publisher, an LDAP provider such as Oracle Internet Directory, Oracle Fusion Middleware Extensions for Applications, Oracle WebCenter Content

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Human Capital Management is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the databases containing the LDAP store, Oracle Fusion Applications, Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed. Note that the databases, including the LDAP store, the database containing Oracle Fusion Human Capital Management schemas and the Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content must be kept synchronized. If you restore one, restore the others to the same point in time.

There may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.4 Backup and Recovery Recommendations for Oracle Fusion Supply Chain Management

This section describes the Oracle Fusion Supply Chain Management data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle SOA Suite, Oracle Enterprise Scheduler

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Supply Chain Management is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10. For the steps specific to recovering from loss of host, see Section 15.11.6.1.

15.6.5 Backup and Recovery Recommendations for Oracle Fusion Project

This section describes the Oracle Fusion Project data that must be backed up and restored.

Configuration Files

Most configuration data is stored in the Oracle WebLogic Server domain. In addition, configuration data is stored in the Oracle Essbase database.

Dependencies on Oracle Fusion Middleware Components

Oracle Metadata Services, an LDAP provider such as Oracle Internet Directory, Oracle WebCenter Portal (including tagging, group spaces, and the Oracle WebCenter Portal schemas), Oracle SOA Suite, Oracle Application Development Framework user interface, Oracle Enterprise Crawl and Search Framework metadata and data, Oracle Enterprise Scheduler, Oracle Essbase

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing the Oracle Fusion Applications, Oracle Essbase, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Project is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the Oracle Essbase database used by Oracle Fusion Project. Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10.

15.6.6 Backup and Recovery Recommendations for Oracle Fusion Procurement

This section describes the Oracle Fusion Procurement data that must be backed up and restored.

Configuration Files

Most configuration data is stored in the Oracle WebLogic Server domain. In addition, the certificate file, which is determined by the Profile Option, contains a certificate for SSL connections made to supplier web sites to let requisitioners search or browse catalogs.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle BPEL Process Manager, Oracle B2B, Oracle Fusion Middleware Extensions for Applications, Oracle Enterprise Scheduler, Oracle Business Intelligence Publisher, Oracle Streams, Advanced Queuing (AQ), Java Message Service (JMS), JMS queues with Oracle B2B

Dependencies on Third-Party Products

CUPS software, a portable printing layer for UNIX systems

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Procurement is deployed. Back up the certificate file.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. For the steps to recover Oracle Fusion Procurement, see Section 15.10.10.2. For the steps specific to recovering from loss of host, see Section 15.11.6.2.

For information about recovering JMS, see "Backup and Recovery Recommendations for Oracle WebLogic Server JMS" in the Oracle Fusion Middleware Administrator's Guide.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.7 Backup and Recovery Recommendations for Oracle Fusion Incentive Compensation

This section describes the Oracle Fusion Incentive Compensation data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle SOA Suite, Oracle Data Integrator, Oracle BI Enterprise Edition, Oracle Enterprise Scheduler, Oracle Enterprise Crawl and Search Framework, Oracle Secure Enterprise Search

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Incentive Compensation is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.8 Backup and Recovery Recommendations for Oracle Fusion Applications Technology

This section describes the Oracle Fusion Applications Technology data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle SOA Suite, Federated Worklist, Oracle WebCenter Portal (including portlets, tagging, group spaces, and forums), Oracle WebCenter Portal, MDS, portlet metadata, Oracle Enterprise Crawl and Search Framework metadata and data, and Oracle Secure Enterprise Search, Oracle BI Enterprise Edition, Oracle Fusion Topology Manager, Applications Technology Group

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Applications Technology is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases to the most recent point in time, if needed.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.9 Backup and Recovery Recommendations for Oracle Fusion Setup

This section describes the Oracle Fusion Setup data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework, Oracle BPEL Process Manager, Oracle WebCenter Content, Oracle WebCenter Portal (portlets), Oracle Enterprise Scheduler, Identity Governance Framework

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Applications base directory and the Administration Server domain in which Oracle Fusion Setup is deployed.

Back up Oracle WebCenter Content, as described in Section 15.6.10.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

Recovery Recommendations

Recover the Managed Server to which the application is deployed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. See Section 15.10.

Recover Oracle WebCenter Content, as described in Section 15.6.10.

Recover the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas, including those for Oracle WebCenter Content.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.10 Backup and Recovery Recommendations for Oracle WebCenter Content

This section describes the Oracle WebCenter Content data that must be backed up and restored.

Configuration Files

DOMAIN_HOME/ucm/CONTEXT-ROOT/bin/intradoc.cfg
DOMAIN_HOME/ucm/CONTEXT-ROOT/config/config.cfg

Database Repository Dependencies

OCS schema

Backup Recommendations

Back up the domain, the Oracle home, and database containing the OCS schema. If the Vault and WebLayout directories are not located in the domain directory, back up their directories, which are specified in:

DOMAIN_HOME/ucm/CONTEXT-ROOT/config/config.cfg

Also, back up the following directory, which is located in a shared file system:

DOMAIN_HOME/ucm/CONTEXT-ROOT/config

Recovery Recommendations

Restore the domain and the shared file system containing the Vault and WebLayout directories, depending on the severity of the failure.

Recover the database containing the OCS schema to the most recent point in time, if needed.

For the steps to recover Oracle WebCenter Content, see Section 15.10.11.2. For the steps specific to recovering from loss of host, see Section 15.11.7.2.

15.6.11 Backup and Recovery Recommendations for Oracle Enterprise Scheduler

This section describes the Oracle Enterprise Scheduler data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

None

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases containing Oracle Fusion Applications, Oracle Enterprise Scheduler, LDAP store, and Oracle Fusion Middleware schemas, including Oracle WebCenter Content

Backup Recommendations

Back up the Oracle home and the domain home.

Back up the databases containing the Oracle Fusion Applications, the LDAP store, and Oracle Fusion Middleware schemas.

Recovery Recommendations

Recover the domain home and the Oracle home, as needed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. For the steps to recover Oracle Enterprise Scheduler, including for loss of host, see Section 15.10.11.3.

Recover the databases to the most recent point in time, if needed.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.12 Backup and Recovery Recommendations for Oracle Enterprise Crawl and Search Framework

This section describes the Oracle Enterprise Crawl and Search Framework data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

Oracle Application Development Framework

Dependencies on Third-Party Products

None

Database Repository Dependencies

The database containing Oracle Fusion Applications schemas

Backup Recommendations

Back up the domain in which Oracle Enterprise Crawl and Search Framework is deployed.

Back up the database containing the Oracle Fusion Applications schemas.

Recovery Recommendations

Recover the domain in which Oracle Enterprise Crawl and Search Framework is deployed.

Depending upon the extent of failure, recovery should be performed at the desired granularity. For the steps to recover Oracle Enterprise Crawl and Search Framework, including for loss of host, see Section 15.10.11.4.

Recover the database containing the Oracle Fusion Applications schemas.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.13 Backup and Recovery Recommendations for Oracle Authorization Policy Manager

This section describes the Oracle Authorization Policy Manager data that must be backed up and restored.

Configuration Files

The configuration files are located in the Oracle instance home.

Dependencies on Oracle Fusion Middleware Components

An LDAP provider, such as Oracle Internet Directory

Dependencies on Third-Party Products

None

Database Repository Dependencies

The databases used by Oracle Authorization Policy Manager and the LDAP store

Backup Recommendations

Back up the Oracle Authorization Policy Manager Domain home and its Oracle home.

Back up the database used by Oracle Authorization Policy Manager and the LDAP store.

Recovery Recommendations

Recover the domain in which Oracle Authorization Policy Manager is deployed. Recover the Oracle home, if necessary.

Depending upon the extent of failure, recovery should be performed at the desired granularity. For the steps to recover Oracle Authorization Policy Manager, including for loss of host, see Section 15.10.11.5.

Recover the databases used by Oracle Authorization Policy Manager and the LDAP store, if needed, to the same point in time.

If needed, perform a complete recovery to recover the databases to the most current state. However, there may be some situations where you do not have all the required logs to accomplish complete recovery. In that situation, perform an incomplete recovery (point-in-time recovery) to recover the database to as close to the current time as possible. Then, reconcile the databases, as described in Section 15.10.9.

15.6.14 Backup and Recovery Recommendations for Java Servers for Oracle E-Mail and Web Marketing

Oracle E-Mail and Web Marketing is provided with Oracle Fusion Customer Relationship Management. Oracle E-Mail and Web Marketing provides three components: Email Sending Domain (ESD), Click-Through Daemon (CTD), and Bounce-Handling Daemon (BHD).

This section describes the Oracle E-Mail and Web Marketing data that must be backed up and restored.

Configuration Files

Configuration data is stored in the Oracle WebLogic Server domain.

Dependencies on Oracle Fusion Middleware Components

None

Dependencies on Third-Party Products

None

Database Repository Dependencies

None

Backup Recommendations

Back up the Managed Servers to which ESD and CTD are deployed. Back up the directory for BHD.

Recovery Recommendations

Restore the Managed Servers to which ESD and CTD are deployed. Restore the directory for BHD.

Depending upon the extent of failure, recovery should be performed at the desired granularity. For the steps to recover Oracle E-Mail and Web Marketing, including for loss of host, see Section 15.10.11.6.

15.7 Performing a Backup

You can perform a full offline backup or an online or offline backup of configuration files.

This section includes the following topics:

- Section 15.7.1, "Performing a Backup Using Cloud Control"

- Section 15.7.2, "Performing a Full Offline Backup Using the Command Line"

- Section 15.7.3, "Performing an Online Backup of Configuration Files Using the Command Line"

15.7.1 Performing a Backup Using Cloud Control

You can use Cloud Control to back up Oracle Fusion Applications, as described in the following topics:

- Section 15.7.1.1, "Configuring Cloud Control Backups"

- Section 15.7.1.2, "Backing Up Oracle Fusion Applications Using Cloud Control"

15.7.1.1 Configuring Cloud Control Backups

You must create a backup configuration before you perform a backup or restore using Cloud Control. A backup configuration contains settings for database and file backups. You create the configuration using the Backup Configurations page. You can create multiple backup configurations, using different settings. Then, you can use the configurations in subsequent backup and restore operations.

To create a new backup configuration using Cloud Control:

1. From the Targets menu, select Fusion Applications.
The Fusion Applications target home page is displayed.

2. Click the Fusion Instance that you want to back up.
The Fusion Instance home page is displayed.

3. From the Fusion Instance menu, choose Control, then Backup Configurations.
The Backup Configurations page is displayed, as shown in the following figure:

4. Click Create.
The Create Backup Configurations page is displayed. It contains three tabs: Storage, Policy, and Recovery Catalog. You can use the default settings or customize individual settings.

5. On the Storage tab, you specify settings related to disk and tape backup. Because Cloud Control always backs up Oracle Fusion Applications to tape, the disk settings are not applicable.
To specify tape settings, first select an Oracle Secure Backup Domain, after which separate tape settings for database and files are shown. Database settings include datafile and archived log copies, backup type, and media management parameters. File settings include media family and devices. Specify Oracle Secure Backup domain and host credentials.

The following figure shows the Storage tab:

6. On the Policy tab, you specify policy settings for database and tape backups. Database settings include backup retention, compression, and encryption. Separate database encryption settings are specified for disk and tape backups. File settings include Oracle Secure Backup job and encryption settings.
The following figure shows the Policy tab:

7. If you are using a recovery catalog for database backups, specify the catalog on the Recovery Catalog tab, which is shown in the following figure:

8. Click Save.

Related Links

The following documents provide additional information related to subjects discussed in this section:

- For more information on the database backup settings in these pages, refer to the Oracle Database Backup and Recovery Reference in the Oracle Database documentation library.

- For information on the Oracle Secure Backup settings in these pages, refer to the obtool backup command options in the Oracle Secure Backup Reference in the Oracle Database documentation library.

15.7.1.2 Backing Up Oracle Fusion Applications Using Cloud Control

By default, Cloud Control backs up the core directories and databases that comprise a Oracle Fusion Applications installation. You can include additional files and databases in the backup. It also allows you to execute user-defined pre-backup and post-backup scripts.

Because Cloud Control uses Oracle Secure Backup to perform the backups, all backups are done to tape, which is the media supported by Oracle Secure Backup.

To back up a Oracle Fusion Applications environment using Cloud Control:

1. Ensure that you have met the prerequisites, as described in Section 15.5.

2. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page is displayed.

3. Click the Fusion Instance that you want to back up.
The Fusion Instance home page is displayed.

4. From the Fusion Instance menu, choose Control, then Schedule Backup.
The Schedule Backup wizard is displayed, with the first step, Backup Scope, as shown in the following figure:

5. In the Backup Scope step:

1. Select the Oracle Secure Backup domain to use for the backup.

2. Select the scope of the backup. You can select:

- Software and Configuration Directories: Backs up all directories in the Oracle Fusion Applications installation, including the Applications Home directory (the root of the Oracle Fusion Applications installation) and any other directories (for example, Domain homes) that may be installed in a different location. Cloud Control will determine the distinct file systems that comprise the installation across all hosts in the environment, and will include the top-level directories needed to constitute a complete backup.

- Configuration Directories: Backs up only the configuration-related directories, including the Domain home of the Administrative Server for each Oracle WebLogic Server domain. You can select the following options:
All: Back up all configuration directories.

Custom: Narrow the scope of the backup by selecting specific Oracle Fusion Applications components. (On the next page, you can further select which of their associated directories to include in the backup.)

Click Next.

6. In the Directories step, specify the Oracle Fusion Applications directories to include in the backup. By default, the directories that correspond to the backup scope choice (made on the Backup Scope page) are included. If you chose the Custom option, you can remove directories from the list. (The list of directories that correspond to the backup scope are automatically determined by Cloud Control. It is not possible to individually select or remove subdirectories from the backup.) Click Add to specify additional files or directories to include in the backup from outside the core Oracle Fusion Applications installation. Any directories or files that reside on a discovered Oracle Secure Backup client host can be included.
Click Next.

7. In the Databases step, click Add to specify additional databases to add to the backup. By default, the Oracle Fusion Applications repository database is included in the backup.
Click Next.

8. In the Configuration step, select the backup configuration to use for the backup. (See the Section 15.7.1.1 for details on creating a backup configuration.)
Click Next.

9. In the Options step:

1. Select the backup type:

- Full: A full backup of the databases and files will be performed. If the database portion of the backup is to be used as the base of an incremental backup strategy, select the Use as the base of an incremental backup strategy option.

- Incremental: An incremental backup of the databases and files will be performed.

2. Select the backup mode:

- Online: The databases will remain running during the backup. You must manually quiesce or shut down the Oracle Fusion Applications processes before submitting the backup, as this is not done automatically by Cloud Control.

- Offline: The databases will be shutdown automatically before the backup. You must manually shut down the Oracle Fusion Applications processes before submitting the backup, as this is not done automatically by Cloud Control.

See Section 4.4 for information about stopping Oracle Fusion Applications processes. Alternatively, you can specify scripts to shutdown the processes in Step 10.

Click Next.

10. In the Scripts step, specify the host name and path of scripts to be run before and after the backup. Post-backup scripts can be specified to run upon success or failure of the backup. The scripts can be run on any discovered host. The scripts must be executable files that exist on the specified hosts. Any type of executable file can be specified.

Click Next.

11. In the Credentials step, if one or more databases is included in the backup, specify the database and host credentials that will be used to back up the databases.
Click Next.

12. In the Schedule step, specify the procedure name, description, and scheduling information.
Click Next.

13. In the Review step, verify all the input specified in the wizard. Make changes as needed and click Submit. A Cloud Control deployment procedure is submitted to perform the backup, and a confirmation page appears with a link to the deployment procedure status page.

Related Links

The following document provides additional information related to subjects discussed in this section:

- For a description of the backup types, see the Oracle Database Backup and Recovery User's Guide in the Oracle database documentation library.

15.7.2 Performing a Full Offline Backup Using the Command Line

To perform a full offline backup, you copy the file system artifacts and database repositories corresponding to Oracle Fusion Applications. You use your preferred tool for archiving and compressing, as described in Section 15.3. Ensure that the tool you are using preserves the permissions of the files.

To perform a full offline backup:

1. Stop all processes. See Section 4.4.3.2.

2. Back up the Applications base directory on all hosts. For example:

(UNIX) tar -cpf ApplBase_backup_030212.tar APPLICATIONS_BASE/*
(Windows) jar  cf ApplBase_backup_030212.tar APPLICATIONS_BASE\*

3. Back up the Applications configuration directory on all hosts. For example:

(UNIX) tar -cpf ApplConfig_backup_030212.tar APPLICATIONS_CONFIG/*
(Windows) jar  cf ApplConfig_backup_030212.tar APPLICATIONS_CONFIG\*

4. If a domain is not located within the Applications configuration home, back up the domains separately. This backs up the Managed Servers that are running Java components such as Oracle SOA Suite and Oracle WebCenter Portal.
For example:

(UNIX) tar -cpf domain_home_backup_030212.tar APPLICATIONS_CONFIG/instance/domains/domain_name/*
(Windows) jar  cf domain_home_backup_030212.jar APPLICATIONS_CONFIG\instance\domains\domain_name\*

In most cases, you do not need to back up the Managed Server directories separately, because the Administration Server domain contains information about the Managed Servers in its domain. See Section 15.3.3 for information about what you need to back up.

5. If the Oracle instance home is not located within the Applications base home, back up the Oracle instance home. The Oracle instance home contains configuration information about system components, such as the Global Order Promising component of Oracle Fusion Supply Chain Management.
For example:

(UNIX) tar -cpf instance_home_backup_030212.tar ORACLE_INSTANCE/*
(Windows) jar  cf instance_home_backup_030212.jar ORACLE_INSTANCE\*

6. If a Managed Server is not located within the domain, back up the Managed Server directory. For example:

(UNIX) tar -cpf man_server1_backup_030212.tar APPLICATIONS_CONFIG/instance/domains/domain_name/servers/server_name/*
(Windows) jar  cf man_server1_backup_030212.jar APPLICATIONS_CONFIG\instance\domains\domain_name\servers\server_name\*

7. Back up the OraInventory directory. For example:

(UNIX) tar -cpf Inven_home_backup_030212 /scratch/oracle/OraInventory
(Windows) jar cf Inven_home_backup_030212.jar C:\Program Files\Oracle\Inventory

8. On UNIX, back up the OraInst.loc file, which is located in the following directory:

(Linux and IBM AIX) /etc
(Other UNIX systems) /var/opt/oracle

9. On UNIX, back up the oratab file, which is located in the following directory:

/etc

Note that the oratab file is located on the database host.

10. Back up the databases using the Oracle Recovery Manager (RMAN). For detailed steps, see Section 15.10.8 and Section 15.11.4.

11. On Windows, export the following registry key:

HKEY_LOCAL_MACHINE\Software\oracle

In addition, for system components, export the following Windows Registry key:

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services

To export a key, use the following command:

regedit /E  filename key

For example:

regedit /E C:\oracleregistry.reg HKEY_LOCAL_MACHINE/oracle

You can also use the Registry Editor to export the key. See the Registry Editor Help for more information.

12. Create a record of your Oracle Fusion Applications environment. See Section 15.8.

15.7.3 Performing an Online Backup of Configuration Files Using the Command Line

You should perform a backup of configuration files on a regular basis and at the times described in Section 15.3.3.

To back up configuration files:

1. To avoid an inconsistent backup, do not make any configuration changes until the backup is completed. To ensure that no changes are made in the WebLogic Server domain, lock the WebLogic Server configuration, as described in Section 2.7.2

2. Back up the domain directories. This backs up the Managed Servers that are running Java components such as Oracle SOA Suite and Oracle WebCenter Portal. For example:

(UNIX) tar -cpf domain_home_backup_030212.tar APPLICATIONS_CONFIG/instance/domains/domain_name/*
(Windows) jar  cf domain_home_backup_030212.jar APPLICATIONS_CONFIG\instance\domains\domain_name\*

3. Back up the Oracle instance home. This backs up the system components, such as Oracle HTTP Server. For example:

(UNIX) tar -cpf instance_home_backup_030212.tar ORACLE_INSTANCE/*
(Windows) jar  cf instance_home_backup_030212.jar ORACLE_INSTANCE\*

4. Back up the databases using the Oracle Recovery Manager (RMAN). For detailed steps, see Section 15.10.8 and Section 15.11.4.

15.8 Creating a Record of Your Oracle Fusion Applications Configuration

If you need to restore and recover your Oracle Fusion Applications environment, it is important to have all the necessary information at your disposal. This is especially true in the event of a hardware loss that requires you to reconstruct all or part of your Oracle Fusion Applications environment on a new disk or host.

You should maintain an up-to-date record of your Oracle Fusion Applications environment that includes the information listed in this section. You should keep this information both in hardcopy and electronic form. The electronic form should be stored on a host or email system that is completely separate from your Oracle Fusion Applications environment.

Your Oracle Fusion Applications hardware and software configuration record should include:

- The following information for each host in your environment:

- Host name

- Virtual host name (if any)

- Domain name

- IP address

- Hardware platform

- Operating system release level and patch information

- The following information for each Oracle Fusion Applications installation in your environment:

- Installation type (for example, Oracle SOA Suite, Oracle Fusion Supply Chain Management)

- Host on which the installation resides

- User name, user ID number, group name, group ID number, environment profile, and type of shell for the operating system user that owns the Oracle home (/etc/passwd and /etc/group entries)

- Directory structure, mount points, and full path for the Applications base directory, Applications configuration directory, Middleware home, Oracle Common home, Oracle homes, Oracle WebLogic Server domain homes, and the Oracle instance homes

- Amount of disk space used by the installation

- Port numbers used by the installation

- The following information for the databases containing the metadata for components and any other databases used by Oracle Fusion Applications:

- Host name

- Database version and patch level

- Base language

- Character set

- Global database name

- SID

- The following information about backups:

- The time of the backup.

- The contents of the backup. For example, a full backup, a backup of a domain.

- The tool used to create the backup.

- Where the backup is stored.

15.9 Recovering Using Cloud Control

You can recover an Oracle Fusion Applications environment with Cloud Control. Cloud Control restores the directories and databases of a Oracle Fusion Applications backup. All directories and databases of the backup are restored by default. Optionally, you can select individual directories and databases to be restored.

The restore capability provided by Cloud Control is one part of a larger process that must be performed to recover a Oracle Fusion Applications environment or individual Oracle Fusion Applications components. After you restore Oracle Fusion Applications directories and databases using Cloud Control, you must perform additional manual steps depending on the component that your are restoring. Those steps are described in Section 15.10 and Section 15.11.

To recover Oracle Fusion Applications with Cloud Control:

1. Ensure that you have met the prerequisites, as described in Section 15.5.

2. From the Targets menu, choose Fusion Applications.
The Fusion Applications target home page is displayed.

3. Click the Fusion Instance that you want to recover.
The Fusion Instance home page is displayed.

4. From the Fusion Instance menu, choose Control, then Perform Restore.
The Perform Restore wizard is displayed, as shown in the following figure:

5. In the Select Backup step, select the backup to restore from the list of available backups for the Fusion Instance target.
Click Next.

6. In the Components step, the Oracle Fusion Applications components and databases included in the selected backup are listed. Select one or more components to include in the restore. The directories that correspond to the selected components will be shown on the next page. If multiple components are selected that have common directories, those common directories will be included along with any directories that are specific to individual components.
Click Next.

7. In the Directories step, the directories that correspond to the selected Oracle Fusion Applications components are listed in the first table. By default, they will all be restored to their original locations. You can remove directories that should not be included in the restore from the table. You can change the destination host name and path where the directories will be restored. (Note that Oracle Fusion Applications directories must be restored to their original paths to successfully recover the environment. However, restoring to different paths is supported to provide the option of restoring to a temporary staging location in preparation for eventual movement to the final location.)
While you can remove complete directories from the list, you cannot select or remove individual subdirectories or files under the top-level directories shown in the list. If a more fine-grained restore granularity is desired, individual files and subdirectories can be restored by using the Perform Restore wizard available from the Oracle Secure Backup Domain home page. (From that home page, select Manage, then File System Backup/Restore, and then Perform Restore.)

In addition, any additional files or directories included in the backup are listed in a separate table, and will be restored to their original locations by default. Directories and files can be removed from the table and you can change the destination host name and path.

Click Next.

8. In the Configuration step, the original backup configuration used to create the backup is displayed. If the backup configuration is still available it will be used by default and no user action is required on this page. If the configuration is not available, select an alternate backup configuration that has settings similar to backup configuration used to create the backup.
Click Next.

9. In the Scripts step, specify pre-restore and post-restore scripts that will be executed as part of the restore operation. Scripts can be run on any discovered host. The scripts must be executable files that exist on the specified hosts.
The Oracle Fusion Applications components being restored must be shut down before being restored. Because this is not done automatically by Cloud Control, the appropriate shutdown scripts can be executed as part of the restore procedure by specifying them as pre-restore scripts.

Click Next.

10. In the Credentials step, if one or more databases is included in the restore operation, specify both database and host credentials that will be used to restore the databases.
Click Next.

11. In the Schedule step, specify the procedure name, description, and scheduling information.
Click Next.

12. In the Review step, verify all the input specified in the wizard. Make changes as needed and click Submit.

15.10 Recovering After Data Loss, Corruption, or Media Failure

This section describes recovery strategies for outages that involve actual data loss or corruption, or media failure where the disk cannot be restored. It also describes recovery strategies for applications that are no longer functioning properly. This type of failure requires some type of data restoration before the Oracle Fusion Applications environment can be restarted and continue with normal processing.

Depending on the extent of the failure, you can recover the Applications base directory, the Middleware homes, the Administration Server, a Managed Server, or the database. Some Oracle Fusion Applications components require additional steps, which are described in subsequent sections.

This section includes the following topics:

- Section 15.10.1, "Recovering the Applications Base Directory"

- Section 15.10.2, "Recovering a Middleware Home"

- Section 15.10.3, "Recovering an Oracle WebLogic Server Domain"

- Section 15.10.4, "Recovering an Oracle Home"

- Section 15.10.5, "Recovering an Oracle Instance Home"

- Section 15.10.6, "Recovering the Administration Server Configuration"

- Section 15.10.7, "Recovering a Managed Server"

- Section 15.10.11.2, "Recovering Oracle WebCenter Content"

- Section 15.10.8, "Recovering the Databases"

- Section 15.10.9, "Reconciling the Data"

This section also includes the following topics which describe additional considerations you may need to take for particular components:

- Section 15.10.10, "Recovering Oracle Fusion Applications"

- Section 15.10.11, "Recovering Components Related to Oracle Fusion Applications"

Related Links

The following document provides additional information related to subjects discussed in this section:

- For information about recovering Oracle Fusion Middleware components, such as Oracle SOA Suite, see the "Recovering Your Environment" section in the Oracle Fusion Middleware Administrator's Guide in the Oracle Fusion Middleware documentation library.

15.10.1 Recovering the Applications Base Directory

To recover an Applications base directory that was corrupted or from which files were deleted:

1. Stop all relevant processes. That is, stop all processes that are related to Oracle Fusion Applications, such as the Administration Server, Node Manager, Managed Servers, and Oracle instances, as described in Section 4.4.3.2.

2. Recover the Applications base directory from the backup file. For example:

(UNIX) tar -xf ApplBase_backup_030212.tar
(Windows) jar xtf ApplBase_backup_030212.jar

3. Start all relevant processes. That is, start all processes that run in the Applications base home, as described in Section 4.4.3.1.

15.10.2 Recovering a Middleware Home

To recover a Middleware home that was corrupted or from which files were deleted:

1. Stop all relevant processes. That is, stop all processes that run in the Middleware home, such as the Administration Server, Node Manager, Managed Servers, and Oracle instances, as described in Section 4.4.3.2.

2. Recover the Middleware home directory from the backup file. For example:

cd MW_HOME
(UNIX) tar -xf mw_home_backup_030212.tar
(Windows) jar xtf mw_home_backup_030212.jar

3. Start all relevant processes. That is, start all processes that run in the Middleware home, as described in Section 4.4.3.1.

15.10.3 Recovering an Oracle WebLogic Server Domain

To recover an Oracle WebLogic Server domain that was corrupted or deleted from the file system:

1. Stop all relevant processes. That is, stop all processes that are related to the domain, such as the Administration Server and Managed Servers, as described in Section 4.4.3.2.

2. Recover the domain directory from the backup file:

cd DOMAIN_HOME
(UNIX) tar -xf domain_backup_030212.tar
(Windows) jar xtf domain_backup_030212.jar

3. Start all relevant processes. That is, start all processes that are related to the domain, as described in Section 4.4.3.1.

4. If you cannot start the Administration Server, recover it, as described in Section 15.10.6.

5. If you cannot start a Managed Server, recover it, as described in Section 15.10.7.

15.10.4 Recovering an Oracle Home

To recover an Oracle home from the backup file:

1. Recover the Oracle home to the original directory from a backup file. For example:

cd ORACLE_HOME
(UNIX) tar -xf Oracle_home_backup_030212.tar
(Windows) jar xtf Oracle_home_backup_030212.jar

2. Restart the Managed Server to which applications are deployed, using the WLST start command. For example:

wls:/mydomain/serverConfig> start('myserver','Server')

15.10.5 Recovering an Oracle Instance Home

An Oracle instance home contains configuration information for system components, such as Oracle HTTP Server or Oracle Internet Directory.

This section includes the following topics:

- Section 15.10.5.1, "Recovering After Oracle Instance Home Deleted from File System"

- Section 15.10.5.2, "Recovering After Oracle Instance Home Deregistered"

15.10.5.1 Recovering After Oracle Instance Home Deleted from File System

To recover an Oracle instance home that was corrupted or deleted from the file system:

1. Stop all relevant processes. That is, kill all processes that are related to that Oracle instance.

2. Recover the Oracle instance home directory from a backup file. For example:

cd ORACLE_INSTANCE
(UNIX) tar -xf instance_home_backup_030212.tar
(Windows) jar xtf instance_home_backup_030212.jar

3. Start all relevant processes. That is, start all processes that are related to that Oracle instance:

opmnctl startall

15.10.5.2 Recovering After Oracle Instance Home Deregistered

An Oracle instance must be registered with the domain. To recover an Oracle instance home that was deregistered from the domain:

1. Recover the Oracle instance home directory from a backup file. For example:

cd ORACLE_INSTANCE
(UNIX) tar -xf instance_home_backup_030212.tar
(Windows) jar xtf instance_home_backup_030212.jar

2. Register the Oracle instance, along with all of its components, with the Administration Server, using the opmnctl registerinstance command. For example:

opmnctl registerinstance -adminHost admin_server_host
-adminPort admin_server_port -adminUsername username
-adminPassword password
-oracleInstance ORACLE_INSTANCE_dir -oracleHome ORACLE_HOME_dir
-instanceName Instance_name -wlserverHome Middleware_Home

15.10.6 Recovering the Administration Server Configuration

If the Administration Server configuration has been lost because of file deletion or file system corruption, the Administration Server console continues to function if it was already started when the problem occurred. The Administration Server directory is regenerated automatically, except for security information. Consequently, whenever you start the Administration Server, it prompts for a user name and password. To prevent this, you can recover the configuration.

Caution:

Performing a domain-level recovery can impact other aspects of a running system and all of the configuration changes performed after the backup was taken will be lost.

To recover the Administration Server configuration:

1. Stop all processes, including the Administration Server, Managed Servers, and Node Manager, if they are started, as described in Section 4.4.3.2.

2. Recover the Administration Server configuration by recovering the domain home backup to a temporary location. Then, restore the config directory to the following location:

(UNIX) DOMAIN_HOME/config
(Windows) DOMAIN_HOME\config

3. Start the Administration Server as described in Section 4.4.4.1.

4. Verify that the Administration Server starts properly and is accessible.

5. Start other processes, as described in Section 4.4.3.1.

On the next configuration change, the configuration from the Administration Server is pushed to the Managed Servers. On each Managed Server restart, the configuration is retrieved from the Administration Server.

15.10.7 Recovering a Managed Server

For many Oracle Fusion Applications, you recover the Managed Server in which the application is deployed. In addition, for some components, you may need to take additional steps, which are described in Section 15.10.10 and Section 15.10.11.

In this scenario, the Managed Server does not operate properly or cannot be started because the configuration has been deleted or corrupted or the configuration was mistakenly changed and you cannot ascertain what was changed.

To recover a Managed Server:

1. If the Administration Server is not reachable, recover the Administration Server, as described in Section 15.10.6.

2. If the Managed Server fails to start or if the file system is lost:

1. Recover the Middleware home from the backup file, if required. For example:

(UNIX) tar -xf mw_home_backup_030212.tar
(Windows) jar xtf mw_home_backup_030212.jar

2. Create a domain template jar file for the Administration Server, using the pack utility.
For example, on UNIX:

pack.sh -domain=APPLICATIONS_CONFIG/instance/domains/domain_name
-template=/scratch/temp.jar -template_name=domain1
-template_author=myname -log=/scratch/logs/my.log -managed=true

For example, on Windows:

pack.cmd -domain=APPLICATIONS_CONFIG\instance\domains\domain_name
-template=C:\temp\temp.jar -template_name=domain1
-template_author=myname -log=C:\temp\logs\my.log -managed=true

Specifying the -managed=true option packs up only the Managed Servers. If you want to pack the entire domain, omit this option.

3. Unpack the domain template JAR file, using the unpack utility.
For example, on UNIX:

unpack.sh -template=/scratch/temp.jar
-domain=APPLICATIONS_CONFIG/instance/domains/domain_name
-log=/scratch/logs/new.log -log_priority=info

For example, on Windows:

unpack.cmd -template=C:\temp\temp.jar
-domain=APPLICATIONS_CONFIG\instance\domains\domain_name
-log=C:\temp\logs\new.log -log_priority=info

4. Ensure that the application artifacts are accessible from the Managed Server host. That is, if the application artifacts are not on the same server as the Managed Server, they must be in a location accessible by the Managed Server.

Note:

- For stage mode applications, the Administration Server copies the application bits to the staged directories on the Managed Server hosts.

- For nostage and external-stage mode applications, ensure that application files are available in the stage directories of the Managed Server.

5. Start the Managed Server, as described in Section 4.4.4.1.
The Managed Server connects to the Administration Server and updates its configuration changes.

15.10.8 Recovering the Databases

You can recover the databases used by Oracle Fusion Applications using RMAN. You can recover the databases at whatever level is appropriate by performing a restore and recover of the full database, a tablespace, or a data file.

Oracle Fusion Customer Relationship Management uses the following databases: Oracle Fusion Applications database, LDAP database, Oracle WebCenter Content, and Oracle Identity Manager database. You must maintain consistency among the databases. If any of these databases are recovered to a different point in time, you may need to reconcile the databases.

For information about recovering databases, see the Oracle Database Backup and Recovery User's Guide.

For information about reconciling the databases, see Section 15.10.9.

15.10.9 Reconciling the Data

The following topics describe how to recover and reconcile the databases to maintain consistency among the Oracle Fusion Applications database, LDAP database, and Oracle Identity Manager database.

- Section 15.10.9.1, "Recovering the Oracle Identity Manager Database and Reconciling It with the LDAP Database"

- Section 15.10.9.2, "Recovering the Oracle Fusion Applications Database and Reconciling It with the LDAP Database"

- Section 15.10.9.3, "Recovering the LDAP Database Using Multimaster Replication"

15.10.9.1 Recovering the Oracle Identity Manager Database and Reconciling It with the LDAP Database

Oracle Identity Manager users, role categories, role hierarchies, and role memberships are stored in the Oracle Identity Manager database. When a change in the information about users or roles takes place in Oracle Identity Manager, this information is propagated to the LDAP identity store. If the change takes place in the LDAP identity store directly, these changes are synchronized into Oracle Identity Manager. The LDAP identity store can be Oracle Internet Directory or any third party solutions such as Active Directory.

To recover the Oracle Identity Manager database, use RMAN to perform a point-in-time recovery of the Oracle Identity Manager database.

If you restore the Oracle Identity Manager database to a different point in time than the LDAP store, the reconciliation engine checks the change logs and reapplies all the changes that happened in the time period between the restore of the LDAP store and the Oracle Identity Manager database. For example, if the Oracle Identity Manager database is restored so that is 10 hours behind the LDAP store, the reconciliation engine checks the change logs and reapplies all the changes that happened in the last 10 hours in the LDAP store to the Oracle Identity Manager database.

You do not need to explicitly trigger the reconciliation. LDAP synchronization is set up as a scheduled task to submit reconciliation events periodically. You can also start the reconciliation process manually and monitor the reconciliation events from the Oracle Identity Manager console.

Note:

Oracle recommends that you make sure that the Oracle Identity Manager application is unavailable to the end users when a bulk reconciliation is occurring (as in the above recovery scenario). When the bulk reconciliation is complete, make sure that the Oracle Identity Manager application is again available to the end users. You can monitor the reconciliation with the Oracle Identity Manager console.

Related Links

The following documents provide additional information related to subjects discussed in this section:

- For information on recovering a database, see Oracle Database Backup and Recovery User's Guide in the Oracle Database documentation library.

- For information about reconciliation of the LDAP store, see "Reconciliation Configuration" in Oracle Fusion Middleware User's Guide for Oracle Identity Manager in the Oracle Fusion Middleware documentation library.

15.10.9.2 Recovering the Oracle Fusion Applications Database and Reconciling It with the LDAP Database

If the Oracle Fusion Applications database fails, and you restore it to a different point in time than the Oracle Identity Manager database, you may lose some user and roles data. For example, if you have created some users and roles in the Oracle Identity Manager database before the Oracle Fusion Applications database is restored, those users and roles will also exist in the LDAP database, but they will not exist in the Oracle Fusion Applications database.

To reconcile the Oracle Fusion Applications database with the Oracle Identity Manager and LDAP databases:

1. Restore the Oracle Fusion Applications database using RMAN to perform a point-in-time recovery. See Section 15.10.8 and Section 15.11.4.

2. Synchronize the user and role information:

1. Log in to the HcmCore application as the HR_SPEC_ALL user.

2. Click EssLink.

3. Click Retrieve Latest LDAP Changes.

4. Click Submit.

This is an asynchronous process that runs in the background.

3. When the process completes, find the users that were created in Oracle Identity Manager before the Oracle Fusion Applications database was restored. Use the following SQL command, where creation_date is the time you started running the synchronization process in Step 2:

select * from per_users where creation_date > creation_date

4. For each user returned in the previous step, you create the user in Oracle Fusion Human Capital Management.

5. For each user, create the user's roles, as described in "User and Role Provisioning" in the HCM Foundation help.

Related Links

The following document provides additional information related to subjects discussed in this section:

- For information about creating users in Oracle Fusion Human Capital Management, see "Creating and Updating Person and Employment Records" in the HCM Foundation help.

15.10.9.3 Recovering the LDAP Database Using Multimaster Replication

Oracle recommends that you use multi-master replication for your LDAP database, as described in the "Setting up Multimaster Replication" section in the Oracle Fusion Middleware High Availability Guide.

When you use multimaster replication, if one LDAP node fails, the LDAP traffic is automatically routed to another node. You do not need to take any further action.

15.10.10 Recovering Oracle Fusion Applications

In most cases, to recover Oracle Fusion Applications, you recover a Middleware home, a domain, a server, an Oracle home, or an Oracle instance, depending on the extent of the failure. However, you may need to take additional steps for particular components.

This section includes the following topics:

- Section 15.10.10.1, "Recovering Oracle Fusion Customer Relationship Management"

- Section 15.10.10.2, "Recovering Oracle Fusion Procurement"

15.10.10.1 Recovering Oracle Fusion Customer Relationship Management

To recover Oracle Fusion Customer Relationship Management:

1. Recover the Managed Server to which Oracle Fusion Customer Relationship Management is deployed, as described in Section 15.10.7.

2. Recover the Java servers for Oracle E-Mail and Web Marketing, as described in Section 15.10.11.6.

3. Note that the Oracle Product Data Quality repository (the FUSION_DQ schema) and the customer source must be kept synchronized. If you restore one, restore the other to the same point in time. In addition, the Data Quality engine server artifacts in the file system, the Data Quality Admin Configuration data in the customer master (fusion), and the deployment topology must be kept synchronized.

For a complete case study for recovering Oracle Fusion Customer Relationship Management in different recovery scenarios, see Section 15.12.

15.10.10.2 Recovering Oracle Fusion Procurement

To recover Oracle Fusion Procurement:

1. Recover the Managed Server to which the application is deployed, as described in Section 15.10.7.

2. If you use a certificate file to make SSL connections to supplier's web sites, make sure that the certificate file exists in the location that you specified. If it does not, recover it from the backup file.

15.10.11 Recovering Components Related to Oracle Fusion Applications

You may need to recover components related to Oracle Fusion Applications.

This section includes the following topics:

- Section 15.10.11.1, "Recovering Oracle HTTP Server"

- Section 15.10.11.2, "Recovering Oracle WebCenter Content"

- Section 15.10.11.3, "Recovering Oracle Enterprise Scheduler"

- Section 15.10.11.4, "Recovering Oracle Enterprise Crawl and Search Framework"

- Section 15.10.11.5, "Recovering Oracle Authorization Policy Manager"

- Section 15.10.11.6, "Recovering Oracle E-Mail and Web Marketing"

- Section 15.10.11.7, "Recovering Oracle BI Enterprise Edition"

- Section 15.10.11.8, "Recovering Oracle Business Intelligence Publisher"

- Section 15.10.11.9, "Recovering Oracle Real-Time Decisions"

- Section 15.10.11.10, "Recovering Oracle Essbase"

- Section 15.10.11.11, "Recovering Oracle Hyperion Calculation Manager"

- Section 15.10.11.12, "Recovering Oracle Hyperion Financial Reporting"

- Section 15.10.11.13, "Recovering Oracle Hyperion Smart View"

15.10.11.1 Recovering Oracle HTTP Server

To recover Oracle HTTP Server, you recover the Oracle instance that contains Oracle HTTP Server, as described in Section 15.10.5.

15.10.11.2 Recovering Oracle WebCenter Content

To recover Oracle WebCenter Content:

1. If necessary, restore the database, as described in Section 15.10.8.

2. Restore the domain, as described in Section 15.10.3.

3. If the Vault, WebLayout, or Search directories are not located in the domain directory, restore those directories, if necessary. For example, if the Vault directory is located on a shared drive in /net/home/vault, restore it from backup:

cd /net/home/vault
tar -xf vault_backup_042012.tar

Note that you should restore the database and the shared file system at the same time. If you cannot do that, you can use the IDCAnalyse utility to determine if there are any inconsistencies between the database and the shared file system. If there are, you can perform a manual recovery using IDCAnalyse.

15.10.11.3 Recovering Oracle Enterprise Scheduler

To recover Oracle Enterprise Scheduler:

1. Recover the domain directory from the backup file, as described in Section 15.10.3.

2. Recover the Oracle home to the original directory from the backup file, as described in Section 15.10.4.

3. Recover the database containing the Oracle Fusion applications and MDS schemas to the most recent point in time, if needed, as described in Section 15.10.8.

15.10.11.4 Recovering Oracle Enterprise Crawl and Search Framework

To recover Oracle Enterprise Crawl and Search Framework:

1. Recover the domain directory from the backup file, as described in Section 15.10.3.

2. Recover the database containing schemas related to Oracle Enterprise Crawl and Search Framework, as described in Section 15.10.8.

15.10.11.5 Recovering Oracle Authorization Policy Manager

To recover Oracle Authorization Policy Manager:

1. Stop all relevant processes. That is, stop all processes that are related to the domain, such as the Administration Server and Managed Servers, as described in Section 4.4.3.2.

2. Recover the domain directory from the backup file, as described in Section 15.10.3.

3. Recover the Oracle home to the original directory from the backup file, as described in Section 15.10.4.

4. Recover the LDAP store, if necessary.
See the "Recovering Components" section in the Oracle Fusion Middleware Administrator's Guide.

5. Recover the database, if necessary. See Section 15.10.8.

6. Start all relevant processes. That is, start all processes that are related to the domain, as described in Section 4.4.3.1.

15.10.11.6 Recovering Oracle E-Mail and Web Marketing

To recover Oracle E-Mail and Web Marketing:

1. Recover the Managed Servers to which the Email Sending Daemon and Click Thru Daemon are deployed, as described in Section 15.10.7.

2. Recover the installation directory for the Bounce Handling Daemon.

15.10.11.7 Recovering Oracle BI Enterprise Edition

The following topics describe how to recover Oracle BI EE:

- Recovering Oracle BI Enterprise Edition in a Non-Clustered Environment

- Recovering Oracle BI Enterprise Edition in a Clustered Environment

Note:

When you recover Oracle BI EE, you must ensure that the Oracle BI Presentation Catalog and the Oracle BI EE repository (RPD) are restored to the same point in time, by using the same backup set.

15.10.11.7.1 Recovering Oracle BI Enterprise Edition in a Non-Clustered Environment

This scenario assumes that Oracle BI Enterprise Edition is running in a non-clustered environment.

1. Restore the following, depending on the extent of the failure:

- If the entire Middleware home is lost, restore the Middleware home, as described in Section 15.10.2.

- If the Oracle instance home is lost, restore the Oracle instance home, as described in Section 15.10.5.

- If the domain home is lost on the Administration Server node, restore it, as described in Section 15.10.3.

- If the domain home is lost on the Managed Server node, restore it, as described in Section 15.10.3.

2. Recover the Administration Server, as described in Section 15.10.6.

3. Recover the Managed Server, as described in Section 15.10.7.

4. If necessary, restore the database containing the Oracle BI EE schemas. See Section 15.10.8.

5. Reconcile the LDAP Database with the Oracle BI EE repository (RPD), as described in Section 15.10.11.7.3, and with the Oracle BI Presentation Catalog, as described in Section 15.10.11.7.4.

15.10.11.7.2 Recovering Oracle BI Enterprise Edition in a Clustered Environment

This scenario assumes that Oracle BI Enterprise Edition is running in a clustered environment.

To recover Oracle BI EE in a clustered environment:

1. Restore the following, depending on the extent of the failure:

- If the entire Middleware home is lost, restore the Middleware home, as described in Section 15.10.2.

- If the Oracle instance home is lost, restore the Oracle instance home, as described in Section 15.10.5.

- If the domain home is lost on the Administration Server node, restore it, as described in Section 15.10.3.

- If the domain home is lost on the Managed Server node, restore it, as described in Section 15.10.3.

2. Recover the Administration Server, as described in Section 15.10.6.

3. Recover all Managed Servers, as described in Section 15.10.7.

4. If necessary, restore the database containing the Oracle BI EE schemas, as described in Section 15.10.8.

5. Reconcile the LDAP Database with the Oracle BI EE repository (RPD), as described in Section 15.10.11.7.3, and with the Oracle BI Presentation Catalog, as described in Section 15.10.11.7.4.

15.10.11.7.3 Reconciling the LDAP Database with RPD

You must reconcile the LDAP database with the Oracle BI EE repository (RPD).

Oracle BI Enterprise Edition provides a method to perform synchronization. You can enable automatic synchronization, at all times, or temporarily to perform the synchronization. (See "NQSConfig.INI File Configuration Settings" in the Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition for information about editing the NQSConfig.ini file.)

- To enable synchronization:

1. Edit the following file:

INSTANCE_HOME/config/OracleBIServerComponent/coreapplication_obis1/NQSConfig.INI

Set the flag FMW_UPDATE_ROLE_AND_USER_REF_GUIDS to yes.

2. Restart the servers. The information in the LDAP database and RPD is synchronized.

- To disable synchronization:

1. To disable synchronization, edit the following file:

INSTANCE_HOME/config/OracleBIServerComponent/coreapplication_obis1/NQSConfig.INI

Set the flag FMW_UPDATE_ROLE_AND_USER_REF_GUIDS to no.

2. Restart the servers.

On Windows, the Oracle BI Administration Tool provides a Consistency Check Manager that checks the validity of your repository and allows you to correct the inconsistencies. For more information, see "Checking the Consistency of Repository Objects" in the Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition (Oracle Fusion Applications Edition).

15.10.11.7.4 Reconciling the LDAP database with Oracle BI Presentation Catalog

If the LDAP database is restored to a previous point in time resulting in the LDAP database being behind in time to the Oracle BI Presentation Catalog, use the following command to reconcile the LDAP database with the Oracle BI Presentation Catalog:

runcat.cmd -cmd forgetAccounts

For information about the runcat command, see the help:

./runcat.sh -cmd maintenanceMode -help

15.10.11.8 Recovering Oracle Business Intelligence Publisher

To recover Oracle Business Intelligence Publisher:

1. Recover the Managed Server containing the Oracle Business Intelligence Publisher component, as described in Section 15.10.7.

2. If necessary, restore the database containing the Oracle Business Intelligence Publisher schemas, as described in Section 15.10.8.

If backup artifacts are restored from different times, then user accounts, user reports, and user permissions revert to the restored version. Restore all artifacts from the same point in time.

15.10.11.9 Recovering Oracle Real-Time Decisions

To recover Oracle Real-Time Decisions:

1. Recover the Managed Server containing the Oracle Real-Time Decisions component, as described in Section 15.10.7.

Note that if backup artifacts are restored from a different time, the analytic models miss a period of learning, but their intelligence is unaffected.

15.10.11.10 Recovering Oracle Essbase

To recover Oracle Essbase:

1. Recover the Middleware home, as described in Section 15.10.2

2. If the Oracle instance does not reside in the Middleware home, recover it, as described in Section 15.10.5

15.10.11.11 Recovering Oracle Hyperion Calculation Manager

To recover Oracle Hyperion Calculation Manager:

1. Recover the Managed Server to which Oracle Hyperion Calculation Manager is deployed, as described in Section 15.10.7.

2. If necessary, recover the database to the most recent point in time, or import the artifacts using the Oracle Hyperion Calculation Manager import tool.

15.10.11.12 Recovering Oracle Hyperion Financial Reporting

To recover Oracle Hyperion Financial Reporting:

1. Recover the Oracle Hyperion Financial Reporting Oracle home, as described in Section 15.10.7.

2. Recover the Oracle instance, as described in Section 15.10.5.

3. If necessary, recover the database to the most recent point in time.

15.10.11.13 Recovering Oracle Hyperion Smart View

To recover Oracle Hyperion Smart View:

1. Restore the Oracle Hyperion Smart View data files:

- Microsoft Excel files (XLS and XLSX)

- Microsoft Word files (DOC and DOCX)

- Microsoft Powerpoint files (PPT and PPTX)

15.11 Recovering After Loss of Host

This section describes recovery strategies after losing the original operating environment. For example, you could have a serious system malfunction or loss of media.

Depending on the extent of the failure, you can recover the Applications base directory, the Administration Server, a Managed Server, or the database. Some Oracle Fusion Applications components require additional steps, which are described in subsequent sections.

This section includes the following topics:

- Section 15.11.1, "Recovering the Applications Base Directory After Loss of Host"

- Section 15.11.2, "Recovering After Loss of Administration Server Host"

- Section 15.11.3, "Recovering After Loss of Managed Server Host"

- Section 15.11.4, "Recovering the Databases After Loss of Host"

- Section 15.11.5, "Additional Actions for Recovering Entities After Loss of Host"

This section also includes the following topics, which describe additional considerations you may need to take for Oracle Fusion Applications components:

- Section 15.11.6, "Recovering Oracle Fusion Applications After Loss of Host"

- Section 15.11.7, "Recovering Components Related to Oracle Fusion Applications"

15.11.1 Recovering the Applications Base Directory After Loss of Host

You can recover the Applications base directory if you lose the host that contains the directory.

To recover the Applications base directory:

1. Recover the Applications base directory from the backup file. For example:

cd APPLICATIONS_BASE
(UNIX) tar -xf ApplBase_backup_030212.tar
(Windows) jar xtf ApplBase_backup_030212.jar

2. Start all relevant processes. That is, start all processes that run in the Applications base home, as described in Section 4.4.3.1.

15.11.2 Recovering After Loss of Administration Server Host

If you lose a host that contains the Administration Server, you can recover it to the same host or a different host.

This section includes the following topics:

- Section 15.11.2.1, "Recovering the Administration Server to the Same Host"

- Section 15.11.2.2, "Recovering the Administration Server to a Different Host"

15.11.2.1 Recovering the Administration Server to the Same Host

In this scenario, you recover the Administration Server either to the same host after the operating system has been reinstalled or to a new host that has the same host name. For example, the Administration Server is running on Host A and the Managed Server is running on Host B. Host A has failed for some reason and the Administration Server must be recovered.

To recover the Administration Server:

1. Recover the file system. For example, recover the domain containing the Administration Server, as described in Section 15.10.3.

2. Attempt to start the Administration Server, as described in Section 4.4.4.1.
If the Administration Server starts, you do not need to take any further steps.

3. If the Administration Server fails to start, take the following steps on Host A:

1. Stop all relevant processes. That is, stop all processes that are related to the domain, such as the Administration Server and Managed Servers, as described in Section 4.4.3.2.

2. Recover the domain directory from the backup file:

cd DOMAIN_HOME
(UNIX) tar -xf domain_backup_030212.tar
(Windows) jar xtf domain_backup_030212.jar

This restores the Administration Server as well as the Managed Servers in the domain.

3. Start the Administration Server and Managed Servers, as described in Section 4.4.4.1.

4. Start the Node Manager:

java weblogic.WLST
wls:/offline> startNodeManager()

15.11.2.2 Recovering the Administration Server to a Different Host

In this scenario, the Administration Server is running on Host A and the Managed Server is running on Host B. Host A has failed for some reason and the Administration Server must be moved to Host C.

Note:

Note that this scenario assumes that the shared location containing the binary files and the Administration Server configuration is intact. If it is not, follow the steps in Section 15.10.2 through Section 15.10.5.

To recover the Administration Server to a different host:

1. Because you have included a new host, mount the file system to the new host, Host C.

2. If the Administration Server has a Listen address, create a new machine with the new host name, as described in Section 15.11.5.3.

3. When you move .jks files to another host, you may receive warnings from the host name verification. You can regenerate those SSL certificates in the new host to set up SSL and configure a custom host name verifier.
The .jks files are located in the following directory:

(UNIX) APPLICATIONS_BASE/fusionapps/wlserver_10.3/server/lib
(Windows) APPLICATIONS_BASE\fusionapps\wlserver_10.3\server\lib

4. Start the Node Manager on Host C if it was configured on the original host:

java weblogic.WLST
wls:/offline> startNodeManager()

5. Start the Administration Server, as described in Section 4.4.4.1.

6. If the Managed Servers are on the same failed host as the Administration Server, restore the Managed Servers, as described in Section 15.11.3.2.

7. Start the Managed Servers, as described in Section 4.4.4.1.

8. Ensure that additional application artifacts are available. For example, if the deployment mode is nostage or external-stage, applications may reside in directories outside of the domain directory. Make your application files available to the new Administration Server by copying them from backups or by using a shared disk. Your application files should be available in the same relative location on the new file system as on the file system of the original Administration Server.
If the application is staged, the Administration Server copies the application bits to the staged directories on the Managed Server hosts.

9. If your environment contains Oracle HTTP Server, modify the FusionVirtualHost_x.conf file, as described in Section 15.11.5.2.

10. Update Oracle Inventory, as described in Section 15.11.5.4.

11. Edit the targets.xml file for Fusion Middleware Control, as described in Section 15.11.5.1.

Related Links

The following documents provide additional information related to subjects discussed in this section:

- For information about configuring a custom host name verifier, see the "Configure a Custom Host Name Verifier" section in the Oracle WebLogic Server Administration Console Help, which is located at:

http://download.oracle.com/docs/cd/E21764_01/apirefs.1111/e13952/taskhelp/security/ConfigureACustomHostNameVerifier.html

- For information about regenerating SSL certificates, see the "Configuring SSL" chapter in Oracle Fusion Middleware Securing Oracle WebLogic Server in the Oracle Fusion Middleware documentation library.

- For descriptions of different ways to restart Managed Servers, depending on how they were configured, see the "Restarting a Failed Administration Server" section in the Oracle Fusion Middleware Managing Server Startup and Shutdown for Oracle WebLogic Server n the Oracle Fusion Middleware documentation library.

15.11.3 Recovering After Loss of Managed Server Host

If you lose a host that contains a Managed Server, you can recover it to the same host or a different host.

This section includes the following topics:

- Section 15.11.3.1, "Recovering a Managed Server to the Same Host"

- Section 15.11.3.2, "Recovering a Managed Server to a Different Host"

15.11.3.1 Recovering a Managed Server to the Same Host

In this scenario, you recover a Managed Server to the same host after the operating system has been reinstalled or to a new host that has the same host name. The Administration Server is running on Host A and the Managed Server is running on Host B. Host B failed for some reason and the Managed Server must be recovered to Host B.

1. Start the Node Manager on Host B:

java weblogic.WLST
wls:/offline> startNodeManager()

2. Start the Managed Server, as described in Section 4.4.4.1.
If the Managed Server starts, it connects to the Administration Server and updates its configuration changes. You do not need to take any further steps.

3. If the Managed Server fails to start or if the file system is lost:

1. Stop the Node Manager:

java weblogic.WLST
wls:/offline> stopNodeManager()

2. Recover the Middleware home to Host B from the backup file, if required:

cd MW_HOME
(UNIX) tar -xf mw_home_backup_030212.tar
(Windows) jar xtf mw_home_backup_030212.jar

3. Create a domain template jar file for the Administration Server running in Host A, using the pack utility.
For example, on UNIX:

pack.sh -domain=APPLICATIONS_CONFIG/instance/domains/domain_name
-template=/scratch/temp.jar -template_name=domain1
-template_author=myname -log=/scratch/logs/my.log -managed=true

For example, on Windows:

pack.cmd -domain=APPLICATIONS_CONFIG\instance\domains\domain_name
-template=C:\temp\temp.jar -template_name=domain1
-template_author=myname -log=C:\temp\logs\my.log -managed=true

Specifying the -managed=true option packs up only the Managed Servers. If you want to pack the entire domain, omit this option.

4. Unpack the domain template jar file in Host B, using the unpack utility.
For example, on UNIX:

unpack.sh -template=/scratch/temp.jar
-domain=APPLICATIONS_CONFIG/instance/domains/domain_name
-log=/scratch/logs/new.log -log_priority=info

For example, on Windows:

unpack.cmd -template=C:\temp\temp.jar
-domain=APPLICATIONS_CONFIG\instance\domains\domain_name
-log=C:\temp\logs\new.log -log_priority=info

5. Ensure that the application artifacts are accessible from the Managed Server host. That is, if the application artifacts are not on the same server as the Managed Server, they must be in a location accessible by the Managed Server.

Note:

- For applications that are deployed in nostage or external-stage mode, copy the application artifacts from the Administration Server host directory.

- For applications that are deployed in stage mode, the Administration Server copies the application bits to the staged directories on the Managed Server hosts.

6. If the Node Manager is not started, start it:

java weblogic.WLST
wls:/offline> startNodeManager()

7. Start the Managed Server, as described in Section 4.4.4.1.
The Managed Server connects to the Administration Server and updates its configuration changes.

15.11.3.2 Recovering a Managed Server to a Different Host

In this scenario, the Administration Server is running on Host A and the Managed Server is running on Host B. Host B failed for some reason and the Managed Server must be recovered to Host C.

Important:

Recover the Middleware home to the same location as the original.

To recover a Managed Server to a different host:

1. If the Managed Server configuration files are local to the host (that is, they are not on a shared file system):

1. Recover the Middleware home for the Managed Server to Host C.

cd MW_HOME
(UNIX) tar -xf mw_home_backup_030212.tar
(Windows) jar xtf mw_home_backup_030212.jar

Note that when you restore the Middleware home, you are restoring all of the domains because they are on a shared file system.

2. Create a domain template jar file from the Administration Server running in Host A, using the pack utility.
For example, on UNIX:

pack.sh -domain=APPLICATIONS_CONFIG/instance/domains/domain_name
-template=/scratch/temp.jar -template_name=domain1
-template_author=myname -log=/scratch/logs/my.log -managed=true

For example, on Windows:

pack.cmd -domain=APPLICATIONS_CONFIG\instance\domains\domain_name
-template=C:\temp\temp.jar -template_name=domain1
-template_author=myname -log=C:\temp\logs\my.log -managed=true

Specifying the -managed=true option packs up only the Managed Servers. If you want to pack the entire domain, omit this option.

3. Unpack the domain template jar file on Host C, using the unpack utility.
For example, on UNIX:

unpack.sh -template=/scratch/temp.jar
-domain=APPLICATIONS_CONFIG/instance/domains/domain_name
-log=/scratch/logs/new.log -log_priority=info

For example, on Windows:

unpack.cmd -template=C:\temp\temp.jar
-domain=APPLICATIONS_CONFIG\instance\domains\domain_name
-log=C:\temp\logs\new.log -log_priority=info

If you are recovering to a different domain home, use the -app_dir switch in the unpack command.

2. Ensure that the application artifacts are accessible from the Managed Server host. That is, if the application artifacts are not on the same server as the Managed Server, they must be in a location accessible by the Managed Server.

Note:

- For applications that are deployed in nostage or external-stage mode, copy the application artifacts from the Administration Server host directory.

- For applications that are deployed in stage mode, the Administration Server copies the application bits to the staged directories on the Managed Server hosts.

3. If the Managed Server is not co-located with the Administration Server, take the following steps. (These steps are not needed if the Managed Server is co-located with the Administration Server.)

1. Edit the nodemanager.domains file, specifying the domain names and domain directories. Use the following format:

domain_name=domain_directory

2. Start the Node Manager on Host C, if it is not started:

java weblogic.WLST
wls:/offline> startNodeManager()

3. Using WLST, connect to the Administration Server and then enroll the Node Manager running in the new host with the Administration Server:

connect('username','password','host:port')
nmEnroll('APPLICATIONS_CONFIG/instance/domains/domain_name',
'MW_HOME/wlserver_n/common/nodemanager/instance_name')

4. Change the Managed Server configuration to point to the new host:

- In the WebLogic Server Administration Console, create a machine, which is a logical representation of the computer that hosts one or more WebLogic Servers, and point it to the new host. (From the Home page, select Machines. Then, click New.) Follow the directions in the Administration Console help.
If you identify the Listen Address by IP address, you must disable Host Name Verification on the Administration Servers that access Node Manager. For more information, see the "Using Host Name Verification" section in Oracle Fusion Middleware Securing Oracle WebLogic Server.

- Change the Managed Server configuration to point to the new machine. (From the left pane of the Console, expand Environment and then Servers. Then, select the name of the server. Select the Configuration tab, then the General tab. In the Machine field, select the machine to which you want to assign the server.)
Change Listen Address to the new host. (If the listening address was set to blank, you do not need to change it.)

You only need to take these steps once for all Managed Servers on the same host.

4. When you move .jks files to another host, you may receive warnings from the host name verification. You can regenerate those SSL certificates in the new host to set up SSL and configure a custom host name verifier. See the "Configure a Custom Host Name Verifier" section in the Oracle WebLogic Server Administration Console Help. Also, see the "Configuring SSL" chapter in Oracle Fusion Middleware Securing Oracle WebLogic Server.
The .jks files are located in the following directory:

(UNIX) APPLICATIONS_BASE/fusionapps/wlserver_10.3/server/lib
(Windows) APPLICATIONS_BASE\fusionapps\wlserver_10.3\server\lib

5. Start the Managed Server, as described in Section 4.4.4.1.
The Managed Server connects to the Administration Server and updates its configuration changes.

6. If your environment contains Oracle HTTP Server, modify the FusionVirtualHost_x.conf file, as described in Section 15.11.5.2.

7. Edit the targets.xml file for Fusion Middleware Control, as described in Section 15.11.5.1.

Now you can start and stop the Managed Server on Host C using the Administration Server running on Host A.

15.11.4 Recovering the Databases After Loss of Host

If the physical host where your database resides is lost, you can recover the database using RMAN.

See "Restoring a Database on a New Host" in the Oracle Database Backup and Recovery User's Guide to learn how to use RMAN to recover your database in the event of a complete failure on the primary database host computer.

Oracle Fusion Customer Relationship Management uses the following databases: Oracle Fusion Applications database, LDAP database, Oracle WebCenter Content, and Oracle Identity Manager database. You must maintain consistency among the databases. If any of these databases are recovered to a different point in time, you may need to reconcile the databases.

For information about reconciling the LDAP database, the Oracle Fusion Applications database, and the Oracle Identity Manager database, see Section 15.10.9.

15.11.5 Additional Actions for Recovering Entities After Loss of Host

Depending on the entity that you are recovering, you may need to take additional actions after loss of host. The sections about each entity may require you to follow one or more of the following procedures. If so, that is noted in the section describing how to recover the entity.

This section includes the following topics:

- Section 15.11.5.1, "Changing the Host Name in the targets.xml File for Fusion Middleware Control"

- Section 15.11.5.2, "Modifying the FusionVirtualHost_x.conf File"

- Section 15.11.5.3, "Creating a New Machine for the New Host Name"

- Section 15.11.5.4, "Updating Oracle Inventory"

15.11.5.1 Changing the Host Name in the targets.xml File for Fusion Middleware Control

When you recover a component to a different host, you must update the targets.xml file for Fusion Middleware Control. The file is located at:

(UNIX) APPLICATIONS_CONFIG/instance/domains/hostname/domain_name/sysman/state/targets.xml
(Windows) APPLICATIONS_CONFIG\instance\domains\hostname\domain_name\sysman\state\targets.xml

In the file, change the host name to the new host name for components that are recovered to a different host.

15.11.5.2 Modifying the FusionVirtualHost_x.conf File

When you recover an Administration Server or a Managed Server to a different host and your environment includes Oracle HTTP Server, you must modify the FusionVirtualHost_x.conf file on the new host. There is a separate file for each domain, for example FusionVirtualHost_fin.conf. The files are located in:

(UNIX) APPLICATIONS_CONFIG/instance/CommonDomain_webtier/config/OHS/ohs_name/moduleconf/FusionVirtualHost_x.conf
(Windows) APPLICATIONS_CONFIG\instance\CommonDomain_webtier\config\OHS\ohs_name\moduleconf\FusionVirtualHost_x.conf

Modify all of the instances of the host name and clusters (elements such as WebLogicHost and WebLogicCluster) entries in that file. For example:

<Location /console>
SetHandler weblogic-handler
WebLogicHost Admin_Host
WeblogicPort Admin_Port
WLProxySSL ON
WLProxySSLPassThrough ON
</Location>
.
.
.
<Location /soa-infra>
SetHandler weblogic-handler
WebLogicCluster SOAHOST1:8001,*SOAHOST2*:*8001*
WLProxySSL ON
WLProxySSLPassThrough ON
</Location>

15.11.5.3 Creating a New Machine for the New Host Name

If the Administration Server has an Listen address, you must create a new machine with the new host name and set the Listen address, before you start the Administration Server. A machine is a logical representation of the computer that hosts one or more WebLogic Servers.

To create a new machine:

1. Create a new machine with the new host name. Use the following WLST commands, in offline mode:

readDomain('Domain_Home')
machine = create('newhostname', 'Machine')
cd('/Machine/newhostname')
nm = create('newhostname', 'NodeManager')

cd('/Machine/newhostname/NodeManager/newhostname')
set('ListenAddress', 'newhostname')
updateDomain()

2. For the Administration Server, set the machine with the new host name, using the following WLST command, in offline mode:

readDomain('DomainHome')
cd ('/Machine/newhostname')
machine = cmo
cd ('/Server/AdminServer')
set('Machine', machine)
updateDomain()

3. Set the Listen address for the Administration Server:

readDomain("DomainHome")
cd("servers/AdminServer")
cmo.setListenPort(8001)
updateDomain()
exit()

15.11.5.4 Updating Oracle Inventory

For many components, when you recover to a different host, as in the case of loss of host, you must update the Oracle Inventory on UNIX. To do so, execute the following script:

ORACLE_COMMON_HOME/oui/bin/attachHome.sh

In addition, you must update beahomelist to edit the location of a Middleware home. Edit the following file to update the Middleware home information:

(UNIX) user_home/bea/beahomelist
(Windows) C:\bea\beahomelist

15.11.6 Recovering Oracle Fusion Applications After Loss of Host

In most cases, to recover Oracle Fusion Applications, you recover the entire Middleware home, a domain, a server, an Oracle home, or an Oracle instance, depending on the extent of the failure. However, you may need to take additional steps you for particular components.

This section includes the following topics:

- Section 15.11.6.1, "Recovering Oracle Fusion Supply Chain Management After Loss of Host"

- Section 15.11.6.2, "Recovering Oracle Fusion Procurement After Loss of Host"

15.11.6.1 Recovering Oracle Fusion Supply Chain Management After Loss of Host

If you lose a host that contains Oracle Fusion Supply Chain Management, you can recover it to the same host or a different host.

To recover Oracle Fusion Supply Chain Management to the same host, recover the Managed Server to which the application is deployed, as described in Section 15.11.3.

To recover Oracle Fusion Supply Chain Management to a different host:

1. Recover the Managed Server to which the application is deployed, as described in Section 15.11.3.

2. Recover the Oracle instance for Global Order Promising, as described in Section 15.10.5.

15.11.6.2 Recovering Oracle Fusion Procurement After Loss of Host

If you lose a host that contains Oracle Fusion Procurement, you can recover it to the same host or a different host.

To recover Oracle Fusion Procurement to the same host, recover the Managed Server to which the application is deployed, as described in Section 15.11.3.

To recover Oracle Fusion Procurement to a different host:

1. Recover the Managed Server to which the application is deployed, as described in Section 15.11.3.

2. Ensure that Oracle Business Intelligence Publisher and CUPS IP address and port number reflects the different host.

15.11.7 Recovering Components Related to Oracle Fusion Applications

In most cases, to recover components related to Oracle Fusion Applications, you recover the entire Middleware home, a domain, a server, an Oracle home, or an Oracle instance, depending on the extent of the failure. You may need to take additional steps for particular components related to Oracle Fusion Applications.

This section includes the following topics:

- Section 15.11.7.1, "Recovering Oracle HTTP Server After Loss of Host"

- Section 15.11.7.2, "Recovering Oracle WebCenter Content to a Different Host"

- Section 15.11.7.3, "Recovering Oracle Enterprise Scheduler After Loss of Host"

- Section 15.11.7.4, "Recovering Oracle Enterprise Crawl and Search Framework After Loss of Host"

- Section 15.11.7.5, "Recovering Oracle Authorization Policy Manager After Loss of Host"

- Section 15.11.7.6, "Recovering Oracle E-Mail and Web Marketing After Loss of Host"

- Section 15.11.7.7, "Recovering Oracle Essbase In Clustered Environment After Loss of Host"

- Section 15.11.7.8, "Recovering Oracle BI Enterprise Edition to a Different Host"

- Section 15.11.7.9, "Recovering Oracle Business Intelligence Publisher to a Different Host"

- Section 15.11.7.10, "Recovering Oracle Real-Time Decisions to a Different Host"

- Section 15.11.7.11, "Recovering Oracle Hyperion Calculation Manager After Loss of Host"

- Section 15.11.7.12, "Recovering Oracle Hyperion Financial Reporting After Loss of Host"

- Section 15.11.7.13, "Recovering Oracle Hyperion Smart View"

15.11.7.1 Recovering Oracle HTTP Server After Loss of Host

To recover Oracle HTTP Server to the same host, recover the Oracle instance, as described in Section 15.10.5.

To recover Oracle HTTP Server to a different host:

1. Recover the Middleware home, as described in Section 15.10.2.

2. Start all relevant processes, as described in Section 4.4.1.

3. Update the registration of the Oracle instance with the Administration Server, using the opmnctl updateinstanceregistration command on the new host. For example:

opmnctl updateinstanceregistration -adminHost admin_server_host

This command updates the OPMN instance.properties file.

4. Update the registration of the component with the Administration Server, using the opmnctl updatecomponentregistration command on the new host. For example, to update the registration for Oracle HTTP Server, use the following command:

opmnctl updatecomponentregistration -Host new_host -Port nonSSLPort
-componentName ohs1 -componentType OHS

5. Edit the targets.xml file for Fusion Middleware Control, as described in Section 15.11.5.1.

6. Modify the ServerName entry in the following file to have the new host name:

(UNIX) ORACLE_INSTANCE/config/OHS/ohs_name/httpd.conf
(Windows) ORACLE_INSTANCE\config\OHS\ohs_name\httpd.conf

7. Modify the FusionVirtualHost_x.conf file, as described in Section 15.11.5.2.

8. If the Managed Server is in a cluster, modify the following files (there is more than one file, with the name ear_name.ear):

(UNIX) APPLICATIONS_CONFIG/fusionapps/applications/domain_name/deploy/ear_name.ear/APP-INF/classes/wf_client_config.xml
(Windows) APPLICATIONS_CONFIG\fusionapps\applications\domain_name\deploy\ear_name.ear\APP-INF\classes\wf_client_config.xml

Change the rootEndPointURL element so that it points to the Oracle HTTP Server or Load Balancer for the cluster on the new environment.

15.11.7.2 Recovering Oracle WebCenter Content to a Different Host

To recover Oracle WebCenter Content to a different host:

1. If the database must be restored to a different host, restore it, as described in Section 15.12.9.

2. Restore the domain, as described in Section 15.10.3.

3. If the Vault, WebLayout, or Search directories are not located in the domain directory, restore those directories, if necessary. For example, if the Vault directory is located on a shared drive in /net/home/vault, restore it from backup:

cd /net/home/vault
tar -xf vault_backup_042012.tar

4. Edit the following file:

DOMAIN_HOME/ucm_domain/ucm/cs/config/config.cfg

In the file, change the HttpServerAddress setting to specify the new host. For example:

HttpServerAddress=hostname:port_number

Note that you should restore the database and the shared file system at the same time. If you cannot do that, you can use the IDCAnalyse utility to determine if there are any inconsistencies between the database and the shared file system. If there are, you can perform a manual recovery using IDCAnalyse.

15.11.7.3 Recovering Oracle Enterprise Scheduler After Loss of Host

To recover Oracle Enterprise Scheduler, follow the procedure in Section 15.10.11.3.

15.11.7.4 Recovering Oracle Enterprise Crawl and Search Framework After Loss of Host

To recover Oracle Enterprise Crawl and Search Framework to a different host, follow the procedure in Section 15.10.11.4.

15.11.7.5 Recovering Oracle Authorization Policy Manager After Loss of Host

To recover Oracle Authorization Policy Manager, follow the procedure in Section 15.10.11.5.

15.11.7.6 Recovering Oracle E-Mail and Web Marketing After Loss of Host

To recover Oracle E-Mail and Web Marketing, follow the procedure in Section 15.10.11.6.

15.11.7.7 Recovering Oracle Essbase In Clustered Environment After Loss of Host

To recover Oracle Essbase after loss of host, you recover the entire Middleware home, a domain, a server, an Oracle home, or an Oracle instance, depending on the extent of the failure.

However, if the failed node contained Oracle Essbase and was clustered, you must configure secondary instances of Oracle Essbase Agent so that they are distributed for high availability. For more information, see "Configuring Oracle Essbase Clustering" in the Oracle Fusion Applications Installation Guide.

15.11.7.8 Recovering Oracle BI Enterprise Edition to a Different Host

You can recover Oracle BI EE to a different host.

The following topics describe how to move Oracle BI EE to a different host with the same name:

- Recovering Oracle BI EE to a Different Host in a Non-Clustered Environment

- Recovering Oracle BI EE to a Different Host in a Clustered Environment

15.11.7.8.1 Recovering Oracle BI EE to a Different Host in a Non-Clustered Environment

The steps you take to recover Oracle BI EE to a different host depend on the operating system. Note that the host must have the same name as the original host.

- On UNIX, take the following steps:

1. Restore the Middleware home from backup, as described in Section 15.10.2.

2. Restore the database containing the Oracle BI EE schemas, if necessary. See Section 15.11.4.

- On Windows, take the following steps:

1. Restore the Middleware home from backup, as described in Section 15.10.2, overwriting the Middleware home that you created with the new installation.

2. Restore the database containing the Oracle BI EE schemas, if necessary. See Section 15.11.4.

3. Install the C++ libraries from Microsoft, by executing the following file:

Oracle_BI\bifoundation\install\vc80\vcredist_x86.exe

4. Import the Registry entries that you exported into the new host, as described in Section 15.11.7.8.4.

15.11.7.8.2 Recovering Oracle BI EE to a Different Host in a Clustered Environment

In this scenario, you have an Oracle BI EE cluster on two hosts, Host A and Host B. Host A contains instance1 and Host B contains instance2. Host A must be replaced for some reason, such as a host crash, and you must recover to Host C and scale out the system so that Host C contains instance3.

Take the following steps:

1. Restore the Middleware home from backup, as described in Section 15.10.2, overwriting the Middleware home that you created with the new installation.

2. Restore the database containing the Oracle BI EE schemas, if necessary. See Section 15.11.4.

3. On Windows, install the C++ libraries from Microsoft, by executing the following file:

Oracle_BI\bifoundation\install\vc80\vcredist_x86.exe

4. On Windows, import the Registry entries that you exported into the new host, as described in Section 15.11.7.8.4.

5. If the failed node contained the Administration Server, recover it, as described in steps 1 through 5 in Section 15.11.2.2.

6. Scale out the Oracle BI EE system, as described in "Scaling Out the BI System on APPHOST2" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.
Note the following:

- When you enter the directory specifications for the Domain Home and Applications Home, enter specifications for directories that do not yet exist or that are empty.

- If the Domain Home field is empty, update the following file with the domain directory:

MW_HOME/wlserver_10.3/common/nodemanager/nodemanager.domains

Before you start Node Manager, take the following steps:

1. Stop Node Manager, if it is running.

2. Run the setNMProps.sh script, which is located in the ORACLE_COMMON_HOME/common/bin directory, to set the StartScriptEnabled property to true before starting Node Manager:

cd ORACLE_COMMON_HOME/common/bin
./setNMProps.sh

3. Restart Node Manager and enable dynamic registration using the following commands:

cd WL_HOME/server/bin
export JAVA_OPTIONS=-DDomainRegistrationEnabled=true
./startNodeManager.sh

Note:

It is important that you set -DDomainRegistrationEnabled=true whenever you start a Node Manager which must manage the Administration Server. If there is no Administration Server on this computer, and if this computer is not an Administration Server failover node, then Node Manager can be started as follows:

./startNodeManager.sh

7. Scale out the system components, as described in "Scaling Out the System Components" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence. Fusion Middleware Control prompts you to restart the instances after you have changed their configuration. Restart the instances.
Because instance1 on Host A is no longer available, you must modify its count of BI Servers, Presentation Services, and JavaHosts to be 0. Fusion Middleware Control prompts you to restart the instances after you have changed their configuration. Restart the instances.

8. Make instance2 the primary instance and instance3 the secondary instance using Fusion Middleware Control:

1. Make instance 2 the primary instance and specify the secondary instance as none. Activate and restart the instance as prompted by Fusion Middleware Control.

2. Make instance3 the secondary instance. Activate and restart the instance as prompted by Fusion Middleware Control.

See "Configuring Secondary Instances of Singleton System Components" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence for more information.

9. Set the listen address of the bi_servern Managed Server, as described in "Setting the Listen Address for the bi_server2 Managed Server" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.

10. Disable host name verification for the bi_servern Managed Server, as described in "Disabling Host Name Verification for the bi_server2 Managed Server" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.

11. Depending on your configuration, perform additional configuration, as described in "Performing Additional Configuration for Oracle Business Intelligence Availability" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.

12. If Oracle HTTP Server is installed, set the front-end HTTP host and port for the Oracle WebLogic Server cluster to ensure that Oracle BI Search URLs are set correctly, as described in "Setting the Frontend URL for the Administration Console" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.

13. Configure Node Manager for the Managed Servers as described in "Configuring Node Manager for the Managed Servers" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.

14. Start the Oracle BI EE Managed Server and all of the OPMN-managed components.

15.11.7.8.3 Additional Steps for Recovering Oracle BI EE

Depending on your environment, you may need to take additional steps after you perform the steps in Section 15.11.7.8.2:

- If the failed host contained the master BI Server, primary cluster controller, and primary Oracle BI Scheduler and you want the new instance to be the master BI Server, take the following steps as appropriate. Note that if you want to leave instance2 as the master BI server, you do not need to take these additional steps.

- If the master BI Server is lost:

1. Stop Oracle WebLogic Server and OPMN processes on all nodes.

2. Update the following configuration file to designate a new master BI Server:

DOAMIN_HOME/config/fmwconfig/biee-domain.xml

In the section <AvailabilityOptions>, edit the following:

masterBIServerOracleInstanceId="instance_name"
masterBIServerComponentId="component_id"

Also update the following settings:

<OracleInstance id="instance1" host="hostname"
instanceHome="path_to_instance_home" opmnLocalPort="9500" opmnRemotePort="number">
<SchedulerOptions dataSource="(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=hostname(PORT=number)))

3. Copy the file to the other host.

4. Restart the Administration Server and the Managed Servers.

- If the primary cluster controller or scheduler is lost, it fails over to the standby cluster controller or scheduler. You must determine whether you want to reconfigure it to be the primary cluster controller or scheduler or leave it as secondary that has been activated because the primary components have failed. For more information, see "Configuring Secondary Instances of Singleton System Components" in the Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence.

- If the failed host contained the BI Server, the secondary cluster controller, and the secondary Oracle BI Scheduler, designate the new host as the secondary cluster controller or scheduler.

- If the failed host contained the BI Server and system components such as BI Presentation Services and BI Java hosts, no additional steps are needed.

- If the failed host contained the following related components, recover them:

- Oracle Business Intelligence Publisher: See Section 15.11.7.9.

- Oracle Real-Time Decisions: See Section 15.11.7.10.

- Oracle Essbase: See Section 15.11.7.7.

- Oracle Hyperion Calculation Manager: See Section 15.11.7.11.

- Oracle Hyperion Financial Reporting: See Section 15.11.7.12.

- Oracle Hyperion Smart View: See Section 15.11.7.13.

15.11.7.8.4 Importing Oracle BI EE Registry Entries

On Windows, you must import the Oracle BI EE Registry entries to the new host. Section 15.3.4 describes how to export them from the original host.

1. Copy all the files that you exported from the original host to the new host.

2. Double-click each file you copied from the original host. Click Yes when prompted, to import the file into the Registry.

15.11.7.9 Recovering Oracle Business Intelligence Publisher to a Different Host

To recover Oracle Business Intelligence Publisher to a different host:

1. Recover the Managed Server containing the Oracle Business Intelligence Publisher component, as described in Section 15.11.3.

2. Restore the database containing the Oracle Business Intelligence Publisher schemas, if necessary. See Section 15.11.4.

3. Modify the server value for Oracle BI Presentation Services:

1. Open the BI Publisher application at http://hostname:port/xmlpserver and log in.

2. Click Administration, then Integration, then Oracle BI Presentation Services.

3. Change Server to the new host name.

4. Click Apply.

4. To transform Oracle BI Publisher to work in a Cold Failover Cluster environment, you must change the BI Scheduler 's JMS configuration:

1. In the BI Publisher application, click Administration.

2. In the System Administration section, click Scheduler Configuration.

3. Change Weblogic JNDI URL to the new host URL. For example, t3://hostname:port.

4. Click Apply.

5. If you are using a Cold Failover Cluster, configure the Managed Server to listen on the virtual IP address. See "Transforming Oracle WebLogic Managed Servers" in the Oracle Fusion Middleware High Availability Guide. Then restart the Managed Server using the Administration Console or the WLST command line.

6. In BI Publisher, data sources that refer to this BI Enterprise Edition instance should change or be created (if new using the new virtual host). To change the data sources:

1. In the BI Publisher application:

2. Click JDBC Connection under Data Sources.

3. Edit any data source for BI Enterprise Edition for this instance to reflect the values for the new host.

If backup artifacts are restored from different time, then user accounts, user reports, and user permissions revert to the restored version. Restore all artifacts from the same point in time.

15.11.7.10 Recovering Oracle Real-Time Decisions to a Different Host

To recover Oracle Real-Time Decisions to a different host:

1. Recover the Managed Server containing the Oracle Real-Time Decisions component, as described in Section 15.11.3.

Note that if backup artifacts are restored from different time, the analytic models miss a period of learning, but their intelligence is unaffected.

15.11.7.11 Recovering Oracle Hyperion Calculation Manager After Loss of Host

To recover Oracle Hyperion Calculation Manager after loss of host, follow the procedure in Section 15.10.11.11.

If the database must be restored, restore the database and import Calculation Manager rules and rule sets from the file you exported.

In Calculation Manager, select File, and then Import.

15.11.7.12 Recovering Oracle Hyperion Financial Reporting After Loss of Host

If you lose a host that contains Oracle Hyperion Financial Reporting, you can recover it to the same host or a different host. To recover Oracle Hyperion Financial Reporting, recover the Oracle home, as described in Section 15.10.4 and the Oracle instance, as described in Section 15.10.5.

If the database host has changed, update the host name using the following commands:

Epmsys_registry updateproperty financial_reporting_product/@host new_host
Epmsys_registry updateproperty financial_reporting_product/logical_web_app/@host new_host
Epmsys_registry updateproperty financial_reporting_product/logical_web_app/financial_reporting_web_app@host new_host

15.11.7.13 Recovering Oracle Hyperion Smart View

To restore Oracle Hyperion Smart View, take the steps described in Section 15.10.11.13.

15.12 A Case Study: Recovering Oracle Fusion Customer Relationship Management

This section provides a case study of recovering Oracle Fusion Customer Relationship Management and all of the other Oracle Fusion Applications offerings and Oracle Fusion Middleware components that are installed when you install Oracle Fusion Customer Relationship Management.

You can recover all or part of your Oracle Fusion Applications environment, as described in Section 15.4.

This section includes the following topics:

- Section 15.12.1, "The Recovery Case Study Scenario"

- Section 15.12.2, "Recovering the Middleware Home Containing Java EE Components"

- Section 15.12.3, "Recovering the Web Tier Middleware Home"

- Section 15.12.4, "Recovering the Oracle Fusion Customer Relationship Management Domain"

- Section 15.12.5, "Recovering Servers When the Installation Directory Is Shared Between Hosts"

- Section 15.12.6, "Recovering Servers When the Managed Server Configuration Is Local"

- Section 15.12.7, "Recovering an Oracle Instance in an Oracle Fusion Customer Relationship Management Installation"

- Section 15.12.8, "Recovering an Oracle Fusion Customer Relationship Management Cluster"

- Section 15.12.9, "Recovering Databases for Oracle Fusion Customer Relationship Management"

15.12.1 The Recovery Case Study Scenario

In this case study, the following domains were created when you installed and provisioned Oracle Fusion Customer Relationship Management:

Oracle Fusion Applications Component

Domain Name

Oracle Fusion Customer Relationship Management

CRMDomain

Oracle Fusion Financials

FinancialDomain

Oracle Fusion Human Capital Management

HCMDomain

Oracle Fusion Supply Chain Management

SCMDomain

Oracle Fusion Setup

CommonDomain

In addition, Oracle Fusion Customer Relationship Management uses the following Oracle Fusion Middleware components:

- Oracle WebCenter Portal

- Oracle Business Intelligence

- Oracle Essbase

- Oracle Enterprise Scheduler

- Oracle SOA Suite

- Oracle WebCenter Content

- Oracle Application Development Framework

Oracle Fusion Customer Relationship Management is installed in the following directory:

/scratch/oracle/APPLICATIONS_BASE

The APPLICATIONS_BASE directory contains:

- The Oracle Fusion Applications Middleware home directory, which is located at:

/scratch/oracle/APPLICATIONS_BASE/fusionapps

- One Middleware home that hosts the Java EE components, including Oracle SOA Suite and Oracle WebCenter Portal, and is located at:

/scratch/oracle/APPLICATIONS_BASE/fusionapps

- A second Middleware home that hosts system components such as Oracle HTTP Server and is located at:

/scratch/oracle/APPLICATIONS_BASE/webtier_mw_home

Note:

In this case study, the Oracle Fusion application files are installed in shared storage, which is mounted on all hosts that run the applications. A single copy of binary files is shared across multiple hosts. The Administration Server configuration is also shared. However, the Managed Server configurations are not shared.

15.12.2 Recovering the Middleware Home Containing Java EE Components

In this scenario, you recover the Oracle Fusion Applications Middleware home, which contains Oracle Fusion Applications instances, and the Java EE components, Oracle SOA Suite and Oracle WebCenter Portal, after data loss or corruption.

To recover the Middleware home:

1. Stop all relevant processes using Fusion Applications Control. That is, stop all Managed Servers that are related to Oracle SOA Suite and Oracle WebCenter Portal. For example, stop the FINSOAServer_1 (in the FinancialDomain), CRMSOAServer_1 (in the CRMDomain), SCMSOAServer_1 (in the SCMDomain), and FSSOAServer (in the HCMDomain). Stop the Administration Server, as described in Section 4.4.4.2.

2. From the original Middleware home directory, move the files to a backup directory:

mv /scratch/oracle/APPLICATIONS_BASE/fusionapps
/scratch/oracle/APPLICATIONS_BASE/fusionapps_backup

This ensures that any needed files are not overwritten.

3. Create a staging directory and restore the Applications base directory to that directory:

cd /scratch/stage/
tar -xvf crm_ApplBase_backup_030212.tar

4. From that stage directory, copy the Middleware home to the original location:

cp /scratch/stage/APPLICATIONS_BASE/fusionapps
/scratch/oracle/APPLICATIONS_BASE/fusionapps

5. Start all relevant processes, as described in Section 4.4.3.1.

15.12.3 Recovering the Web Tier Middleware Home

In this scenario, you recover the Web tier Middleware home that contains system components, such as Oracle HTTP Server, after data loss or corruption.

To recover the Middleware home:

1. Stop all relevant processes, such as all processes running in the Oracle instance, using the following command:

opmnctl stopall

2. From the original Middleware home directory, move the files to a backup directory:

mv /scratch/oracle/APPLICATIONS_BASE/webtier_mw_home
/scratch/oracle/APPLICATIONS_BASE/webtier_mw_home_backup

This ensures that any needed files are not overwritten.

3. Create a staging directory and restore the Applications base directory to that directory:

cd /scratch/stage
tar -xvf crm_ApplBase_backup_030212.tar

4. From that stage directory, copy the Middleware home to the original location:

cp /scratch/stage/APPLICATIONS_BASE/webtier_mwhome
/scratch/oracle/APPLICATIONS_BASE/webtier_mwhome

5. Start all relevant processes, using the following command:

opmnctl startall

15.12.4 Recovering the Oracle Fusion Customer Relationship Management Domain

In this scenario, you recover the domain that contains Oracle Fusion Customer Relationship Management after data loss or corruption. This procedure shows recovering the domain CRMDomain, but you can use the same procedure for other Oracle Fusion Applications domains.

To recover the domain:

1. Stop all Managed Servers in the CRMDomain, as described in Section 4.4.4.2.

2. Stop the Administration Server for the CRMDomain, as described in Section 4.4.4.2.

3. From the original domain directory, move the files to a backup directory:

mv /scratch/oracle/APPLICATIONS_CONFIG/instance/domains/CRMDomain
/scratch/oracle/APPLICATIONS_CONFIG/instance/domains/CRMDomain_backup

This ensures that any needed files are not overwritten.

4. Create a staging directory and restore the Applications base directory to that directory:

cd /scratch/stage
tar -xvf crm_ApplBase_backup_030212.tar

5. From that stage directory, copy the domain to the original location:

cp /scratch/stage/APPLICATIONS_CONFIG/instance/domains/CRMDomain
/scratch/oracle/APPLICATIONS_CONFIG/instance/domains/CRMDomain

6. Start the Administration Server, as described in Section 4.4.4.1.

7. Start all Managed Servers, as described in Section 4.4.4.1.

15.12.5 Recovering Servers When the Installation Directory Is Shared Between Hosts

When the applications directory is shared between hosts, and you need to recover an Administration Server or a Managed Server, you must recover the entire domain.

The following table shows a sample domain mapping and provides guidelines for recovering an Oracle WebLogic Server Administration Server or any Managed Server running in the domain. The list of servers in the table is not complete. Refer to the particular Oracle Fusion application offering for the complete list of servers.

Domain Name

Servers Running in Domain

What to Recover

CRMDomain

AdminServer

CRMCommonServer_1

CRMPerformanceServer_1

CRMAnalyticsServer_1

CRMSearchServer_1

CRMODIServer_1

CRMSOAServer_1

CustomerServer_1

SalesServer_1

MarketingServer_1

OrderCaptureServer_1

The entire CRMDomain. For example:

APPLICATIONS_CONFIG/instance/domains/CRMDomain

FinancialDomain

AdminServer

FinCommonServer_1

FinAnalyticsServer_1

FinSOAServer_1

LedgerServer_1

ESSServer_1

The entire FinancialDomain. For example:

APPLICATIONS_CONFIG/instance/domains/FinancialDomain

SCMDomain

AdminServer

ProductManagementServer_1

SCMSOAServer_1

The entire SCMDomain. For example:

APPLICATIONS_CONFIG/instance/domains/SCMDomain

HCMDomain

AdminServer

CoreSetupServer_1

FINSOAServer_1

TalentServer_1

ESSServer_1

HCMAnalyticsServer_1

The entire HCMDomain. For example:

APPLICATIONS_CONFIG/instance/domains/HCMDomain

SetupDomain

AdminServer

HomePageServer_1

HelpPortalServer_1

FunctionalSetupServer_1

WCServices_1

SpacesServer_1

The entire SetupDomain. For example:

APPLICATIONS_CONFIG/instance/domains/SEtupDomain

15.12.6 Recovering Servers When the Managed Server Configuration Is Local

If domain directory of the Managed Server is different than the Administration Server domain directory, and you need to recover a Managed Server, you use pack and unpack to recover the Managed Server.

For example, to pack and unpack the Managed Server FinCommonServer_1:

1. If the Administration Server is not reachable, recover the Administration Server, as described in Section 15.10.6.

2. If the Managed Server fails to start or if the file system is lost:

1. Recover the Middleware home from the backup file, if required. For example:

cd MW_HOME
tar -xf mw_home_backup_030212.tar

2. Create a domain template jar file for the FinancialDomain Administration Server, using the pack utility. For example:

pack.sh -domain=APPLICATIONS_CONFIG/instance/domains/FinancialDomain
-template=/scratch/temp.jar -template_name=domain1
-template_author=myname -log=/scratch/logs/my.log -managed=true

Specifying the -managed=true option packs up only the Managed Servers. If you want to pack the entire domain, omit this option.

3. Unpack the domain template JAR file, using the unpack utility. For example:

unpack.sh -template=/scratch/temp.jar
-domain=APPLICATIONS_CONFIG/instance/domains/FinancialDomain
-log=/scratch/logs/my.lognew.log -log_priority=info

4. Ensure that the application artifacts are accessible from the Managed Server host. That is, if the application artifacts are not on the same server as the Managed Server, they must be in a location accessible by the Managed Server.

Note:

- For stage mode applications, the Administration Server copies the application bits to the staged directories on the Managed Server hosts.

- For nostage and external-stage mode applications, ensure that application files are available in the stage directories of the Managed Server.

5. Start the Managed Server, as described in Section 4.4.4.1.
The Managed Server connects to the Administration Server and updates its configuration changes.

15.12.7 Recovering an Oracle Instance in an Oracle Fusion Customer Relationship Management Installation

To recover the Oracle instance ohs in an Oracle Fusion Customer Relationship Management installation:

1. Stop all relevant processes using opmnctl or kill all processes that are related to that Oracle instance. For example:

opmnctl stopall

2. Copy the original Oracle instance to a backup location in case you need to retrieve some configuration data:

cp /scratch/CRM/APPLICATIONS_CONFIG/webtier_mw_home/webtier/ohs
/scratch/CRM/APPLICATIONS_CONFIG/webtier_mw_home/webtier/ohs_backup

3. Restore the Oracle instance home from the backup file to a stage directory by restoring the Applications configuration directory:

mkdir stage
cd stage
tar -xvf crm_ApplConfig_backup_030212.tar

4. Copy the restored Oracle instance from step 3 to the original location:

cp /scratch/stage/APPLICATIONS_CONFIG/webtier_mw_home/webtier/ohs/
/scratch/CRM/APPLICATIONS_CONFIG/webtier_mw_home/webtier/ohs

5. Start all relevant processes. That is, start all processes that are related to that Oracle instance:

opmnctl startall

Note:

If you are recovering the Oracle instance containing Oracle HTTP Server to a new host after loss of host, see Section 15.11.7.1.

15.12.8 Recovering an Oracle Fusion Customer Relationship Management Cluster

In this scenario, the cluster CRMPerformanceCluster has been erroneously deleted or the cluster-level configuration, such as the JMS configuration or container-level data sources, was mistakenly changed and committed. The server CRMPerformanceServer_1 cannot be started or does not operate properly or the services running inside the server are not starting. You cannot ascertain what was changed.

Caution:

Performing a domain-level recovery can impact other aspects of a running system and all of the configuration changes performed after the backup was taken will be lost.

If the configuration changes are few, then the easiest way is to redo the configuration changes. If that is not feasible, restore the domain to which the cluster belongs. (See the table in Section 15.12.5 for Managed Servers to domain mappings.) Take the following steps:

1. Stop the cluster:

stop('CRMPerformanceCluster', 'Cluster')

2. Stop the Administration Server, as described in Section 4.4.4.2.

3. Copy the original CRMDomain to a backup location in case you need to retrieve some configuration data:

cp /scratch/CRM/APPLICATIONS_CONFIG/instance/domains/CRMDomain
/scratch/CRM/APPLICATIONS_CONFIG/instance/domains/CRMDomain_backup

4. Restore the CRMDomain home from the backup file to a stage directory by restoring the Applications configuration directory:

mkdir stage
cd stage
tar -xvf crm_ApplConfig_backup_030212.tar

5. Copy the restored CRMDomain from step 4 to the original location:

cp /scratch/stage/APPLICATIONS_CONFIG/instance/domains/CRMDomain
/scratch/CRM/APPLICATIONS_CONFIG/instance/domains/CRMDomain

6. Start the Administration Server, as described in Section 4.4.4.1.

7. Start the cluster. You can use the Oracle WebLogic Server Administration Console or WLST. For example, to use the WLST start command:

start('CRMPerformanceCluster', 'Cluster')

Note:

You can use this procedure to recover a cluster if the membership is mistakenly deleted.

15.12.9 Recovering Databases for Oracle Fusion Customer Relationship Management

You can recover the databases using RMAN. You can recover the databases at whatever level is appropriate by performing a restore and recovery of either the full databases, a tablespace, or a data file.

Oracle Fusion Customer Relationship Management uses the following databases: Oracle Fusion Applications database, LDAP database, Oracle WebCenter Content, and Oracle Identity Manager database. You must maintain consistency among the databases. If any of these databases are recovered to a different point in time, you may need to reconcile the databases, as described in Section 15.10.9.

For more information, see the following topics:

- For data loss, corruption, or media failure loss, see Section 15.10.8.

- For loss of host, see Section 15.11.4.

16 Configuring High Availability and Scaling Out Oracle Fusion Applications

This chapter describes how to configure Oracle Fusion Applications for high availability and how to scale out an Oracle Fusion Applications environment.

This chapter contains the following topics:

- Section 16.1, "Introduction to Oracle Fusion Applications High Availability Architecture"

- Section 16.2, "Oracle WebLogic Cluster Configuration for Oracle Fusion Applications"

- Section 16.3, "Oracle Fusion Applications High Availability"

- Section 16.4, "Oracle RAC Database Configuration for Oracle Fusion Applications Repositories"

- Section 16.5, "Scaling Out Oracle Fusion Applications"

The following appendixes describe additional high availability topics:

- Appendix A, "High Availability for Oracle Fusion Middleware Extensions for Applications"

- Appendix B, "High Availability for Oracle Enterprise Scheduler"

Related Links

The following document provides additional information about configuring high availability for Oracle Fusion Middleware products such as Oracle WebLogic Server, Oracle SOA Suite, Oracle Identity Management, and Oracle Business Intelligence:

- Oracle Fusion Middleware High Availability Guide

16.1 Introduction to Oracle Fusion Applications High Availability Architecture

Providing high availability for Oracle Fusion Applications involves configuring an Oracle WebLogic cluster for high availability of the middle tiers and configuring Oracle Real Application Clusters (RAC) for high availability of the Oracle Database. It also involves scaling out Oracle Fusion Applications and Oracle RAC database instances.

Oracle Fusion Applications is built on standards-based Oracle Fusion Middleware. Therefore, it benefits from the high availability solutions for Oracle Fusion Middleware.

Characteristics of an Oracle Fusion Applications high availability configuration are:

- Oracle Fusion Applications are Oracle Application Development Framework (Oracle ADF) applications running on Oracle WebLogic Server Clusters.

- Oracle Fusion Applications connect to Oracle RAC databases using multi data sources.

- Oracle Fusion Applications use Enterprise JavaBeans (EJBs) for inter-cluster communication within the same domain.

- Oracle Fusion Applications use Web services for inter-domain communication.

- Oracle Fusion Applications use the Java Message Service (JMS) operational interface (shared interfaces) to Oracle Streams Advanced Queuing (AQ), known as AQ JMS, for inter-domain communication.

This chapter assumes that you have a basic understanding of high availability concepts such as active-active deployments, active-passive deployments, and disaster recovery deployments.

Related Links

The following document provides additional information about high availability concepts such as active-active deployments, active-passive deployments, and disaster recovery deployments:

- The "Oracle Fusion Middleware High Availability Framework" chapter in the Oracle Fusion Middleware High Availability Guide.

The following documents provide additional information about high availability for Oracle Fusion Middleware and Oracle Database:

- Oracle Database High Availability Overview

- Oracle Database High Availability Best Practices

16.2 Oracle WebLogic Cluster Configuration for Oracle Fusion Applications

Oracle Fusion Applications runs on Oracle WebLogic Server. During an Oracle Fusion Applications installation, each individual product family installs into its own WebLogic Server domain. At the time of provisioning, a WebLogic cluster (with one Oracle WebLogic Server) is created for each Java EE application that is part of the product family. If you want to scale out any of the Java EE applications, new Managed Servers can be added to the application's WebLogic cluster.

Related Links

For more information about Oracle WebLogic Server clustering, see the "High Availability for WebLogic Server" chapter in the Oracle Fusion Middleware High Availability Guide.

16.3 Oracle Fusion Applications High Availability

This section provides a description of the single instance architecture of Oracle Fusion Applications, and then provides information that helps you deploy Oracle Fusion Applications in a high availability configuration.

If you have not already done so, read Chapter 1 for an introduction to:

- Oracle Fusion Applications

- Oracle Fusion Applications product families and components

- Key Oracle Fusion Applications concepts

16.3.1 Oracle Fusion Applications Single Instance Architecture

Figure 1-1 shows an Oracle Fusion Applications single instance architecture. These are stateful applications that maintain session state.

Oracle Fusion applications are built using the following technologies:

- Oracle Application Development Framework (Oracle ADF), Oracle Middleware Extensions for Applications (Applications Core), and Oracle WebCenter framework, which run as JavaEE applications on WebLogic Server

- Clustered EJBs. Inter-cluster communication within one domain is done using EJBs. Inter-cluster communication across different domains is done using web services (SOAP).

- Event deliveryqueues are used for event propagation. EDN uses Advanced Queueing (AQ) database queues.

This section contains the following topics that describe high availability details:

- Section 16.3.1.1, "Oracle Fusion Applications External Dependencies"

- Section 16.3.1.2, "Oracle Fusion Applications Run-Time Processes"

- Section 16.3.1.3, "Oracle Fusion Applications Request Flow"

- Section 16.3.1.4, "Oracle Fusion Applications Configuration Artifacts"

- Section 16.3.1.5, "Oracle Fusion Applications Deployment Artifacts"

- Section 16.3.1.6, "Oracle Fusion Applications Log File Location"

16.3.1.1 Oracle Fusion Applications External Dependencies

The following lists shows some of the external entities that Oracle Fusion Applications depends on that are relevant from a high availability perspective:

- Oracle Fusion Applications repository database

- Oracle Metadata Repository (MDS Repository) repository database

- Oracle Enterprise Scheduler repository database and queues

- EDN data source (AQ queues)

- Identity Management infrastructure (for authentication/authorization)

- LDAP store for users, roles, and policies

- Oracle Business Intelligence Foundation, which includes Essbase

- Web Services invocation (mostly asynchronous)

- Java Message Service (JMS), for Asynchronous Web Services invocation

- Oracle Data Integrator (for replication framework)

- Oracle Universal Content Management system

Note:

When you configure Oracle Identity Manager for Fusion Applications in a high availability environment, Oracle recommends that you use Multimaster Replication.

16.3.1.2 Oracle Fusion Applications Run-Time Processes

All Oracle Fusion Applications components run as JavaEE applications in WebLogic Server and do not start a process of their own. Standard WebLogic tools such as the Administration Console, Oracle WebLogic Scripting Tool (WLST), and Oracle Enterprise Manager Fusion Middleware Control start, stop, and manage the applications.

Oracle Fusion Applications also has C components such as Oracle Global Order Promising (GOP) and the bounce handling daemon (BHD). Oracle Process Manager and Notification Server (OPMN) manage these.

16.3.1.3 Oracle Fusion Applications Request Flow

The typical client HTTP request goes from the web browser or Web Services client to Oracle HTTP Server to JDBC/RMI/WS (HTTP). Table 16-1 shows the Oracle Fusion Applications clients, the protocols they use to connect, and their high availability configuration.

Table 16-1 Oracle Fusion Applications Client Connection Protocols for High Availability

Client

Connection Protocol

High Availability Configuration

Web browser

HTTP

Load balancer

Oracle Enterprise Scheduler

HTTP (WS SOAPFoot 1  over HTTP)

Load balancer

Web Services invocation

HTTP (WS SOAP over HTTP)

Load balancer

Inter-cluster communication

EJB (RMIFoot 2  over T3)

Clustered provider URL

Oracle Data Integrator

JDBCFoot 3

Oracle RAC/multi data source

Footnote 1 Web Services Simple Object Access Protocol

Footnote 2 Remote Method Invocation

Footnote 3 Java Database Connectivity

16.3.1.4 Oracle Fusion Applications Configuration Artifacts

All configuration for Oracle Fusion Applications is stored in the Oracle Fusion Applications repository database or MDS repository.

Configuration for Oracle WebLogic is stored in the domain configuration.

16.3.1.5 Oracle Fusion Applications Deployment Artifacts

The Oracle Fusion applications are deployed using the nostaged deployment model. This allows you to install a single copy of the Oracle Fusion Applications binaries on a NAS or SAN shared storage and then run Fusion Applications from multiple computers using that single copy on the shared storage. Typically, application extensions get deployed on a different Managed Server than the application itself.

16.3.1.6 Oracle Fusion Applications Log File Location

For detailed information about Oracle Fusion Applications log file locations, see Section 13.3.6.

16.3.2 Oracle Fusion Applications High Availability Architecture and Failover Considerations

Figure 16-1 shows the high availability architecture of an Oracle Fusion Applications cluster deployment.

Figure 16-1 Oracle Fusion Applications High Availability Cluster Deployment

Some of the key characteristics of this architecture are:

- It is an active-active clustered architecture.

- It stores product binaries on shared storage.

- Each computer in the cluster has its own copy of the domain configuration on local storage.

- The application tier includes hosts SALESHOST1 and SALESHOST2, which comprise a WebLogic cluster with two Managed Servers running the Sales application.

- The WebLogic cluster is front-ended in the web tier by hosts WEBHOST1 and WEBHOST2 running Oracle HTTP Server. Oracle HTTP Server provides sticky routing by default.

- It has a hardware load balancer in front of the two Oracle HTTP Servers configured with sticky routing.

- The Oracle RAC repository in the data tier has multi data source configuration.

- ADF session state replication is enabled by default. The following high availability session state replication settings are enabled out of the box:

- In weblogic.xml, the replicate_if_clustered option is specified:

<session-descriptor>
<persistent-store-type>replicated_if_clustered</persistent-store-type>
</session-descriptor>

- In adf-config.xml, the adf-scope-ha parameter is set to true:

<adf-controller-config xmlns="http://xmlns.oracle.com/adf/controller/config">
<adf-scope-ha-support>true</adf-scope-ha-support>
</adf-controller-config>

- In adf-config.xml, the adf-scope-ha-support parameter is set to true:

<adfc:adf-controller-config>
<adfc:adf-scope-ha-support>true</adfc:adf-scope-ha-support>
</adfc:adf-controller-config>

- The jbo.dofailover parameter is set to true, either in the startup environment as -D or in the ADF Business Component configuration file (bc4j.xcfg):

<AppModuleConfig ...
<AM-Pooling jbo.dofailover="true"/>
</AppModuleConfig>

- In the setDomainEnv.sh file, change JAVA_PROPERTIES to the following value and then export JAVA_PROPERTIES:

JAVA_PROPERTIES="-Dplatform.home=${WL_HOME} -Dwls.home=${WLS_HOME}
-Dweblogic.home=${WLS_HOME} -Djbo.ampool.doampooling=true"

- EJBs used for inter-cluster communication within the same domain deploy uniformly to the WebLogic cluster and leverage WebLogic Server clustering capabilities.

- Web services inter-domain communication is routed through the load balancer.

- It uses the external dependency high availability configuration that Table 16-1 describes.

This section contains the following topics about Oracle Fusion Applications changes and failover considerations:

- Section 16.3.2.1, "Starting and Stopping the Oracle Fusion Applications Cluster"

- Section 16.3.2.2, "Oracle Fusion Applications Cluster-Wide Configuration Changes"

- Section 16.3.2.3, "Oracle Fusion Applications Failures and Expected Behaviors"

16.3.2.1 Starting and Stopping the Oracle Fusion Applications Cluster

See Section 2.5 for descriptions of the various scenarios for starting and stopping the Oracle Fusion Applications environment.

16.3.2.2 Oracle Fusion Applications Cluster-Wide Configuration Changes

All Oracle Fusion Applications configuration changes can be done at the cluster level. You do not need to make configuration changes to individual instances in a cluster.

16.3.2.3 Oracle Fusion Applications Failures and Expected Behaviors

This section describes the different types of failures that can occur in an Oracle Fusion Applications high availability deployment, and the expected behaviors when these failures occur. This section contains the following topics:

- Section 16.3.2.3.1, "Process Failure"

- Section 16.3.2.3.2, "Machine Failure"

- Section 16.3.2.3.3, "External Dependency Failures (Oracle RAC Instance, Web Services Provider)"

- Section 16.3.2.3.4, "Troubleshooting Oracle Fusion Applications"

16.3.2.3.1 Process Failure

Node Manager detects Managed Server failures and restarts the Managed Server automatically. If repeated restart attempts fail, then in a simple active-active deployment, surviving cluster members continue to service the request. The ORACLE_INSTANCE/config/OHS/ohsName/mod_wl_ohs.conf file for Oracle HTTP Server redirects user requests to a server which has the replica of the session state. The Node Manager RestartInterval parameter specifies the amount of time Node Manager attempts to start a failed server. The RestartMax parameter specifies the number of times Node Manager attempts to start a failed server.

The server promotes the state to primary, creates a replica elsewhere in the cluster, and services the user request.

WebLogic Server clustering provides EJB failover for inter-cluster communication within the domain.

Web services inter-domain communication is routed through the load balancer, which also provides failover.

If a cluster member fails, messages continue to be available to surviving cluster members because AQ JMS is used for inter-domain communication.

When system components fail, OPMN attempts to restart the process in place.

16.3.2.3.2 Machine Failure

When a computer fails, the expected behavior is the same as for process failure that Section 16.3.2.3.1 describes except that Node Manager and OPMN do not attempt restarts.

16.3.2.3.3 External Dependency Failures (Oracle RAC Instance, Web Services Provider)

This section describes external dependency failures.

- Oracle RAC Instance Failure. When an Oracle RAC instance fails, multi data sources and built-in application retry logic provide failover. Under certain circumstances, an Oracle RAC database outage generates the following message on your Web browser:

Encountered database recoverable exception. Please retry your request.

If this message appears, retry the ongoing session after logging in again (if required).

- Web Services Provider Failure. If the failure occurs before the Web Services stack is invoked, the application receives an error and can retry. If failure occurs after the acknowledgement is received, then the Asynchronous Web Services infrastructure guarantees a successful response.

16.3.2.3.4 Troubleshooting Oracle Fusion Applications

If you experience issues with your Oracle Fusion Applications high availability deployment, check the WebLogic Server log. See Section 16.3.1.6 for details.

16.4 Oracle RAC Database Configuration for Oracle Fusion Applications Repositories

Oracle Real Application Clusters (Oracle RAC) enables you to cluster servers to provide resilient and scalable access to a database. A cluster comprises multiple interconnected computers or servers that appear as if they are one server to end users and applications. Oracle RAC simultaneously provides a highly available and scalable database for Oracle Fusion Applications.

This section provides an overview of Oracle RAC and information about setting up a highly available deployment for Oracle Fusion Applications configured with an Oracle RAC database as the persistent store for data.

Note:

This chapter discusses configuring Oracle RAC databases only. Other persistent repositories that connect with Oracle Fusion Applications, such as Oracle Hyperion, are configured implicitly and transparently.

For complete information

This section contains the following topics:

- Section 16.4.1, "Oracle Real Application Clusters"

- Section 16.4.2, "Providing High Availability for Oracle Fusion Applications Repositories"

- Section 16.4.3, "Best Practices for Deploying JDBC Multi Data Sources on Servers and Clusters"

Related Topics

The following document provides additional information related to subjects discussed in this section:

- Oracle Real Application Clusters Administration and Deployment Guide

16.4.1 Oracle Real Application Clusters

Oracle RAC and Oracle ClusterwareFoot 1  allow the Oracle Database to run any packaged or custom application across a set of clustered servers. This capability provides the highest levels of availability and the most flexible scalability. If a clustered server fails, Oracle Database continues running on the surviving servers. When more processing power is needed, you can add another server without interrupting access to data.

Oracle RAC enables multiple database instances that are linked by an interconnect to share access to an Oracle database. In an Oracle RAC environment, the Oracle Database runs on two or more systems (nodes) in a cluster while concurrently accessing a single shared database. The result is a single database system that spans multiple hardware systems and enables Oracle RAC to provide high availability and redundancy during failures in the cluster. Oracle RAC accommodates all system types, from read-only data warehouse (DSS) systems to update-intensive Online Transaction Processing (OLTP) systems.

The clusters that are typical of Oracle RAC environments can provide continuous service for both planned and unplanned outages. Oracle RAC builds higher levels of availability on top of the standard Oracle features. All single-instance high availability features, such as the Oracle Flashback technologies and online reorganization, also apply to Oracle RAC. Applications scale in an Oracle RAC environment to meet increasing data processing demands without changing the application code. In addition, allowing maintenance operations to occur on a subset of components in the cluster while the application continues to run on the rest of the cluster can reduce planned downtime.

Related Topics

The following document provides additional information related to subjects discussed in this section:

- For information about online application maintenance and upgrades, see the "Online Application Maintenance and Upgrades" section of Oracle Database High Availability Overview.

16.4.2 Providing High Availability for Oracle Fusion Applications Repositories

Providing high availability requires detailed planning to ensure there are no single points of failure throughout the infrastructure. Even though Oracle RAC makes your database highly available, if a critical application becomes unavailable, then your business can be negatively affected.

For example, because Oracle Fusion Applications uses the Lightweight Directory Access Protocol (LDAP) for authentication, the best practice is to make the LDAP server highly available. If the database is up but the LDAP server is down, users cannot connect to the applications and the entire system appears to be down.

The following sections describe deploying Oracle RAC for high availability in an Oracle Fusion Applications environment:

- Section 16.4.2.1, "Preparing the System to Use Oracle RAC"

- Section 16.4.2.2, "Providing High Availability Through Multi Data Sources"

- Section 16.4.2.3, "Failover Processing and Recovery for Oracle RAC Node or Instance Failures"

- Section 16.4.2.4, "Load Balancing Across Oracle RAC Nodes"

- Section 16.4.2.5, "Retry Logic to Protect Read-Only Operations"

16.4.2.1 Preparing the System to Use Oracle RAC

Use Oracle Fusion Applications provisioning to orchestrate the integration process, including the specification of your Oracle RAC database.

For more information about the provisioning and installation process and installing Oracle Database, see Section 1.2.1.2.

16.4.2.2 Providing High Availability Through Multi Data Sources

Oracle Fusion Applications support only multi data source configurations for Oracle RAC. Multi data sources encapsulate individual data sources that pool connections to specific instances of Oracle RAC.

A data source is a Java object that application components use to obtain connections to a relational database. Specific connection information, such as the URL or user name and password, are set on a data source object as properties and do not need to be explicitly defined in an application's code. This abstraction allows applications to be built in a portable manner, because the application is not tied to a specific back-end database. The database can change without affecting the application code.

A multi data source is like a pool of data sources that provides failover processing and recovery. It also provides load balancing between nodes of a highly available database system, such as an Oracle RAC database. When an Oracle RAC instance fails, a multi data source determines which data source to use to satisfy application requests. If you are using an Oracle RAC database, you must configure multi data sources.

The data source member list for a multi data source supports dynamic updates. This allows Oracle RAC environments to add and remove database nodes and corresponding data sources without redeployment, and it provides the ability to:

- Grow (scale) and shrink Oracle RAC clusters in response to throughput

- Shut down Oracle RAC nodes temporarily to perform planned maintenance

See Section 16.4.3 for best practices when configuring multi data sources for Oracle RAC and Oracle Fusion Applications.

16.4.2.3 Failover Processing and Recovery for Oracle RAC Node or Instance Failures

WebLogic Server periodically checks the status of data sources in a multi data source. If an Oracle RAC node or instance fails, application connection requests are managed as follows:

- Existing connections
There is no failover of existing connections. In-flight transactions are typically rolled back when the database is the transaction manager. When the WebLogic Server is the Transaction Manager, in-flight transactions are failed over; they are driven to completion or rolled back based on the transaction state at the time of failure.

- New connection requests
New session requests are redirected to a working Oracle RAC instance in the cluster, either by Oracle WebLogic Server or by the Oracle Thin driver.

16.4.2.3.1 Multi Data Source Fail-Over Limitations and Requirements

WebLogic Server provides the Failover algorithm for multi data sources so that if a data source fails (for example, if the database management system crashes), your system can continue to operate. However, you must consider the following limitations and requirements when configuring your system.

Test Connections on Reserve to Enable Fail-Over

Data sources rely on the Test Reserved Connections (TestConnectionsOnReserve) feature on the data source to know when database connectivity is lost. Testing reserved connections must be enabled for the data sources within the multi data source. WebLogic Server will test each connection before giving it to an application. With the Failover algorithm, the multi data source uses the results from connection test to determine when to fail over to the next data source in the multi data source. After a test failure, the data source attempts to recreate the connection. If that attempt fails, the multi data source fails over to the next data source.

No Fail-Over for In-Use Connections

It is possible for a connection to fail after being reserved, in which case your application must handle the failure. WebLogic Server cannot provide fail-over for connections that fail while being used by an application. Any failure while using a connection requires that the application code close the failed connection, and the transaction must be restarted from the beginning with a new connection.

16.4.2.4 Load Balancing Across Oracle RAC Nodes

Load balancing involves distributing requests among two or more processes. Oracle WebLogic Server provides a load balancing algorithm for multi data sources. If an application requires load balancing across Oracle RAC nodes, then WebLogic Server supports this capability with JDBC multi-data sources that have been configured for load balancing.

WebLogic accesses the data sources that form a multi data source using a round-robin scheme. When switching connections, WebLogic Server selects a connection from the next data source in the order listed.

See Section 16.4.3 for recommendations when configuring load balancing with WebLogic Server.

16.4.2.5 Retry Logic to Protect Read-Only Operations

Under certain circumstances, an Oracle RAC database outage generates the following message:

Encountered database recoverable exception. Please retry your request.

If this message appears, retry the ongoing session after logging in again (if required).

See Section 16.4.3 to configure retry properties with WebLogic Server.

16.4.3 Best Practices for Deploying JDBC Multi Data Sources on Servers and Clusters

When you create an Oracle Fusion Applications environment using an Oracle RAC database, the provisioning tool configures automatically a multi data source to use each Oracle RAC database instance.

The default configuration uses these best practices that provide optimal availability:

- Deploys a multi data source to a cluster or server by selecting the server or cluster as a deployment target in the WebLogic Server Administration Console.
When a multi data source is deployed on a server, WebLogic Server creates an instance of the multi data source on the server. When you deploy a multi data source to a cluster, WebLogic Server creates an instance of the multi data source on each server in the cluster.

- Deploys all data sources that are used by a multi data source to satisfy connection requests on the same servers and clusters as the multi data source.
Multi data sources do not route connection requests to other servers in a cluster or in a domain.

- Sets the load-balancing properties as shown in Table 16-2.

Table 16-2 Recommended Property Settings for the Load-Balancing

Property Name

Recommended Value

test-frequency-seconds

120

algorithm-type

Load-Balancing

- If the data sources require support for non-XA drivers, then the properties for the individual data sources are set as shown in Table 16-3.

Table 16-3 Recommended Data Source Property Settings for Non-XA Drivers

Property Name

Recommended Value

Driver

oracle.jdbc.OracleDriver

Property command

<property>

<name>oracle.net.CONNECT_TIMEOUT</name>

<value>10000</value>

</property>

connection-creation-retry-frequency-seconds

60

test-frequency-seconds

120

test-connections-on-reserve

true

test-table-name

SQL SELECT 1 FROM DUAL

seconds-to-trust-an-idle-pool-connection

0

global-transactions-protocol

None

For more information about configuring JDBC multi data sources, Section 16.5.3.2, "Configuring the Multi Data Source to Include New Oracle RAC Nodes.".

16.5 Scaling Out Oracle Fusion Applications

Scale-out enables organizations to improve application performance, scalability, and availability on an incremental, as-needed basis by adding multiple replicated servers.

Oracle Fusion Applications is always deployed in a cluster. Even in a single instance deployment, the Oracle Fusion Applications instance is part of a cluster with one member.

You can use a scale out operation to move from a non-high availability deployment to a high availability deployment. You can scale up or scale out the Oracle Fusion Applications topology. When you scale up the topology, you add a new Managed Server to computers that are already running one or more Managed Servers. When you scale out the topology, you add a new Managed Server to new computers.

Before you run scale up or scale out steps, check that you meet these requirements:

- There must be at least one existing computer running at least one Managed Server configured with Oracle Fusion Applications within the topology. The computer contains an APPLICATIONS_BASE home directory (/oracle in Figure 1-6) and an Oracle Fusion Applications Middleware home directory (/oracle/fusionapps in Figure 1-6) in shared storage.

- The computer on which the new Managed Server is deployed can access the existing home directories for Oracle Fusion Applications. Use the existing installations in shared storage for creating a new Managed Server.
For scale up, you do not need to install Oracle Fusion Applications binaries in a new location, and you do not need to run pack and unpack to bootstrap the domain configuration.

For scale out, you must run pack and unpack to bootstrap the domain configuration in the new computer.

Note:

The steps in this section assume that Oracle Fusion Applications clusters such as the Sales cluster do not use WebLogic JMS or XA.

The scale up steps for Oracle Fusion Middleware components such as Oracle SOA Suite and Oracle WebCenter are in the scale up section of the component's chapter in the Oracle Fusion Middleware High Availability Guide. Scale out steps for Oracle Fusion Middleware components such as Oracle SOA and Oracle WebCenter are in the scale out section of the component's chapter in the Oracle Fusion Middleware High Availability Guide. To make Oracle HTTP Server highly available, see the Oracle HTTP Server chapter in the Oracle Fusion Middleware High Availability Guide.

This section includes the following topics:

- Section 16.5.1, "Scaling Up the Topology (Adding Managed Servers to Existing Machines)"

- Section 16.5.2, "Scaling Out the Topology (Adding Managed Servers to New Machines)"

- Section 16.5.3, "Scaling Out Oracle RAC Databases"

16.5.1 Scaling Up the Topology (Adding Managed Servers to Existing Machines)

In this case, you have a computer that runs a Managed Server configured with Oracle Fusion Applications components and you want to add another Managed Server to that computer. Use the steps in this section to add a second Managed Server to a computer and to add subsequent Managed Servers on that computer.

Follow these steps to scale up the topology. This example uses the Oracle Fusion Customer Relationship Management application; you can also use these steps to scale up other Oracle Fusion Applications clusters:

1. Using the Administration Console, clone the source Managed Server (for example, SalesServer1) into a new Managed Server. The source Managed Server to clone should be one that already exists on the computer where you want to run the new Managed Server.
To clone a Managed Server:

1. Select Environment -> Servers from the Oracle WebLogic Server Administration Console.

2. Select the Managed Server that you want to clone (for example, SalesServer1).

3. Select Clone.

Name the new Managed Server server_nameN (for example, SalesServer2), where N is a number to identify the new Managed Server.

2. For the listen address, assign the host name to use for this new Managed Server.
Ensure that the port number (9001, in this example, so as not to conflict with the current port 8001 that the existing Managed Server, SalesServer1, uses) for the new Managed Server is not used on this computer.

3. Update the cluster address to include the new server:

1. Select Environment -> Cluster from the Administration Console.

2. Click on the Sales_Cluster server.

3. In the Change Center, click Lock & Edit.

4. Add the new server's address and port to the Cluster Address field. For example:

SALESHOST1:8001,SALESHOST1:9001

4. Disable host name verification for the new Managed Server. Before starting and verifying the SalesServern Managed Server, you must disable host name verification. You can re-enable it after you configure server certificates for the communication between the Oracle WebLogic Administration Server and the Node Manager in SALESHOSTn. If the source server from which the new one has been cloned had already disabled hostname verification, these steps are not required; the hostname verification setting propagates to the cloned server.
To disable host name verification:

1. Start the Oracle WebLogic Administration Console.

2. Expand the Environment node in the Domain Structure window.

3. Click Servers.

4. Select SalesServern in the Names column of the table in the Summary of Servers page.

5. Click the SSL tab in the Settings page for the server.

6. Click Advanced.

7. Set Hostname Verification to None.

8. Click Save.

5. Change JDBC LLR Table Name:

1. In the Oracle EM, expand the Environment node in the Domain Structure window

2. Click Servers.

3. Select the scaled out server.

4. In the General tab, click Advanced.

5. Change the JDBC LLR Table Name to the next higher number so that it doesn't conflict with the number of the original server.

6. Click Save.

6. Ensure that the Node Manager is running on the computer. To start the Node Manager, use the installation in shared storage from the existing computer and start Node Manager by passing the host name of the computer as a parameter as follows:

SALESHOST1> WL_HOME/server/bin/startNodeManager computer_ip

7. Start and test the new Managed Server from the Oracle WebLogic Server Administration Console:

1. Ensure that the newly created Managed Server (SalesServer2 in this example) is running.

2. Access the application on the newly created Managed Server (http://SALESHOST1:9001/sales/faces/index). The application should be functional.

8. Configure Oracle HTTP Server to route to the Administration Server that contains the new Managed Server; set the WebLogicCluster parameter to the list of computers in the cluster. Follow these steps for all Oracle HTTP Server hosts in your deployment:

1. cd to the following directory in the Web Tier configuration home:

(UNIX) APPLICATIONS_BASE/instance/SetupDomain_webtier/config/OHS/ohs1/
moduleconf

(Windows) APPLICATIONS_BASE\instance\CommonDomain_webtier\config\OHS\ohs1\
moduleconf

2. Create a backup of the FusionVirtualHost_crm.conf file and then make these edits to the file (the example is for the Sales server):

<Location /sales>
SetHandler weblogic-handler
WebLogicCluster SALESHOST1:8001,SALESHOST1:9001
</Location>

Where portn is a different port number than the port used for the first Managed Server.

3. Restart the Oracle HTTP Server by following these steps:

(UNIX) cd APPLICATIONS_BASE/instance/SetupDomain_webtier/bin
opmnctl stopall
opmnctl startall

(Windows) cd APPLICATIONS_BASE\instance\SetupDomain_webtier\bin
opmnctl stopall
opmnctl startall

4. Check that both the SALESHOST1:8001/sales/faces/index and SALESHOST1:9001/sales/faces/index are accessible.

5. Check the Sales servers from Oracle HTTP Server:

WEBHOST1:7777/sales/faces/index

This example assumes 7777 is being used for the Oracle HTTP Server port.

6. Login to the WebLogic Server Administration Console and navigate to CRMDomain > Environments > Servers.

16.5.1.1 Testing the Routing from Oracle HTTP Server to the New Managed Server

To test the routing from Oracle HTTP Server to the new Managed Server.

1. If desired, shut down the existing Managed Server (in this case, SalesServer1).

2. Access the application using WEBHOST1:7777/sales/faces/index through the web server, which should access the application on the new Managed Server (in this case, SalesServer2).
This step should show that Oracle HTTP Server routed the request to the new Managed Server (SalesServer2) while SalesServer1 was down, and that SalesServern serviced the request.

3. If you have not already done so, restart the Managed Server that you shut down.

16.5.2 Scaling Out the Topology (Adding Managed Servers to New Machines)

When you scale out the topology, you add new Managed Servers configured with Oracle Fusion Applications to new computers where no Oracle Fusion Applications Managed Servers are configured.

You scale out the topology using Enterprise Manager Cloud Control. Benefits of Cloud Control include:

- Ease of use. Cloud Control automatically completes the provisioning and deployment processes. It gives you all the information you need about a Fusion Instance, Fusion Product Family, Fusion Product, and Fusion Application instances.

- Increased reliability. The Cloud Control process uses a job system to automatically and regularly rediscover WebLogic domains.

- Enhanced interface. Home pages enable you to monitor instances and product families at a glance. The interface makes transparent the relationship between the server and application deployment details. Cloud Control shows cluster applications from a product perspective.

Enterprise Manager Cloud Control enables you scale out a Fusion Product or a specific Fusion Application by:

- Provisioning a new WebLogic Server instance within the cluster

- Deploying an instance of the Fusion Application on the new WebLogic Server instance

There are two ways to scale out Fusion Applications:

- To scale out a Fusion Product Family, Product, or Fusion Cluster Application target, see "Scaling Out a Fusion Product Family, Product, or Fusion Cluster Application Target".

- To scale out a Fusion Instance target, seethe topic "Fusion Application Instance Scale Out - Scale Out Selections" in the Cloud Control online help.

Scaling Out a Fusion Product Family, Product, or Fusion Cluster Application Target

After you provide the information required to provision the new WebLogic Server instance, Enterprise Manager invokes a deployment procedure to automatically complete the provisioning and deployment processes.

To scale out a Fusion Product Family, Product, or Fusion Cluster Application target:

1. From the Targets menu, choose Fusion Applications to open the Fusion Applications target home page.

2. Select one of the following: Fusion Product Family, Product, or Fusion Cluster Application.

3. Choose Provisioning > Scale Out from the Product Family, Product, or Fusion Cluster Application menu for the selected target.

4. Click on the Fusion Product or Fusion Application you want to scale out in the topology view in the region on the left.
Note that some Fusion Products may be associated with up to two Fusion Applications in the topology view.

The WebLogic Server cluster(s) that the selected Fusion Product or Fusion Application is currently deployed appears in the region on the right.

5. Click Scale Out in the row for a cluster you want to add an instance to.

6. Enter the credentials for the Administration Server user in the WebLogic Domain Administrator Username and Password fields.
The Administration Server is a WebLogic Server instance that manages the WebLogic Server domain the cluster belongs to.

7. Specify a directory to store temporary data files during the scale out operation in the Administration Host Server Working Directory field; for example, /tmp.

8. Enter the credentials required to access the Administration Server host.

9. Specify the following for the new WebLogic Server instance:

- The hostname for the host that the instance will be provisioned to.

- A unique identifier for the new instance.

- The port that the instance will use.

10. Click Configure More Details.

11. Enter any additional information required to access the host machine that the new WebLogic Server instance will be created on. Required information includes:

- The credentials required to access the host.

- The directory to store temporary data files during the scale out operation; for example, /tmp

- The port that the WebLogic Server instance will use.

12. Click OK.

13. Click Scale Out.
Enterprise Manager creates a Deployment Procedure job to provision the new WebLogic Service instance, add it to the cluster, and deploy the Fusion Application instance to it.

Note:

Follow the preceding steps to scale out infrastructure applications (SOA, ESS).

16.5.3 Scaling Out Oracle RAC Databases

This section provides guidance on how to add nodes to existing Oracle RAC environments by using Oracle cloning, and then configuring the multi data source to route database requests to the new Oracle RAC instance.

This section contains the following topics:

- Section 16.5.3.1, "Cloning Oracle RAC Nodes to Scale Out Oracle Fusion Applications"

- Section 16.5.3.2, "Configuring the Multi Data Source to Include New Oracle RAC Nodes"

16.5.3.1 Cloning Oracle RAC Nodes to Scale Out Oracle Fusion Applications

The Oracle RAC cloning procedures assume that you successfully installed and configured an Oracle RAC environment that you want to add nodes and instances to. To add nodes to an Oracle RAC environment using cloning, you must first extend the Oracle Clusterware configuration, then extend the Oracle Database software with Oracle RAC, and then add the listeners and instances by running the Oracle assistants.

Related Topics

The following topics in the guide Oracle Real Application Clusters Administration and Deployment Guide provide additional information related to subjects discussed in this section:

- For more information about cloning nodes within the same cluster, see the chapter "Using Cloning to Extend Oracle RAC to Nodes in the Same Cluster."

- For Oracle cloning that is specific to UNIX system environments, see the chapter "Adding and Deleting Oracle RAC from Nodes on Linux and UNIX Systems."

- For Oracle cloning that is specific to Windows system environments, see the chapter "Adding and Deleting Oracle RAC from Nodes on Windows Systems."

16.5.3.2 Configuring the Multi Data Source to Include New Oracle RAC Nodes

After adding an Oracle RAC node to the database cluster as a part of scaling out the database, you must configure the multi data source to route database requests to the new Oracle RAC instance. You do this by adding a data source to each of the multi data sources that will route database requests to the newly added instance of the database.

Note:

Verify that the property values of the data source that you add match the property values in the other peer data source of the multi data source. See Table 16-3, "Recommended Data Source Property Settings for Non-XA Drivers" for a list of property values.

The example configures a multi data source with the properties shown in Table 16-4 but you can substitute the names and properties to scale any Oracle Fusion Applications cluster.

Table 16-4 Multi Data Source Example to Scale Out Oracle RAC with Oracle Fusion Applications

Property Name

Property Value

name

ApplicationDB

Jndi-name

jdbc/ApplicationDBDS

Data Sources

ApplicationDB01, ApplicationDB02

Target

Sales_Cluster

To configure the new Oracle RAC instance in a multi data source:

1. Log in to the Oracle WebLogic Administration Console.

2. Create a new data source, as follows:

1. Navigate to domain_name > Services > Data Sources
For example, navigate to CRM_Domain > Services > Data Sources.

2. In the Change Center, click Lock & Edit (if needed).

3. On the Summary of JDBC Data Sources page, click New to create a new data source. (Choose Generic Data Source.)

4. In the Name field, enter the name of the computer (ApplicationDB03) and enter the JNDI Name. The Database Type is Oracle.

5. Click Next.

6. For the Database Driver, choose the driver of type Thin and RAC Server-Instance Connection.

7. On the next screen, add details for this data source by providing Oracle RAC instance details for the new Oracle RAC instance, plus other properties matching its peer datasource in the Multi Data Source.

8. Click Finish.

9. In the Change Center, click Activate Changes.

10. In the Change Center, click Lock & Edit.

11. Navigate to domain_name > Services > Data Sources.

12. On the Summary of JDBC Data Sources page, choose the multi data source ApplicationDB.

13. On the right-hand pane for Settings for ApplicationDB, click the Data Sources tab.

14. In the Available list, find the newly created data source (ApplicationDB03) and click it to add it to the multi data source.

15. In the Change Center, click Save and Activate Changes.

Footnote Legend

Footnote 1: Oracle Clusterware is software that enables the servers to be bound together to operate as if they are one server and manages the availability of user applications and Oracle databases.

Part V

Appendixes

This part contains the following appendixes:

- Appendix A, "High Availability for Oracle Fusion Middleware Extensions for Applications"

- Appendix B, "High Availability for Oracle Enterprise Scheduler"

- Appendix C, "Seeded Searchable Objects, Search Categories, Index Schedules, and Facets"

A High Availability for Oracle Fusion Middleware Extensions for Applications

This appendix describes high availability considerations for Oracle Fusion Middleware Extensions for Applications (Applications Core). For more information about Oracle Fusion Applications high availability, see Chapter 16.

High availability refers to the ability of users to access a system without loss of service. Oracle Fusion Middleware has an extensive set of high availability features, which protect its components and applications from unplanned down time and minimize planned downtime.

This appendix includes the topic, Section A.1, "How Oracle Fusion Middleware Extensions Components Use Fusion Middleware Components for High Availability and Failover."

Related Topics

For more information about Oracle Fusion Middleware high availability, see the Oracle Fusion Middleware High Availability Guide.

A.1 How Oracle Fusion Middleware Extensions Components Use Fusion Middleware Components for High Availability and Failover

With the approach of building only with the use of other existing or lower-level components, Applications Core obtains complete high availability without the need to implement any high availability features itself. However, it is then important to know what base features each component is built upon, to understand how it behaves for high availability.

A.1.1 Oracle Metadata Repository

Applications Core relies almost entirely on MDS for storage of metadata used by Customization, Flexfields, and Menus. It is very important that MDS is configured for high availability. MDS for these operations should be based on a database rather than file based MDS architecture.

Related Links

The following document provides additional information related to subjects discussed in this section:

- For more information about configuring multi data sources for MDS repositories, see "Configuring Multi Data Sources for MDS Repositories" in the Oracle Fusion Middleware High Availability Guide.

A.1.2 Oracle Application Development Framework

Most runtime state information of an application is held in Oracle ADF. Applications Core does not create its own components, so it can achieve failover support by following the ADF rules for high availability development. When you are designing an application to run in a clustered environment, you must:

- Ensure that all managed beans with a life span longer than one request are serialized. When the Fusion web application runs in a clustered environment, a portion of the application's state is serialized and copied to another server or a data store at the end of each request so that the state is available to other servers in the cluster.

- Ensure that Oracle ADF is aware of changes to managed beans stored in ADF scopes (view scope and page flow scope) and enable the tracking of changes to ADF memory scopes. When a value within a managed bean in either view scope or page flow scope is modified, the application needs to notify Oracle ADF so that it can ensure the bean's new value is replicated.

Related Links

The following document provides additional information related to subjects discussed in this section:

- For more information about configuring high availability for ADF, see "Configuring High Availability for Oracle ADF and WebCenter Portal Applications" in the Oracle Fusion Middleware High Availability Guide.

A.1.3 WebLogic Server Failover for Session Content

Applications Core Session Management does cache the ApplSession using the HttpSession, but it is marked as non-serializable so that it does not get persisted in the event of failover/replication. The ApplSession will be re-established from the session cookie from the client that is set when the session is first created.

B High Availability for Oracle Enterprise Scheduler

This chapter describes how to configure and manage a highly available Oracle Enterprise Scheduler environment.

This appendix includes the following topics:

- Section B.1, "Introduction to High Availability for Oracle Enterprise Scheduler"

- Section B.2, "Oracle Enterprise Scheduler Concepts"

- Section B.3, "Configuring High Availability for Oracle Enterprise Scheduler"

- Section B.4, "Managing an Oracle Enterprise Scheduler Cluster"

B.1 Introduction to High Availability for Oracle Enterprise Scheduler

A highly available cluster of Oracle Enterprise Scheduler servers is recommended for optimal job performance. This is especially useful for running asynchronous jobs remotely, which may require returning a status message upon completion.

For example, suppose an asynchronous Oracle ADF Business Components job runs remotely. Oracle Enterprise Scheduler expects the job to send a status upon completion using a web services callback. If Oracle Enterprise Scheduler runs on only one node, if that node is down, the callback message does not arrive and the status of the job is unknown. The job would then require manual intervention to mark its status as complete.

A two node cluster, however, allows all callbacks to process and arrive at their destination even if one server is down. A clustered Oracle Enterprise Scheduler environment allows callbacks to be delivered as required, and jobs to complete with the correct status automatically assigned by the system.

The main steps required for configuring a highly available Oracle Enterprise Scheduler environment are as follows:

1. Use the Oracle Fusion Applications Install and Configuration Wizard to set up a domain and configure a cluster.

2. Add nodes to the cluster as required to enhance scalability, allowing more processing power for jobs.
When a cluster node is added, the new node's processor configuration might have to be adjusted to assign appropriate work assignments.

For more information, see the Oracle WebLogic Server documentation.

3. Configure the load balancer. For more information, see the Oracle HTTP Server documentation.

Related Links

For information about troubleshooting an Oracle Enterprise Scheduler cluster, see the following chapters:

- "Troubleshooting Oracle Enterprise Scheduler" chapter in the Oracle Fusion Applications Administrator's Troubleshooting Guide.

- "Troubleshooting Oracle Enterprise Scheduler" in the Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

B.2 Oracle Enterprise Scheduler Concepts

To configure an Oracle Enterprise Scheduler environment, it helps to understand concepts such as the architecture of Oracle Enterprise Scheduler, its components and life cycle.

For more information about Oracle Enterprise Scheduler architecture, components, life cycle and life cycle tools, see the section "Oracle Enterprise Scheduler Concepts" in the chapter "High Availability for Oracle Enterprise Scheduler" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

B.3 Configuring High Availability for Oracle Enterprise Scheduler

To enable a highly available environment, it is recommended to run Oracle Enterprise Scheduler in a cluster of at least two nodes.

This section includes the following topics:

- Section B.3.1, "Oracle Enterprise Scheduler Configuration and Deployment Artifacts"

- Section B.3.2, "Oracle Enterprise Scheduler Logging"

- Section B.3.3, "Backup and Recovery"

For more information about cluster architecture, failover requirements, scalability, and load balancing for Oracle Enterprise Scheduler, see the section "Configuring High Availability for Oracle Enterprise Scheduler" in the chapter "High Availability for Oracle Enterprise Scheduler" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

B.3.1 Oracle Enterprise Scheduler Configuration and Deployment Artifacts

Configuration files are as follows:

- ess.xml: This file is part of the Oracle Enterprise Scheduler EAR file deployed to the Oracle Enterprise Scheduler cluster.

- connections.xml: This file is part of the Oracle Enterprise Scheduler EAR file deployed to the Oracle Enterprise Scheduler cluster. This file is used only with Oracle Enterprise Scheduler deployments running in an Oracle Fusion Applications environment.

- MDS repository: The Oracle Metadata repository stores Oracle Enterprise Scheduler job metadata. Oracle Enterprise Scheduler supports both database and file-based MDS repositories.

Deployment artifacts are as follows:

- J2EE application for core runtime and hosting applications.

- Job metadata within Oracle MDS for core runtime and jobs loaded at startup.

The Oracle WebLogic Server deployment is non-staged.

B.3.2 Oracle Enterprise Scheduler Logging

Use standard Oracle WebLogic Server logging for an Oracle Enterprise Scheduler cluster. Use logs in Oracle WebCenter Content to examine Oracle Enterprise Scheduler behavior. Oracle Enterprise Scheduler logging is configured by default in Oracle WebLogic Server.

The default location for log files for Oracle Enterprise Scheduler spawned jobs on UNIX servers is /tmp/ess/requestFileDirectory. Oracle Enterprise Scheduler operational log files can be found under DOMAIN_HOME/servers/SERVER_HOME>/logs/server name>-diagnostic.log, and MW_HOME\user_projects\domains\DOMAIN_HOME\servers\SERVER_HOME\logs\server name-diagnostic.log on Windows.

B.3.3 Backup and Recovery

Following are the backup and recovery guidelines for various components:

- Components stored on the file system: Product binaries, deployed application EAR files and standard Oracle WebLogic Server files in the domain root.

- Changes to the file system: The file system artifacts change when new EAR files are deployed or when the product is patched.

- Data stored in the database: The database stores all metadata and runtime data.

- Changes to database artifacts: Metadata changes when metadata is created and deployed from Oracle JDeveloper or Fusion Applications Control. Run time data changes when jobs are submitted, undergo state changes, and so on.

There is no consistency requirement between the artifacts stored on the file system and those in database. The file system stores EAR files and temporarily stores scheduled job output and log files. Job output and log files are saved to Oracle WebCenter Content upon job completion. Only one database is used, and two phase commit is not used in an Oracle Fusion Applications environment.

B.4 Managing an Oracle Enterprise Scheduler Cluster

Managing an Oracle Enterprise Scheduler cluster involves starting the cluster, propagating configuration changes throughout the cluster, deploying applications and handling unexpected behavior.

For more information about managing an Oracle Enterprise Scheduler cluster, see the section "Managing an Oracle Enterprise Scheduler Cluster" in the chapter "High Availability for Oracle Enterprise Scheduler" in Oracle Fusion Middleware Administrator's Guide for Oracle Enterprise Scheduler.

Note:

Regarding failures in Oracle Java Transaction API migration and Oracle Java Message Service (JMS), Oracle JTA migration is unnecessary. When a node fails, there is no need to failover the node on another machine. Oracle Fusion Applications uses Oracle Enterprise Scheduler in a way does not require JTA recovery.

Oracle Enterprise Scheduler does not use Oracle Java Message Service (JMS) such that JMS recovery is not needed.

C Seeded Searchable Objects, Search Categories, Index Schedules, and Facets

This appendix provides information about the searchable objects, search categories, index schedules, and facets that are available in Oracle Fusion Applications. These searchable objects, search categories, index schedules, and facets are available for Oracle Fusion Applications Search.

This appendix includes the following topics:

- Section C.1, "Searchable Objects by Product Family"

- Section C.2, "Search Categories by Product Family"

- Section C.3, "Index Schedules by Product Family"

- Section C.4, "Facets by Product Family"

The Searchable View Objects (SVOs) are stored in the JAR files in the following fusionapps Middleware subdirectories:

(UNIX) FA_MW_HOME/applications/product_family/deploy/Earproduct_familySearch.ear/APP-INF/lib
(Windows) FA_MW_HOME\applications\product_family\deploy\Earproduct_familySearch.ear\APP-INF\lib

C.1 Searchable Objects by Product Family

Searchable objects are sets of data that make view objects available for text search. They are used in an abstract way for exposing business data to search engines.

Table C-1 provides a list of searchable objects available for Oracle Fusion Applications Search. The list is organized by product family and indicates the scope (global, focused, or both) of the search.

Note:

While Oracle Fusion Financials searchable objects are seeded, they are not available for search. Do not use Oracle Fusion Financials searchable objects to enable search because they are not seeded.

Table C-1 Searchable Objects by Product Family

Product Family

Searchable Object Name

Scope

Notes

Oracle Fusion Applications Help

TopicSearchPVO

Global

Do not modify this searchable object.

Oracle Fusion Customer Relationship Management

Billing Accounts - oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerAccountPVO

Both

Campaigns - oracle.apps.marketing.coreMarketing.campaigns.publicViewEcsf.CampaignsPVO

Global

Competitors - oracle.apps.sales.baseSales.competitors.publicViewEcsf.CompetitorPVO

Global

Contacts - oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerContactPVO

Both

Contract Documents - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.ContractDocumentSearchVO

Focused

Customer Assessments - oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerAssessmentPVO

Both

Customer Contracts - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.Customer360ContractPVO

Focused

Customer Interactions - oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerInteractionPVO

Both

Customer Leads - oracle.apps.marketing.leadMgmt.leads.publicViewEcsf.MklCustomer360LeadPVO

Focused

Customer Notes - oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerNotePVO

Both

Customer Opportunities - oracle.apps.sales.opptyMgmt.opportunities.publicViewEcsf.Customer360OpportunityPVO

Focused

Customer Profiles - oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerPVO

Both

Customer References - oracle.apps.sales.baseSales.references.publicViewEcsf.Customer360ReferencePVO

Focused

Enterprise Contracts - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.ContractHeaderSearchVO

Both

Leads - oracle.apps.marketing.leadMgmt.leads.publicViewEcsf.MklLeadPVO

Both

Opportunities - oracle.apps.sales.opptyMgmt.opportunities.publicViewEcsf.OpportunityPVO

Both

Partner Profiles - oracle.apps.partnerFinder.publicViewEcsf.view.PartnerProfilePVO

Focused

Partners - oracle.apps.partnerMgmt.partnerCenter.publicViewEcsf.view.PartnerPVO

Global

Purchasing Contract Documents - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.PoDocumentSearchVO

Focused

Purchasing Contracts - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.PoHeaderSearchVO

Focused

References - oracle.apps.sales.baseSales.references.publicViewEcsf.ReferencePVO

Global

Sourcing Contract Documents - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.AuctionDocumentSearchVO

Focused

Sourcing Contracts - oracle.apps.contracts.dashBoard.textSearch.publicModel.view.AuctionHeaderSearchVO

Focused

Oracle Fusion Financials

Payables Credit Memo

Global

This searchable object is not available for search.

Payables Payment

Global

This searchable object is not available for search.

Payables Prepayment

Global

This searchable object is not available for search.

Payables Refund

Global

This searchable object is not available for search.

Payables Standard Invoice

Global

This searchable object is not available for search.

Receivables Adjustment

Global

This searchable object is not available for search.

Receivables ChargeBack

Global

This searchable object is not available for search.

Receivables Credit Memo

Global

This searchable object is not available for search.

Receivables Debit Memo

Global

This searchable object is not available for search.

Receivables Invoice

Global

This searchable object is not available for search.

Receivables Miscellaneous Receipt

Global

This searchable object is not available for search.

Receivables Standard Receipt

Global

This searchable object is not available for search.

Collections Delinquency

Global

This searchable object is not available for search.

Expense

Global

This searchable object is not available for search.

Expense Report

Global

This searchable object is not available for search.

Fixed Asset

Global

This searchable object is not available for search.

Intercompany Transaction

Global

This searchable object is not available for search.

Journal

Global

This searchable object is not available for search.

Miscellaneous Receipt

Global

This searchable object is not available for search.

Oracle Fusion Human Capital Management

Worker

Global

Like Aria.

Worker

Global

Secure.

Oracle Fusion Procurement

Purchase Requisitions - oracle.apps.prc.por.publicViewEcsf.RequisitionHeaderPVO

Global

Purchase Orders - oracle.apps.prc.po.publicViewEcsf.PurchaseOrderHeaderPVO

Global

Purchase Agreements - oracle.apps.prc.po.publicViewEcsf.PurchaseAgreementHeaderPVO

Global

Negotiations - oracle.apps.prc.pon.publicViewEcsf.NegotiationHeaderPVO

Global

Suppliers - oracle.apps.prc.poz.publicViewEcsf.SupplierPVO

Global

Oracle Fusion Project

ProjectSearchPVO

Global

ProjectBudgetSearchPVO

Global

ProjectAssetPVO

Global

ProjectContractInvoicePVO

Global

ProjectEventPVO

Global

ProjectExpenditureItemPVO

Global

ProjectForecastSearchPVO

Global

ProjectTaskPVO

Global

Oracle Fusion Supply Chain Management

Orchestration Orders - oracle.apps.scm.doo.workbench.publicViewEcsf.view.OrchestrationOrderPVO

Global

Items - oracle.apps.scm.productModel.publicViewEcsf.ItemPVO

Global

Cost Adjustments - oracle.apps.scm.costing.distProcessors.reviewDistributions.publicViewEcsf.CostAdjustmentsPVO

Global

Material Transactions - oracle.apps.scm.costing.distProcessors.reviewDistributions.publicViewEcsf.MaterialTransactionsPVO

Global

Item Costs - oracle.apps.scm.costing.itemCosts.publicViewEcsf.ItemCostsPVO

Global

COGS Transactions - oracle.apps.scm.costing.distProcessors.reviewDistributions.publicViewEcsf.CogsTransactionPVO

Global

Receiving Transactions - oracle.apps.scm.receiptAccounting.receiptAccounting.reviewAccounting.publicViewEcsf.RecptAcctgPVO

Global

Accrual Adjustments - oracle.apps.scm.receiptAccounting.accrualClearing.adjustAccruals.publicViewEcsf.AdjustAccrualsPVO

Global

Receipts - oracle.apps.scm.receiving.publicViewEcsf.ReceiptPVO

Global

Inbound Shipments - oracle.apps.scm.receiving.publicViewEcsf.InboundShipmentPVO

Global

Outbound Shipments - oracle.apps.scm.shipping.shipConfirm.deliveries.publicViewEcsf.ShipmentPVO

Global

C.2 Search Categories by Product Family

Search categories are logical collections of searchable objects that facilitate group search on related items.

Table C-2 provides a list of search categories available for Oracle Fusion Applications Search. The list is organized by product family and includes the business objects for each search category.

Note:

While Oracle Fusion Financials search categories are seeded, they are not available for search. Do not use Oracle Fusion Financials search categories to enable search.

Table C-2 Search Categories by Product Family

Product Family

Search Category Name

Business Object

Scope

Oracle Fusion Applications Help

Help

TopicSVO

GLOBAL

Oracle Fusion Customer Relationship Management

All Contracts

Enterprise Contracts

LOCAL

Purchasing Contracts

Sourcing Contracts

Campaigns

Campaigns

GLOBAL

Competitors

Competitors

GLOBAL

Contacts

Contacts

GLOBAL

Contract Documents

Sourcing Contract Documents

LOCAL

Purchasing Contract Documents

Contract Documents

Customer

Customer Interactions

LOCAL

Contacts

Billing Accounts

Customer Assessments

Customer Contracts

Customer Profiles

Customer References

Customer Opportunities

Customer Notes

Customer Leads

Customers

Customer Profiles

GLOBAL

Contacts

Customer Assessments

Customer Notes

Billing Accounts

Customer Interactions

ECM Contracts

Enterprise Contracts

GLOBAL

Lead

Leads

LOCAL

Leads

Leads

GLOBAL

Opportunities

Opportunities

GLOBAL

Opportunity

Opportunities

LOCAL

Partners

Partners

GLOBAL

Public Partners

Public Partners

LOCAL

References

References

GLOBAL

Oracle Fusion Financials

Payables

Payables Standard Invoice

GLOBAL

Payables Payment

Payables Credit Memo

Payables Prepayment

Payables Refund

Expenses

Expense Report

GLOBAL

Expense

GLOBAL

Fixed Assets

Fixed Asset

GLOBAL

General Accounting

Journal

GLOBAL

InterCompany Transaction

GLOBAL

Account Receivables

Receivables Invoice

GLOBAL

Receivables Miscellaneous Receipt

GLOBAL

Receivables Receipt

GLOBAL

Receivables Credit Memo

GLOBAL

Receivables Debit Memo

GLOBAL

Receivables Adjustments

GLOBAL

Receivables ChargeBack

GLOBAL

Collections

Collections Delinquency

GLOBAL

Oracle Fusion Human Capital Management

Worker

Worker

GLOBAL

Global Worker

GLOBAL

Oracle Fusion Partner Relationship Management

Partners

PartnerProfileSVO

Oracle Fusion Procurement

Procurement

Purchase Requisitions

GLOBAL

Purchase Agreements

GLOBAL

Purchase Orders

GLOBAL

Negotiations

GLOBAL

Suppliers

GLOBAL

Oracle Fusion Project

Projects

Project

GLOBAL

Project Task

GLOBAL

Project Asset

GLOBAL

Project Contract Invoice

GLOBAL

Project Budget Version

GLOBAL

Project Forecast Version

GLOBAL

Project Event

GLOBAL

Project Expenditure Item

GLOBAL

Oracle Fusion Supply Chain Management

Cost Accounting

Cost Adjustments

GLOBAL

Material Transactions

GLOBAL

COGS Transactions

GLOBAL

Item Costs

GLOBAL

Receipt Accounting

Receiving Transactions

GLOBAL

Accrual Adjustments

GLOBAL

Orchestration Order

Orchestration Orders

GLOBAL

Receiving

Receipts

GLOBAL

Inbound Shipments

GLOBAL

Shipping

Outbound Shipments

GLOBAL

Items

Items

GLOBAL

C.3 Index Schedules by Product Family

Index schedules define the frequency at which the Oracle Secure Enterprise Search search engine crawls the searchable objects in Oracle Fusion Applications and indexes them as documents.

The following tables provide a list of index schedules available for Oracle Fusion Applications Search. The tables are organized by product family.

- Table C-3, "Index Schedules for Oracle Fusion Customer Relationship Management"

- Table C-4, "Index Schedules for Oracle Fusion Applications Help"

- Table C-5, "Index Schedules for Oracle Fusion Human Capital Management"

- Table C-6, "Index Schedules for Personal Information Manager (PIM)"

- Table C-7, "Index Schedules for Oracle Fusion Procurement"

- Table C-8, "Index Schedules for Oracle Fusion Project"

- Table C-9, "Index Schedule for Oracle Fusion Supply Chain Management"

Note:

While Oracle Fusion Financials index schedules are seeded, they are not available for search. Do not use Oracle Fusion Financials index schedules to enable search.

Table C-3 Index Schedules for Oracle Fusion Customer Relationship Management

Schedule Name

Searchable Object

Business Object

Repeat Interval

Campaigns

Campaigns

oracle.apps.marketing.coreMarketing.campaigns.publicViewEcsf.CampaignsPVO

Manual

Competitors

Competitors

oracle.apps.sales.baseSales.competitors.publicViewEcsf.CompetitorPVO

Manual

Contacts

Contacts

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerContactPVO

Manual

Contract Documents

Contract Documents

oracle.apps.contracts.dashBoard.textSearch.publicModel.view.ContractDocumentSearchVO

Manual

Customer Assessments

Customer Assessments

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerAssessmentPVO

Manual

Billing Accounts

Billing Accounts

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerAccountPVO

Manual

Customer Contracts

Customer Contracts

oracle.apps.contracts.dashBoard.textSearch.publicModel.view.Customer360ContractPVO

Manual

Customer Interactions

Customer Interactions

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerInteractionPVO

Manual

Customer Leads

Customer Leads

oracle.apps.marketing.leadMgmt.leads.publicViewEcsf.MklCustomer360LeadPVO

Manual

Customer Notes

Customer Notes

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerNotePVO

Manual

Customer Opportunities

Customer Opportunities

oracle.apps.sales.opptyMgmt.opportunities.publicViewEcsf.Customer360OpportunityPVO

Manual

Customer References

Customer References

oracle.apps.sales.baseSales.references.publicViewEcsf.Customer360ReferencePVO

Manual

Customer Profiles

Customer Profiles

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerPVO

Manual

Enterprise Contracts

Enterprise Contracts

oracle.apps.contracts.dashBoard.textSearch.publicModel.view.ContractHeaderSearchVO

Manual

Leads

Leads

oracle.apps.marketing.leadMgmt.leads.publicViewEcsf.MklLeadPVO

Manual

Opportunities

Opportunities

oracle.apps.sales.opptyMgmt.opportunities.publicViewEcsf.OpportunityPVO

Manual

Partner Profiles

Partner Profiles

oracle.apps.partnerFinder.publicViewEcsf.view.PartnerProfilePVO

Manual

Partners

Partners

oracle.apps.partnerMgmt.partnerCenter.publicViewEcsf.view.PartnerPVO

Manual

Purchasing Contracts

Purchasing Contracts

oracle.apps.contracts.dashBoard.textSearch.publicModel.view.PoHeaderSearchVO

Manual

References

References

oracle.apps.sales.baseSales.references.publicViewEcsf.ReferencePVO

Manual

Sourcing Contracts

Sourcing Contracts

oracle.apps.contracts.dashBoard.textSearch.publicModel.view.AuctionHeaderSearchVO

Manual

Table C-4 Index Schedules for Oracle Fusion Applications Help

Schedule Name

Searchable Object

Business Object

Repeat Interval

Help Schedule

TopicSearch

oracle.apps.atk.helpPortal.publicView.TopicSearchPVO

Manual

Table C-5 Index Schedules for Oracle Fusion Human Capital Management

Schedule Name

Searchable Object

Business Object

Repeat Interval

All Workers Schedule

GlobalWorker

GlobalWorkerPVO

Manual

My Reports Schedule

Worker

WorkderPVO

Manual

Table C-6 Index Schedules for Personal Information Manager (PIM)

Product

Schedule Name

Search Category

Business Object

Repeat Interval

Product Management

Items Schedule

Items

oracle.apps.scm.productModel.publicViewEcsf.ItemPVO

Manual

Table C-7 Index Schedules for Oracle Fusion Procurement

Schedule Name

Searchable Object

Business Object

Repeat Interval

Negotiations Schedule

Negotiations

NegotiationsPVO

Manual

Purchase Agreement Schedule

Purchase Agreements

PurchaseAgreementPVO

Manual

Purchase Order Schedule

Purchase Orders

PurchaseOrderPVO

Manual

Purchase Requisition Schedule

Purchase Requisitions

PurchaseRequisitionPVO

Manual

Suppliers Schedule

Suppliers

SuppliersPVO

Manual

Table C-8 Index Schedules for Oracle Fusion Project

Schedule Name

Searchable Object

Business Object

Repeat Interval

Repeat Interval Unit

Schedule Launch Interval

Schedule Launch Time

Projects

ProjectSearch

ProjectSearchPVO

1

Daily

12:00 AM

Project Assets

ProjectAsset

ProjectAssetPVO

1

Weekly

Saturday

12:00 PM

Project Budgets

ProjectBudgetSearch

ProjectBudgetSearchPVO

1

Daily

12:00 AM

Project Contract Invoices

ProjectContractInvoice

ProjectContractInvoicePVO

2

Weekly

Saturday

12:00 PM

Project Events

ProjectEvent

ProjectEventPVO

2

Weekly

Saturday

12:00 PM

Project Expenditure Items

ProjectExpenditureItem

ProjectExpenditureItemPVO

1

Daily

12:00 AM

Project Forecasts

ProjectForecastSearch

ProjectForecastSearchPVO

1

Daily

12:00 AM

Project Tasks

ProjectTask

ProjectTaskPVO

1

Daily

12:00 AM

Table C-9 Index Schedule for Oracle Fusion Supply Chain Management

Schedule Name

Product

Search Category

Business Object

Repeat Interval

Inbound Schedule

Receiving

Receiving

oracle.apps.scm.receiving.publicViewEcsf.InboundShipmentPVO

Manual

Receipt Schedule

Receiving

Receiving

oracle.apps.scm.receiving.publicViewEcsf.ReceiptPVO

Manual

Shipping Schedule

Shipping

Shipping

oracle.apps.scm.shipping.shipConfirm.deliveries.publicViewEcsf.ShipmentPVO

Manual

Orchestration Orders Schedule

DOO

Orchestration Order

oracle.apps.scm.doo.workbench.publicViewEcsf.view.OrchestrationOrderPVO

Manual

Cost Adjustments Schedule

Cost Management

Cost Accounting

oracle.apps.scm.costing.distProcessors.reviewDistributions.publicViewEcsf.CostAdjustmentsPVO

Manual

Cogs Transactions Schedule

Cost Management

Cost Accounting

oracle.apps.scm.costing.distProcessors.reviewDistributions.publicViewEcsf.CogsTransactionPVO

Manual

Material Transactions Schedule

Cost Management

Cost Accounting

oracle.apps.scm.costing.distProcessors.reviewDistributions.publicViewEcsf.MaterialTransactionsPVO

Manual

Item Costs Schedule

Cost Management

Cost Accounting

oracle.apps.scm.costing.itemCosts.publicViewEcsf.ItemCostsPVO

Manual

Accrual Adjustments Schedule

Cost Management

Receipt Accounting

oracle.apps.scm.receiptAccounting.accrualClearing.adjustAccruals.publicViewEcsf.AdjustAccrualsPVO

Manual

Receiving Transactions Schedule

Cost Management

Receipt Accounting

oracle.apps.scm.receiptAccounting.receiptAccounting.reviewAccounting.publicViewEcsf.RecptAcctgPVO

Manual

C.4 Facets by Product Family

Facets are predefined aspects, or dimensions, of a searchable object. Facet-based navigation of the search results, or Faceted Navigation, allows end users to narrow down their search by navigating through structured search results.

Table C-10 provides a list of facets available for Oracle Fusion Applications Search. The list is organized by product family and includes the facets for each search category.

Note:

While Oracle Fusion Financials facets are predefined, they are not available for search. Do not use Oracle Fusion Financials facets to enable search.

Table C-10 Facets by Product Family

Product Family

Search Category

Facet

Oracle Fusion Customer Relationship Management

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerInteractionPVO

oracle.apps.customerCenter.infrastructure360.publicViewEcsf.CustomerNotePVO

oracle.apps.sales.opptyMgmt.opportunities.publicViewEcsf.OpportunityPVO

Oracle Fusion Supply Chain Management

Shipping

oracle.apps.scm.shipping.shipConfirm.deliveries.publicViewEcsf.ShipmentPVO

Receiving

oracle.apps.scm.receiving.publicViewEcsf.ReceiptPVO

oracle.apps.scm.receiving.publicViewEcsf.InboundShipmentPVO

Projects

oracle.apps.projects.foundation.publicView.ecsf.ProjectAssetPVO

oracle.apps.projects.foundation.publicView.ecsf.ProjectBudgetSearchPVO

oracle.apps.projects.foundation.publicView.ecsf.ProjectContractInvoicePVO

oracle.apps.projects.foundation.publicView.ecsf.ProjectEventPVO

oracle.apps.projects.foundation.publicView.ecsf.ProjectExpenditureItemPVO

oracle.apps.projects.foundation.publicView.ecsf.ProjectForecastSearchPVO

Glossary

abstract role

An enterprise role that can be associated with any user, irrespective or his or her job or duties. Typical examples of this role are Employee, Manager, Customer, and Supplier. Several job roles are provisioned with each Oracle Fusion application. An abstract role must inherit at least a duty role.

Active Session History (ASH)

See ASH.

ADDM

Automatic Database Diagnostic Monitor. Analyzes statistics to provide automatic diagnosis of major performance problems.

Administration Server

Part of the Oracle WebLogic Server domain and runs the processes that manage Oracle Business Intelligence components. The Administration Server includes the Oracle WebLogic Server Administration Console, Oracle Fusion Middleware Control, and JMX MBeans. For a Simple Install type, the Administration Server also includes Java components for Oracle Business Intelligence such as Oracle BI Publisher and Oracle Real-Time Decisions.

ADR

Automatic Diagnostic Repository. A file-based repository that stores database diagnostic data such as trace files, the alert log, and Health Monitor reports. Its enables customers and Oracle Support to correlate and analyze diagnostic data across multiple Oracle instances, components, and products. ADR is located outside the database, which enables Oracle Database to access and manage ADR when the physical database is unavailable. An instance can create ADR before a database has been created.

adrci

Automatic Diagnostic Repository Command Interpreter. A standard incident administration tool, you can use it for viewing and packaging incidents. It is provided with each instance of the Automatic Diagnostic Repository (ADR) in Oracle Fusion Applications, Oracle Fusion Middleware, and Oracle Database.

Advanced Queuing (AQ)

See AQ.

aggregate storage option (ASO)

See ASO.

API

Application Programming Interface. A set of exposed data structures and functions that an application can use to invoke services on an application object, such as a portlet.

application programming interface (API)

See API.

application role

A configuring role which is a collection of users, enterprise roles, and application roles, and is stored in the domain policy store.

AQ

Advanced Queuing. AQ provides database-integrated message queuing functionality. It leverages the functions of the Oracle database so that messages can be stored persistently, propagated between queues on different machines and databases, and transmitted using Oracle Net Services, HTTP (S), and SMTP.

ASH

Active Session History. Active Session History (ASH) statistics are samples of session activity in the database. The database samples active sessions every second and stores them in a circular buffer in the System Global Area (SGA). Any session that is connected to the database and using CPU, or is waiting for an event that does not belong to the idle wait class, is considered an active session

ASO

Aggregate Storage Option. The option to use Aggregate Storage as opposed to Block Storage.

automatic memory management

A database memory-management mode whereby the database dynamically tunes the sizes of the individual SGA components and the sizes of the individual Program Global Area (PGA).

automatic PGA memory management

A database memory-management mode whereby you set a target size for the instance PGA. The database then tunes the size of the instance PGA to your target, and dynamically tunes the sizes of individual PGAs.

automatic shared memory management

A database memory-management mode whereby you set target and maximum sizes for the SGA. Oracle Database then tunes the total size of the SGA to your designated target, and dynamically tunes the sizes of all SGA components. In this memory management mode, you also implicitly enable automatic PGA memory management.

Automatic Database Diagnostic Monitor (ADDM)

See ADDM.

Automatic Diagnostic Repository (ADR)

See ADR.

Automatic Diagnostic Repository Command Interpreter (adrci)

See adrci.

Automatic Workload Repository (AWR)

See AWR.

AWR

Automatic Workload Repository. Automates database statistics gathering by collecting, processing, and maintaining performance statistics for database problem detection and self-tuning purposes.

AWR snapshot

A set of data for a specific time that is used for performance comparisons.

BHD

Bounce Handling Daemon. A daemon that tracks e-mail messages that cannot be delivered, parses the returned e-mail messages, and records the cause of the e-mail bounce.

bounce handling daemon (BHD)

See BHD.

BPEL

Business Process Execution Language. An XML-based markup language for composing a set of discrete web services into an end-to-end process flow.

BSO

Block storage option. The option to use block storage as opposed to aggregate storage.

Business Process Execution Language (BPEL)

See BPEL.

business role

See job role.

CA

Certificate Authority. A trusted third party that issues, renews, and revokes digital certificates. The CA essentially vouches for a entity's identity, and may delegate the verification of an applicant to a Registration Authority (RA). Some well known Certificate Authorities (CAs) include Digital Signature Trust, Thawte, and VeriSign.

Certificate Authority (CA)

See CA.

Click -Through Daemon (CTD)

See CTD.

Common Unix Printing Service (CUPS)

See CUPS.

CRM

Customer relationship management. A portfolio of CRM solutions that addresses customer touch-points and provides functionality to support an organization's business needs.

CSF

Credential store framework. A set of APIs that applications can use to create, read, update, and manage credentials securely. A typical use of the credential store is to store credentials (user name and password) to access some external system, such as a database or an LDAP-base repository.

CSR

Customer Service Representative. Customer service representatives resolve low risk customer issues originating from customer calls. CSRs have limited access to OAAM Admin.

credential store framework (CSF)

See CSF.

CTD

Click -Through Daemon. It passes details about the HTTP requests it serviced (tracked URLs, Forward to a Friend and so on) to the Marketing Server through SOAP protocol. The communication between the CTD and the Marketing Server requires you to define a way for the SOAP messages top ass through the inner DMZ firewall.

CUPS

Common Unix Printing Service. A modular printing system for Unix-like computer operating systems which allows a computer to act as a print server.

customer relationship management (CRM)

See CRM.

customer service representative (CSR)

See CSR

DAL

Data Access Layer. A layer which provides simplified access to data stored in persistent storage, such as a database.

Data Access Layer (DAL)

See DAL

data role

An enterprise role used exclusively in data security policies. It can inherit job roles, duty roles, and abstract roles. Several data roles are provisioned with each Oracle Fusion application.

data security policy

An Oracle Fusion application policy which includes a condition that identifies a row or a set of rows in a business object, and the privileges the data security grants are for only the data that meets the condition. Data security policies are stored in the transactional database.

Database Administrator (DBA)

See DBA.

DBA

Database Administrator. A user belonging to the DBA group. By default, members in the DBA group have access to all Oracle Portal product pages, and have the Manage privilege for all pages, page groups, database providers, and administration.

diagnostic administrator job role

A job role which can use all diagnostic testing functionality provided for Oracle Fusion applications, including purging test results from the database and canceling test runs started by other users.

diagnostic advanced user job role

A job role which can schedule and execute diagnostic test runs, view diagnostic test results, attach test results to application incidents for Oracle Fusion applications, and cancel diagnostic test runs that were started by the current user. In general, this job role is recommended for running Oracle Fusion Applications diagnostic tests, since its added capabilities allow users to work with administrators more flexibly during troubleshooting.

diagnostic regular User job role

A job role which can schedule and execute diagnostic test runs, view diagnostic test results for Oracle Fusion applications, and cancel diagnostic test runs that were started by the current user.

diagnostic viewer job role

A job role which can view and analyze diagnostic test results for Oracle Fusion applications.

Distinguished Names (DN)

See DN.

distributed

The term for any environment that is not a non-distributed environment.

DMS

Dynamic Monitoring Service. Enables Oracle Fusion Middleware components to provide administration tools, such as Oracle Enterprise Manager, with data regarding the component's performance, state and on-going behavior. Fusion Middle components push data to DMS and in turn DMS publishes that data through a range of different components. Specifically, DMS is used by Oracle HTTP Server, Oracle Application Development Framework, WebLogic Diagnostic Framework (WLDF), and JDBC. DMS measures and reports metrics, trace events and system performance and provides a context correlation service for these components.

DN

Distinguished Names. Common entries between the source and destination directories.

duty role

An application role that corresponds with the duties of the job.

Dynamic Monitoring Service (DMS)

See DMS.

EAR

Enterprise Archive file. A Java EE archive file that is used in deploying applications on a Java EE application server. WebCenter Portal applications are deployed using both a generic EAR file, which contains the application and the respective runtime customization, and a targeted EAR file, which contains only the application for deployment to the application server. EAR files simplify application deployment by reducing the possibility of errors when moving an application from development to test, and test to production.

ECID

Execution Context Identifier. A global unique identifier and a sequence number of the thread of execution that the originating component participates in. The identifier can be used to correlate messages from several components that may be involved in the same thread of execution.

EDN

Event Delivery Network. A type of queue used for event Propagation. EDN uses Advanced Queueing (AQ) database queues.

EJB

Enterprise Java Beans. It is the server-side component architecture for Java Platform, Enterprise Edition (Java EE). EJB technology enables rapid and simplified development of distributed, transaction, secure and portable applications based on Java Technology.

Email Sending Daemon (ESD)

See ESD.

Enterprise Archive file (EAR)

See EAR.

enterprise group

The term used for enterprise roles in the Oracle WebLogic Administration Console.

Enterprise Java Beans (EJB)

See EJB.

enterprise role

A configuring role which is a collection of users and other enterprise roles. It is stored in the domain identity store.

Enterprise Scheduler Application (ESSAPP)

See ESSAPP.

ESD

Email Sending Daemon. Assembles each outbound email message for a campaign using the email template (HTML or text) and the recipient list, and then sends each message to your company's outbound MTAs for delivery.

ESSAPP

Enterprise Scheduler Application. The Oracle Enterprise Scheduler Application manages job requests for the Oracle Fusion Financials product family.

ETL

Extract, Transform, and Load. ETL refers to the methods involved in accessing and manipulating source data and loading it into a data warehouse. The order in which these processes are performed varies. Note that ETT (extraction, transformation, transportation) and ETM (extraction, transformation, move) are sometimes used instead of ETL.

Event Delivery Network (EDN)

See EDN.

exclusive binding mode

A method of binding a work assignment to a request processor in which job requests specialized to the work assignment are processed exclusively by that work assignment when it is active. These job requests are excluded from all other work assignments, including the default work assignment. If the work assignment does not have an active workshift, then the job request can be processed by another work assignment.

Execution Context Identifier (ECID)

See ECID.

External roles

The term used for enterprise roles in the Oracle Authorization Policy Manager environment.

extract, transform, and load (ETL)

See ETL.

farm

A collection of components managed by Fusion Applications control. It can contain an Oracle WebLogic Server Domain, one Administration Server, one or more Managed Servers, clusters, and the Oracle Fusion Middleware components that are installed, configured, and running in the domain.

FAST

Find, assess, secure, test. A methodology required during data masking.

Find, assess, secure, test (FAST)

See FAST.

FND Grant

Foundation Grant. A data security policy, which ties a data role or job role to a specific set of data.

Foundation Grant (FND Grant)

See FND Grant.

full-movement scenario

A scenario that may occur when moving Oracle Fusion Applications components from one environment to another. In a full-movement scenario, the target environment does not exist. First, the source environment is created, configured, customized, and tested. Then, the target environment is created by moving all the components along with their configurations from the source environment.

functional policy

An Oracle Fusion application policy which does not include a condition. Instead, a function policy assigns permission to resources or code artifacts (such as task flows, pages, Java methods, or UI components) and grants a specific set of actions on each resource. Functional policies are stored in the domain policy store.

global policy attachment (GPA)

See GPA.

global unique identifier (GUID)

See GUID.

GPA

Global Policy Attachment. A policy set in which policies are attached globally to a range of endpoints of the same type. By using GPA, you can ensure that all subjects are secured by default.

GUID

Global unique identifier. An identifier generated by the system and inserted into an entry when the entry is added to the directory. In a multimaster replicated environment, the GUID, not the DN, uniquely identifies an entry. The GUID of an entry cannot be modified by a user.

IDE

Integrated Development Environment. A visual application development tool containing editors, debuggers, screen painters, object browsers, and the like. Oracle JDeveloper is an example of an IDE.

initialization parameter file

A text file that can be read by the Oracle instance, but it is not written to by the instance. You can change a text initialization parameter file with a text editor, but changes do not take effect until you restart the Oracle instance. When you start the instance with this type of file, you can still change many initialization parameters dynamically with Database Control, but only for the current instance. Unless you also edit the text initialization parameter file and make the same change, the change is lost when you restart the database instance.

Integrated Development Environment (IDE)

See IDE.

Internet Printing Protocol (IPP)

See IPP

IPP

Internet Printing Protocol. A standard network protocol for remote printing as well as for managing print jobs, media size, resolution, and so forth.

Java EE

Also known as Java EE 5. Java Enterprise Edition 5 Platform. A platform that enables application developers to develop, deploy, and manage multitier, server-centric, enterprise-level applications. The Java EE platform offers a multi-tiered distributed application model, integrated XML-based data interchange, a unified security model, and flexible transaction control. You can build you own Java EE portlets and expose them through web producers.

Java EE applications

Applications that run in Java Enterprise Edition (Java EE).

Java Message Service (JMS)

See JMS.

Java Required Files (JRF)

See JRF.

Java Virtual Machine (JVM)

See JVM.

JKS keystore

The default JDK implementation of Java keystores.

JMS

Java Message Service. A Java API that allows applications to create, send, receive, and read messages using reliable, asynchronous, loosely coupled communication.

job role

An enterprise role that corresponds with a job or business occupation. A Job role must inherit at least a Duty role.

job sets

A collection of job requests.

JRF

Java Required Files. The JRF include the Oracle ADF libraries, several other components shared by the product suites included in a given installation, and components such as Oracle Metadata Service (MDS) and Oracle Platform Security Services (OPSS).

JVM

Java Virtual Machine. A virtual machine that can execute Java bytecode.

LBR

Load-balancing router. A very fast network device that distributes Web requests to a large number of servers. It provides portal users with a single published address, without their having to send each request to a specific middle tier server.

LDAP

Lightweight Directory Access Protocol. A standard, extensible directory access protocol. It is a common language that LDAP clients and servers use to communicate. The framework of design conventions supporting industry-standard directory products, such as the Oracle Internet Directory.

LDAP Data Interchange Format (LDIF)

See LDIF.

LDIF

LDAP Data Interchange Format. The set of standards for formatting an input file for any of the LDAP command-line utilities.

Lightweight Directory Access Protocol (LDAP)

See LDAP

load-balancing router (LBR)

See LBR.

Local Policy Attachment (LPA)

See LPA.

LPA

Local Policy Attachment. The act of directly attaching one or more policies to a policy subject.

Managed Server

In a production environment, a Managed Server hosts applications and the resources needed by those applications. A domain, which is a logically related group of Oracle WebLogic Server resources, can have any number of managed Servers. An Administration Server manages these servers.

manual shared memory management

A database memory-management mode whereby you set the sizes of several individual System Global Area (SGA) components, thereby determining the overall SGA size. You then manually tune these individual SGA components on an ongoing basis. Manual shared memory management mode is intended for experienced DBAs only. Note that in this mode, automatic PGA memory management remains enabled.

move plan

A single XML file, derived from multiple configuration archives, that provides the properties required to copy content from one installation to another.

NAT

Network Address Translation. The process of modifying IP address information in IP packet headers while in transit across a traffic routing device.

Network Address Translation (NAT)

See NAT.

Network File System (NFS)

See NFS.

NFS

Network File System. A distributed file system protocol which allows you to access files over a network in a manner similar to how local storage is accessed.

Node Manager

An Oracle WebLogic Server utility that enables you to start, shut down, and restart Administration Server and Managed Server instances from a remote location. Although Node Manager is optional, it is recommended if your Oracle WebLogic Server environment hosts applications with high availability requirements.

non-distributed

The term for an environment in which the Administration Servers of all the domains and all the system component instances run on the same host.

non-XA transaction

A non-XA transaction always involves just one resource and generally cannot participate in a global transaction.

ODL

Oracle Diagnostic Logging. A method of logging which attempts to harmonize the different logging standards that are used by Oracle products.

ODV

Oracle Database Vault. ODV establishes limitations on the power of privileged users to access sensitive data through segregation of duties policies on DBA roles and by securely consolidating application data in the database. These limitations prevent DBAs and other privileged users from overriding the protections placed on sensitive data by the Virtual Private Database (VPD). Oracle Fusion Applications deploys with the ODV enabled when it is installed.

offline backup

A mode of backup for your Oracle Fusion Applications Environment in which you must first shut down the environment. The Administration Server, all Managed Servers in the domain, and all system components in the Oracle instances should be shut down.

OLTP

Online Transaction Processing. OLTP systems are one of the most common data processing systems in today's enterprises. They are primarily characterized through a specific data usage that is different from data warehousing environments, yet some of the characters, such as having large volumes of data and lifecycle-related data usage and importance, are identical. Main characteristics of OLTP are short response time, small transactions, data maintenance operations, large user populations, high concurrency, large data volumes, high availability, and lifecycle related data usage.

online backup

A mode of backup for your Oracle Fusion Applications environment in which you do not shut down the environment before backing up the files. To avoid an inconsistent backup, do not make any configuration changes until the backup is completed. To ensure that no changes are made in the Oracle WebLogic Server Domain, lock the WebLogic Server configuration.

Online Transaction Processing (OLTP)

See OLTP.

OPMN

Oracle Process Manager and Notification Server. A process management tool that manages all system components (server processes), and supports both local and distributed process management, automatic process recycling and the communication of process state (up, down, starting, stopping). OPMN detects process unavailability and automatically restarts processes).

Oracle Database Vault (ODV)

See ODV.

Oracle Diagnostic Logging (ODL)

See ODL.

Oracle Process Manager and Notification Server (OPMN)

See OPMN.

Oracle Real Application Clusters (RAC)

See RAC.

Oracle WebLogic Server domain

The basic administration unit for WebLogic Server instances. A domain consists of one or more WebLogic Server instances (and their associated resources) that you manage with a single Administration Server. You can define multiple domains based on different system administrators' responsibilities, application boundaries, or geographical locations of servers. Conversely, you can use a single domain to centralize all WebLogic Server administration activities.

Oracle WebLogic Scripting Tool (WLST)

See WLST.

PEM

Privacy-enhanced Electronic Mail. An encryption technique that provides encryption, authentication, message integrity, and key management.

personally Identifiable Information (PII)

See PII

PGA

Program Global Area. A memory buffer that contains data and control information for a server process. A PGA is created when a server process is started.

PII

Personally identifiable information. Information that can be used to uniquely identify, contact, or locate a single person or can be used with other sources to uniquely identify an individual.

post-processing function (PPF)

See PPF.

PPF

Post-processing function. This is a special case of a user-defined function. A post processing function is called after the mask value is generated using the specified format. The function takes the generated mask value and further modifies it to produce the actual mask value.

Privacy-enhanced Electronic Mail (PEM)

See PEM.

privilege

Entitlement (or permission set).

product family

Combinations of one or more Java EE applications specific to Oracle Fusion Applications.

product offering

Groups of features within an installation of Oracle Fusion Applications which represent the highest-level collection of functionality that you can license and implement.

Program Global Area (PGA)

See PGA.

provisioning

The entire set of operations required to install, configure, and deploy applications product offerings from a system point of view. It performs these operations:

- Installation provides the operations related to laying down all the component needed to create an Oracle Fusion Applications environment.

- Configuration tailors components based on the applications topology, the creation of Oracle WebLogic Server Managed Servers and clusters, and the updating of endpoints and virtual hosts.

- Deployment starts the Managed Servers and clusters and facilitates the actual use of product offerings.

purge policies

Allow the scheduling service to remove scheduled jobs according to specified criteria. For example, a purge policy might specify the retention of all Java type job requests using a particular job definition submitted executed by a given application for three days. Another purge policy might retain a particular type of job request, say, all SQL job requests in a successful state, for only one day. You can also specify the frequency at which the purge policy is to run.

query optimizer

Determines the best and most efficient way to retrieve the results of an SQL statement. It compares the cost of all possible approaches and chooses the approach with the least cost. The query optimizer is responsible for generating an execution plan.

RAC

Real Application Clusters. Oracle RAC allows the Oracle Database to run any packaged or custom application across a set of clustered servers. This capability provides the highest levels of availability and the most flexible scalability. If a clustered server fails, Oracle Database continues running on the surviving servers. When more processing power is needed, you can add another server without interrupting access to data.

RCU

Repository Creation Utility. Oracle Fusion Applications RCU is a utility that loads applications and middleware content into the database. The process of running Applications RCU creates the applications and middleware schemas, loads seed data, and creates the tablespaces, as well as other required packages.

RDA

Remote Diagnostic Agent. Provides a suite of data collection and diagnostic scripts that aid in the analysis and support of Oracle products.

Recovery Manager (RMAN)

See RMAN.

Remote Diagnostic Agent (RDA)

See RDA.

Repository Creation Utility (RCU)

See RCU.

RMAN

Recovery Manager. You can use Oracle Recovery Manager to recover database-based metadata repositories and Oracle Fusion Applications Databases.

SAML

Security Assertion Markup Language. Defines a framework for exchanging security information between online business partners.

SBC

Session Border Controller. A piece of equipment that is deployed at the border of the network and controls the signaling and media across network address translation (NAT) devices and firewall boundaries. In addition, it prevents unauthorized access and denial of service (DoS) attacks.

Security Assertion Markup Language (SAML)

See SAML.

Secure Socket Layer (SSL)

See SSL.

server parameter file

A binary file that can be written to and read by the database. It must not be edited manually. It is stored on the host system on which Oracle Database is running. Changes are made when you use Database Control to modify one or more initialization parameters, or when Oracle Database itself makes changes for self-tuning purposes. Any changes to it persist across database shutdown and startup operations.

Service-Oriented Architecture (SOA)

See SOA.

Session Border Controller (SBC)

See SBC.

SGA

System Global Area. A group of shared memory structures that contains data and control information for one Oracle Database instance. If multiple users are concurrently connected to the same instance, the data in the instance SGA is shared among the users. Consequently, the SGA is sometimes referred to as the shared global area. The combination of the background processes and memory buffers is called an Oracle instance.

Simple Object Access Protocol (SOAP)

See SOAP.

snapshot (in Content Movement)

An image of a Fusion Applications instance at a moment in time, which can be used as the source for a content movement.Used in the Enterprise Manager Cloud Control interface.

SOA

Service-Oriented Architecture. A design methodology aimed at maximizing the reuse of application services.

SOAP

Simple Object Access Protocol. A protocol for sending and receiving requests and responses across the Internet. It is based on XML and simple transport protocols, so it is not blocked by firewalls. SOAP is independent of operating system, implementation language, or any single object model.

SSL

Secure Socket Layer. An industry standard protocol designed by Netscape Communications Corporation for securing network connections. SSL provides authentication, encryption, and data integrity using public key infrastructure (PKI).

standard binding mode

The default mode of binding a work assignment to a request processor. Standard binding mode allows the request processor to process job requests as defined by the specialization rules when an active workshift is defined. If a job request is specialized to two different work assignments, either of those work assignments or the default work assignment can process the job request.

System Global Area (SGA)

See SGA.

task role

See duty role.

TDE

Transparent Data Encryption. TDE prevents access to PII in the file system or on backups or disk. It also protects confidential data, such as credit card and social security numbers. TDE also encrypts sensitive table data stored in data files at the tablespace level.

Thread ID (TID)

See TID

TID

Thread ID. A unique identifier for the thread within the java process where the message was generated.

Transparent Data Encryption (TDE)

See TDE.

UDF

User-Defined Function. Takes the original value, the row id, and column name to generate the mask value. A single column format can be a combination of one or more formats including UDF.

User-Defined Function (UDF)

See UDF.

Virtual Private Database (VPD)

See VPD.

VPD

Virtual Private Database. A feature for ASPs that want to leverage the Oracle database to host their customers. Essentially, it uses one physical database instance for all customers, but to each customer it looks as if they have their own database. Users cannot see any information that is not meant for them and complete customer isolation is achieved. It requires little to no changes in the core application to take effect as most of the work is done at the database level. Implementing VPD basically requires two key steps: adding a context column (for example, company name) to all the database tables, and implementing a policy to restrict queries on each table based on the context of the logged in user. VPD provides highly secure, full subscriber isolation using this method.

WLST

Oracle WebLogic Scripting Tool. A command line tool for managing Oracle Fusion Middleware components, such as Oracle WebCenter.

work allocation

The process of defining constraints on where and when jobs run as well as the amount of resources that can be used to process the jobs. This process includes creating a work assignment, and the binding the work assignment to a request processor.

work assignments

Rules that govern the execution and binding of jobs to a particular server and request processor.

workshift

Temporal window of time during which jobs can processed and what resources can be used during those periods. The resources defined in a workshift include threads, which are a local resource of the request processor, and asynchronous workers, a global resource. The number of asynchronous workers can be specified to throttle the use of a shared global resource, such as database jobs.

XA transaction

An XA transaction is a global transaction that may span multiple resources.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2014, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

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.

License Restrictions Warranty/Consequential Damages Disclaimer

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.

Warranty Disclaimer

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.

Restricted Rights Notice

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 END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

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.

Third-Party Content, Products, and Services Disclaimer

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.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.