You are on page 1of 132

Oracle CRM System Administrator Console

Concepts and Procedures

11i

July 2002 Part No. A97637-01

A guide to using and understanding the CRM System Administrator Console, which is the Web-based user interface to the CRM Technology Foundation.

Oracle CRM System Administrator Console Concepts and Procedures, 11i Part No. A97637-01 Copyright 1996, 2002, Oracle Corporation. All rights reserved. Primary Author: Michelle Cheng

The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent and other intellectual and industrial property laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation. If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the Programs. Oracle is a registered trademark of Oracle Corporation. Other names may be trademarks of their respective owners.

Contents
Send Us Your Comments ................................................................................................................... ix Preface............................................................................................................................................................ xi
Intended Audience ................................................................................................................................ xi Documentation Accessibility ............................................................................................................... xi Structure.................................................................................................................................................. xi Related Documents............................................................................................................................... xiii

Understanding the System Administrator Console


1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 System Administrator Console Overview......................................................................... Understanding Security........................................................................................................ Understanding the Interapplication Bar ............................................................................ Understanding Diagnostics ................................................................................................. Understanding Cache ........................................................................................................... Understanding XML Services.............................................................................................. Understanding Declarative Page Flows............................................................................. Understanding Declarative Components ........................................................................ 1-1 1-2 1-3 1-4 1-5 1-6 1-8 1-10

2 Using the Security Subtab


2.1 2.2 2.3 2.4 2.5 Managing Security ................................................................................................................ Managing Permissions ......................................................................................................... Creating Permissions ............................................................................................................ Assigning a Permission to Roles ......................................................................................... Managing Roles ..................................................................................................................... 2-1 2-1 2-2 2-3 2-4

iii

2.6 2.7

Creating Roles ........................................................................................................................ 2-5 Mapping Permissions to a Role ........................................................................................... 2-5

3 Using the Site Preferences Subtab


3.1 3.2 3.3 Setting Up the Interapplication Bar .................................................................................... 3-1 Setting Up Navigation Groups ............................................................................................ 3-1 Editing Navigation Group Details ...................................................................................... 3-2

4 Using the System Subtab


4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10 4.11 4.12 4.13 4.14 4.15 Using the System Subtab ...................................................................................................... Setting Up Sessions ............................................................................................................... Setting Up Cookies ................................................................................................................ Setting Up Branding.............................................................................................................. Setting Up the Self Service User .......................................................................................... Setting Up Property Categories........................................................................................... Setting Up Password Expiration ......................................................................................... Managing Properties............................................................................................................. Editing the Details of Keys................................................................................................... Setting Up Debug Logging................................................................................................... Viewing the Debug Log........................................................................................................ Setting Up Page Flow Logging .......................................................................................... Viewing Page Flow Logging Reports ............................................................................... Migrating Page Flow Data ................................................................................................. Setting Page Flow Buffer Size and Flush Interval........................................................... 4-1 4-1 4-3 4-3 4-4 4-5 4-6 4-6 4-6 4-7 4-9 4-10 4-11 4-12 4-13

5 Using the Deployment Tab


5.1 5.2 5.3 5.4 5.5 5.6 Viewing System Alerts.......................................................................................................... Viewing Jserv Statistics......................................................................................................... Managing Configuration ...................................................................................................... Setting Up Hosts .................................................................................................................... Editing Host Details .............................................................................................................. Editing Resource Settings..................................................................................................... 5-1 5-2 5-2 5-2 5-3 5-4

iv

6 Using the Diagnostics Framework


6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 6.11 6.12 6.13 6.14 Using Diagnostics.................................................................................................................. Running Test Groups............................................................................................................ Running All Test Groups ..................................................................................................... Running One Test Group ..................................................................................................... Running Tests ........................................................................................................................ Managing Test Groups ......................................................................................................... Creating Test Groups............................................................................................................ Updating Test Groups .......................................................................................................... Managing Tests...................................................................................................................... Registering Tests.................................................................................................................... Setting Default Test Input Values ....................................................................................... Managing Applications ........................................................................................................ Registering Applications ...................................................................................................... Editing Application Prerequisites....................................................................................... 6-1 6-2 6-2 6-3 6-3 6-4 6-5 6-5 6-6 6-7 6-7 6-8 6-8 6-9

7 Using the Cache Subtab


7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 7.9 7.10 7.11 7.12 Using Cache ........................................................................................................................... Managing Cache Policies ..................................................................................................... Editing Cache Policy Details................................................................................................ Managing Cache Filters ........................................................................................................ Viewing Cache Filter Details ............................................................................................... Creating and Editing Cache Filters..................................................................................... Step 1: Editing Basic Information........................................................................................ Step 2: Choosing Responsibilities ....................................................................................... Step 3: Choosing Languages ................................................................................................ Managing Component Caches ............................................................................................ Editing Component Cache Details...................................................................................... Viewing Cache Statistics ...................................................................................................... 7-1 7-1 7-2 7-3 7-4 7-4 7-4 7-5 7-6 7-6 7-7 7-9

8 Using the XML Integration Subtab


8.1 8.2 8.3 Using XML Services .............................................................................................................. 8-1 Managing Service Groups.................................................................................................... 8-2 Editing the General Settings of New Service Groups ...................................................... 8-2

8.4 8.5 8.6 8.7 8.8 8.9 8.10 8.11 8.12 8.13 8.14 8.15

Editing the Services of New Service Groups ..................................................................... Editing the Type Mappings of New Service Groups ....................................................... Updating the General Settings of Service Groups ............................................................ Updating the Services of Service Groups........................................................................... Updating the Type Mappings of Service Groups ............................................................. Managing Invocations .......................................................................................................... Creating Invocations ............................................................................................................. Updating Invocations............................................................................................................ Managing Authentication Profiles .................................................................................... Creating Authentication Profiles....................................................................................... Updating Authentication Profiles ..................................................................................... Managing Events .................................................................................................................

8-3 8-4 8-4 8-5 8-5 8-6 8-7 8-9 8-10 8-11 8-12 8-12

9 Using the Declarative Page Flows Subtab


9.1 9.2 9.3 9.4 9.5 9.6 9.7 9.8 9.9 9.10 9.11 9.12 9.13 9.14 Using Declarative Page Flows ............................................................................................. Managing Physical Pages ..................................................................................................... Editing Physical Page Details .............................................................................................. Managing Logical Pages....................................................................................................... Editing Logical Page Details ................................................................................................ Managing Rules ..................................................................................................................... Editing Rule Details............................................................................................................... Managing Business Flows .................................................................................................... Editing Business Flow Details ............................................................................................. Creating a New Business Flow............................................................................................ Updating an Existing Business Flow ................................................................................ Creating Flow Branches...................................................................................................... Duplicating Business Flows ............................................................................................... Viewing Flow Versions....................................................................................................... 9-1 9-2 9-2 9-3 9-4 9-5 9-6 9-7 9-9 9-9 9-10 9-11 9-12 9-13

10

Using the Declarative Components Subtab


10.1 10.2 10.3 10.4 10.5 Using Declarative Components......................................................................................... Managing Components ...................................................................................................... Previewing Components .................................................................................................... Registering Components .................................................................................................... Editing Component Metadata ........................................................................................... 10-1 10-2 10-3 10-4 10-5

vi

10.6 10.7 10.8 10.9 10.10 10.11 10.12 10.13 10.14 10.15 10.16 10.17 10.18 10.19

Defining Bin or Report Columns ...................................................................................... Editing Bin or Report Column Details ............................................................................. Managing LOV Columns ................................................................................................. Editing LOV Column Details........................................................................................... Defining Graph Metadata ................................................................................................ Managing Graph Columns .............................................................................................. Editing Graph Column Details........................................................................................ Managing Parameters ....................................................................................................... Editing Parameter Metadata............................................................................................ Managing Component Security ...................................................................................... Assigning a Component to Responsibilities.................................................................. Selecting Responsibilities ................................................................................................. Assigning a Responsibility to Components .................................................................. Selecting Components ......................................................................................................

10-8 10-9 10-10 10-12 10-14 10-16 10-17 10-18 10-19 10-21 10-22 10-22 10-23 10-24

11

Using the Homepage Subtab


11.1 Configuring Default Homepages...................................................................................... 11-1

12

Setting Profile Options


12.1 12.2 12.3 12.4 12.5 12.6 12.7 Setting Navigation Preferences ......................................................................................... Setting Display Preferences ............................................................................................... Setting Up the Quick Menu ............................................................................................... Changing Your Password .................................................................................................. Setting Personal Information ............................................................................................. Setting Address Information ............................................................................................. Viewing Quick Find Search Results ................................................................................. 12-1 12-1 12-2 12-2 12-3 12-3 12-3

vii

viii

Send Us Your Comments


Oracle CRM System Administrator Console Concepts and Procedures, 11i
Part No. A97637-01

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this document. Your input is an important part of the information used for revision.

Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most?

If you find any errors or have any other suggestions for improvement, please indicate the document title and part number, and the chapter, section, and page number (if available). You can send comments to us in the following ways:

Electronic mail: crmftech@us.oracle.com FAX: (650) 654-6238 Attn: Oracle CRM Technology Foundation Postal service: Oracle Corporation Oracle CRM Technology Foundation Documentation 500 Oracle Parkway, M/S 6op9 Redwood Shores, CA 94065 USA

If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address. If you have problems with the software, please contact your local Oracle Support Services.

ix

Preface
Intended Audience
This guide is intended for system administrators, implementation engineers, and any other users who need to use the CRM System Administrator Console effectively.

Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle Corporation is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Structure
This guide is organized into 12 chapters. Brief overviews of each chapter are provided below: Chapter 1 Understanding the System Administrator Console This chapter contains descriptions of concepts and terms that are used in the System Administrator Console.

xi

Chapter 2 Using the Security Subtab This chapter contains instructions on how to perform tasks in the Security subtab of the System Administrator Console, such as creating permissions and assigning them to roles. Chapter 3 Using the Site Preferences Subtab This chapter contains instructions on how to perform tasks in the Site Preferences subtab of the System Administrator Console, such as setting up navigation groups. Chapter 4 Using the System Subtab This chapter contains instructions on how to perform tasks in the System subtab of the System Administrator Console, such as viewing the debug log or setting up cookies. Chapter 5 Using the Deployment Tab This chapter contains instructions on how to perform tasks in the Deployment tab of the System Administrator Console, such as setting up hosts. Chapter 6 Using the Diagnostics Framework This chapter contains instructions on how to perform tasks in the Diagnostics Framework, such as running tests. Chapter 7 Using the Cache Subtab This chapter contains instructions on how to perform tasks in the Cache subtab of the System Administrator Console, such as managing cache policies. Chapter 8 Using the XML Integration Subtab This chapter contains instructions on how to perform tasks in the XML Integration subtab of the System Administrator Console, such as managing service groups and invocations. Chapter 9 Using the Declarative Page Flows Subtab This chapter contains instructions on how to perform tasks in the Declarative Page Flows subtab of the System Administrator Console, such as creating business flows.

xii

Chapter 10 Using the Declarative Components Subtab This chapter contains instructions on how to perform tasks in the Declarative Components subtab of the System Administrator Console, such as designing customizable graphs and reports. Chapter 11 Using the Homepage Subtab This chapter contains instructions on how to configure default homepages through the Homepage subtab of the System Administrator Console. Chapter 12 Setting Profile Options This chapter contains instructions on how to set profile options through the Profile button of the System Administrator Console, such as selecting the display language or turning on the Quick Menu feature.

Related Documents
Where to Find User Management Documentation Please be advised that one of the tabs of the System Administrator Console is not documented in this manual. Please refer to the following paragraph for details: The Users tab in the System Administrator Console enables administrators to register users and to set up the User Management framework. The Registration menu in the main navigation bar enables administrators to manage approvals, and to setup, modify, or delete users. The Setup menu in the main navigation bar enables administrators to create and manage approvals, enrollments, user types, and templates. The User Management chapter in the Oracle CRM Application Foundation User Guide (July 2002 part number: A97632-01) provides detailed instructions for performing all of the available functions in the Users tab. The User Management chapter in the Oracle CRM Application Foundation Implementation Guide (July 2002 part number: A97631-01) provides a conceptual overview of User Management and instructions for implementing the product.

xiii

xiv

1
Understanding the System Administrator Console
This topic group provides overviews of the System Administrator Console and its components as well as explanations of certain key concepts, features, and functions. For a general introduction, please see the topic System Administrator Console Overview.

1.1 System Administrator Console Overview


The System Administrator Console is a Web-based user interface that is associated with the system administrator responsibility for the purposes of CRM Technology Foundation setup, diagnostics, performance tuning, application integration, and application design. The System Administrator Console is instrumental during the development, implementation, and maintenance phases of an application or deployment. During the development phase, developers and consultants use the CRM System Administrator Console to seed out-of-the-box capabilities and features. These include, but are not limited to, users, permissions, roles, session parameters, page flows, bins, reports, graphs, XML invocations, XML services, diagnostics tests, and caching policies. During the implementation phase, consultants use the CRM System Administrator Console to configure out-of-the-box capabilities and features to meet the particular needs of each customer deployment. Furthermore, consultants can use the same features to extend applications or integrate them with other customer applications. During the maintenance phase, IT professionals use the CRM System Administrator Console to troubleshoot deployment problems, tune deployment performance, and monitor system activity.

Understanding the System Administrator Console

1-1

Understanding Security

See the following help topics for overviews of some of the key concepts of the System Administrator Console: Understanding Security Understanding the Interapplication Bar Understanding Diagnostics Understanding Cache Understanding XML Services Understanding Declarative Page Flows Understanding Declarative Components

1.2 Understanding Security


In the Security subtab, which is located under the Settings tab, you can control access to application resources and view security-related alerts. Read this section to understand the key concepts of the Security framework. For step-by-step instructions on how to use the Security screens, please see the topic Managing Security.

1.2.1 What Are Permissions and Roles?


A permission is a unit of privilege that is granted to a user. It usually serves to grant a certain type of access to a resource. Resources are application elements such as JSP pages, objects, or methods of objects. A resource can have unique permissions for each way that it can be accessed. A permission is implemented as a string. If a resource is protected by a permission, then any user accessing the resource must have the permission required to access it. Permissions cannot be directly assigned to users. Instead, permissions are grouped into roles and roles are then assigned to users. A role is also implemented as a string. For example, lets suppose there is a JSP page "abc.jsp" that requires the permission "PERM_ABC." A user logs in and tries to access abc.jsp, but he or she can't do that unless he or she has permission "PERM_ABC." You want the user to be able to access the page, so you assign the role "ROLE_ABC" (which contains permission "PERM_ABC") to the user. Once given the appropriate role, the user will be able to access the page.

1-2

Oracle CRM System Administrator Console Concepts and Procedures

Understanding the Interapplication Bar

Note: Permission names are case sensitive, while role names are

not. In the Security subtab, you can view, create, and delete permissions and roles. You can also specify which permissions are mapped to each role, and vice versa.

1.3 Understanding the Interapplication Bar


In the Site Preferences subtab, which is located under the Settings tab, you can set up the Interapplication Bar. Read this section to understand the key concepts of the Interapplication Bar. For step-by-step instructions on how to use the Interapplication Bar screens, please see the topic Setting Up the Interapplication Bar.

1.3.1 What Is the Interapplication Bar?


The Interapplication Bar (also sometimes referred to as the Application Switcher) allows end users to seamlessly switch between applications within the E-Business Suite. It is a set of customizable links that displays at the top of every page in HTML-based CRM applications. Each customizable link is called a "navigation group." For example, a system administrator might want to create a navigation group called "Sales." In the System Administrator Console, he or she can map sales-related applications such as Sales Online, TeleSales, and Sales Compensation to the navigation group called "Sales." (Similarly, he or she could create a navigation group called "Marketing" and map applications such as Marketing Online, iMarketing, and Campaign Management to it.) When an end user logs in who has responsibilities for sales applications, the end user will see "Sales" as a link in the Interapplication Bar. In the Profile screens, the end user can configure which responsibility he or she wants to associate with the "Sales" navigation group. From then on, when the end user is working in the E-Business Suite, he or she can click the "Sales" link at any time to easily switch to his or her sales responsibility.

1.3.2 What Is a Navigation Group?


A navigation group is a customizable group of applications with defined responsibility settings. Each navigation group is represented as a link within the

Understanding the System Administrator Console

1-3

Understanding Diagnostics

Interapplication Bar. In the Site Preferences subtab, you (as the system administrator) can map CRM applications into navigation groups. Additionally, from the navigation group setup screen, you can create, delete, activate, deactivate, and specify the display order of navigation groups. After you have set up navigation groups for a deployment, based on their granted responsibilities, end users will be able to associate each navigation group with one of their responsibilities.

1.4 Understanding Diagnostics


The interface for the CRM Technology Foundation Diagnostics framework is launched when you click the Diagnostics tab of the System Administrator Console. It allows you to troubleshoot any setup and installation problems of the technology foundation and certain participating applications. Additionally, it allows you to register and employ new diagnostic tests. The Diagnostics screens allow you to run test groups, run individual tests, manage test groups, manage tests, set default test input values, and register applications. Read this section to understand the key concepts of the Diagnostics framework. For step-by-step instructions on how to use the Diagnostics screens, please see Using Diagnostics.
Note: The following URL can also be used to access the

Diagnostics screens: http://<hostname>:<portnumber>/OA_HTML/jtfqalgn.htm

1.4.1 What Is a Test?


A test is a Java test that verifies the correct behavior of a particular feature or function. In the Diagnostics screens, you can run, register, delete, and set default input values for tests.

1.4.2 What Is a Test Group?


A test group is a set of related tests. A test group may have other test groups defined as prerequisites. In the Diagnostics screens, you can run, create, modify, and remove test groups.

1-4

Oracle CRM System Administrator Console Concepts and Procedures

Understanding Cache

1.4.3 What Is a Prerequisite?


Prerequisites are a concept that applies to both applications and test groups. Setting prerequisites is sometimes necessary for procedures to execute correctly. For example, the DBConnections test group has the Environment Setup test group set as its prerequisite, because the Environment Setup test group contains the DBC Parameter test which checks the DBC file. If the DBC Parameter test fails, the no tests in the DBConnections test group will be successful. In addition, the CRM Foundation application has the HTML Platform application set as its prerequisite. If some tests in the CRM Foundation fail, it is likely due to an error in the HTML Platform. Therefore you can run the HTML Platform tests to trace the problem. The Diagnostics interface offers screens that allow you to define prerequisites for applications as well as test groups.

1.5 Understanding Cache


In the Cache subtab, which is located under the Performance tab, you can manage cache-related settings. Read this section to understand the key concepts of the cache. For step-by-step instructions on how to use the cache screens, please see Using Cache.

1.5.1 Cache Concepts and Features


The following table describes the key concepts and features of the Cache.
Term Cache Definition A data structure that holds frequently used Java objects. It is composed of component caches. A component cache holds all the Java objects belonging to an application component. An application component pertains to specific application functionality. In the Cache subtab, manage cache policies, manage cache filters, manage component caches, and view cache statistics. Elsewhere in the Resource Settings subtab, you can set the maximum size of the cache.

Understanding the System Administrator Console

1-5

Understanding XML Services

Term Policy

Definition A setting that applies to an application running on a host. The policy types are Cache Only, Cache and Priming, Disabled, and Custom. In the Cache subtab, you can set up cache policies.

Filter Component Cache

An application-specific component that indicates what responsibility IDs and language codes to prime for. A data structure that holds the Java objects of an application module pertaining to a specific application functionality. For example, Catalog and MenuRenderer are components that have component caches. In the Cache subtab, you can view, create, modify, and remove component caches.

Statistics

A dedicated screen under the Cache subtab offers a display of component cache performance metrics.

1.6 Understanding XML Services


In the XML Integration subtab, which is located under the Integration tab, you can set up and manage XML Services. The XML Services screens allow you to manage Service Groups, Authentication Profiles, and Invocations. Read this section to understand the basic concepts of XML Services. For step-by-step instructions on how to use the XML Services screens, please see Using XML Services.

1.6.1 What Is the XML Services Framework?


XML Services provides a framework for the deployment, management, and runtime execution of Web Services. Using the framework, developers can abstract application functionality as Key Integration Points (KIPs). KIPs are exposed to the Internet as Web Services. These services can be invoked using SOAP-based XML messages by any authorized source. The XML Services framework also allows an application to abstract Invocation Points in order to make use of the Web Services published by another application. The XML Services framework provides a level of abstraction that hides the details associated with SOAP-based messages. This lets developers focus on the Services they are developing and publishing. It also takes care of the authorization model for users to access these Services.

1-6

Oracle CRM System Administrator Console Concepts and Procedures

Understanding XML Services

The runtime process flow for service invocation is as follows:


1.

The application invokes a Service using either the synchronous or asynchronous XML Services Client API in Java. The application supplies the invocation name along with the list of parameters to invoke the Service. XML Services looks up invocation metadata and calls the SOAP API with the endpoint information and the parameter list supplied by the application. In addition to endpoint information [URL, Service group name (class), and Service name (method)], the metadata also includes authentication information (username/password). This information is also part of the SOAP message. SOAP marshals the data into a SOAP request message. (This is XML.) If the application uses the synchronous XML Services Client API in step 1, then the SOAP request message is sent through the corresponding transport adapter (for instance, HTTP). On the other hand, if the application uses the asynchronous XML Service Client API in step 1, then the SOAP request message is first buffered in an internal persistent store. This SOAP message is later transmitted via the corresponding transport adapter. The SOAP server on the receiving end gets the SOAP message from the transport protocol. The SOAP server unmarshals the message, calls the XML Services API, and supplies the authentication information, Service group name (class), Service name (method), and list of parameters to it. XML Services looks up the Services metadata (including the invoker credential) and invokes the Service if invoker is authorized to do so.

2.

3. 4.

5. 6.

7.

The reply process flow is the same but in the reverse direction.

1.6.2 XML Services Concepts and Features


The following table summarizes the key concepts and features of the XML Services framework.

Understanding the System Administrator Console

1-7

Understanding Declarative Page Flows

Term Services

Definition AKA Web Services. Logically speaking, they are single units of work with well-defined inputs and outputs. They are implemented as methods of Java classes. Services are application specific and usually represent a unit of business logic. In the XML Services subtab, you can enable and disable Services within Service Groups.

Service Group

The logical name of a Java class that contains methods exposed as services. In the XML Services subtab, you can view, create, modify, and delete Service Groups.

Authentication Profile

Tells an invocation what host, user name, and password to use. In the XML Services subtab, you can view, create, modify, and delete Authentication Profiles.

Invocation

The logical name of a connection that calls a service on a remote host. In the XML Services subtab, you can view, create, modify, and delete Invocations.

1.7 Understanding Declarative Page Flows


In the Declarative Page Flow subtab, which is located under the Design tab, you can set up and manage the components of the Declarative Page Flows framework: Physical Pages, Logical Pages, Rules, and Business Flows. Read this section to understand the basic concepts of the Declarative Page Flows framework. For step-by-step instructions on how to use the Declarative Page Flows screens, please see Using Declarative Page Flows.

1.7.1 Declarative Page Flows Overview


The Declarative Page Flows framework enables you to customize, upgrade, and troubleshoot the content and flow of JSPs within an application without making any modifications to actual code. The Declarative Page Flows framework is based on the abstraction of JSPs into named logical entities. Consequently, you can achieve efficient management of content and flows by utilizing the screens provided in the System Administrator Console.

1-8

Oracle CRM System Administrator Console Concepts and Procedures

Understanding Declarative Page Flows

1.7.2 Declarative Page Flows Concepts and Features


The following table describes the key concepts and features of Declarative Page Flows.
Term Physical Page Definition The name of a JavaServer Page (JSP). In the Declarative Flows subtab, you can view, register, and modify Physical Pages. Logical Page A named logical entity that has one or more Physical Pages mapped to it. Usually, each Logical Page represents a node within a Business Flow. In the Declarative Flows subtab, you can view, create, and modify Logical Pages. Rule A rule is defined by parameters and conditions and determines which Physical Page needs to be rendered or which Logical Page needs to display next. Rules evaluate to true when all of their conditions evaluate to true. You can utilize Rules to customize the page-to-page behavior of a Business Flow. In the Declarative Flows subtab, you can view, create, and modify Rules. Business Flow A sequential set of linked Logical Pages that usually corresponds to a business task. Business Flows can be linear or nonlinear, depending on whether or not there are context-sensitive conditions. Branching conditions are evaluated at each node. In the Declarative Flows subtab, you can view, create, modify, clone, and preview Business Flows. Flow Cloning In order to facilitate the easy upgrade of business flows which have been customized by a customer, a business flow can be cloned, thus creating a Flow Family of related business flows. In the Declarative Flows subtab, the Clone Flow screen allows you to generate duplicates of a given flow. Flow Versions A flow family consists of an original business flow, a clone of the original business flow, and any customized clones which have been made. In the Declarative Flows subtab, the Flow Families screen allows you to view the contents of a Flow Family and select which flow is active.

Understanding the System Administrator Console

1-9

Understanding Declarative Components

1.8 Understanding Declarative Components


In the Declarative Components subtab, which is located under the Design tab, you can create and manage declarative UI components (Bins, Graphs, Reports, Graph/Report combinations, and LOVs) and their security settings. Read this section to understand the basic concepts involved in setting up and using Declarative Components. For step-by-step instructions on how to use the Declarative Components screens, please see Using Declarative Components.

1.8.1 Declarative Components Overview


The Declarative Components framework allows you to quickly build UI components that display application-specific data in personalizable Bins, Graphs, Reports, Graph/Reports, or LOVs. The coding requirements are minimal to nonexistent and the components can be published on Oracle applications.

1.8.2 Declarative Components Concepts and Features


The following table describes the key concepts and features of Declarative Components.
Term Metadata Definition The Declarative Components framework relies on the accurate definition of metadata. The framework uses the metadata to capture information about component headers, footers, columns, and other attributes. In the Declarative Components subtab, you can define the metadata for bins, reports, graphs, graph/report combinations, LOVs, and parameters. Bin Bins are small reports which display high level summary information in a tabular format. They generally display information regarding a single metric, such as "time period." If enabled and the appropriate security features are assigned, you can choose which bins to display on the home page and also choose the order in which multiple bins are displayed. In the Declarative Components subtab, you can view, create, modify, and remove Bins.

1-10

Oracle CRM System Administrator Console Concepts and Procedures

Understanding Declarative Components

Term Report

Definition Reports are similar to bins. They display information in a tabular format. In the Declarative Components subtab, you can view, create, modify, and remove Reports. Optionally, you can do the same for Graph/Report combinations.

Graph

A graph is a diagram that represents data pictorially. In the Declarative Components subtab, you can view, create, modify, and remove Graphs. Optionally, you can do the same for Graph/Report combinations.

LOV

The LOVs that you create can be used across applications. LOV means "list of values." It is a UI component that facilitates the completion of a text entry field when there are numerous values that may be assigned. LOVs are a useful alternative to drop-down lists, particularly in cases where displaying a long list of selections in a drop-down list would require excessive scrolling. In short, when using a LOV to complete a text entry field, you type a query into the field and then click a button labeled "Go." This opens a screen where you view a list of values that match the query you submitted. You can then select the value that you desire and return to the original screen, where what you selected will populate the original text entry field. In the Declarative Components subtab, you can view, create, modify, and remove LOVs.

Understanding the System Administrator Console

1-11

Understanding Declarative Components

1-12

Oracle CRM System Administrator Console Concepts and Procedures

2
Using the Security Subtab
2.1 Managing Security
You can perform the following tasks from the Security subtab:

Viewing Security Alerts Managing Permissions Creating Permissions Assigning a Permission to Roles

Managing Roles Creating Roles Mapping Permissions to a Role

For an introduction to Security concepts, please see Understanding Security.

2.2 Managing Permissions


Use this procedure to manage permissions. A permission has a name and a description. For an introduction to permissions and roles, please see Understanding Security.
WARNING! Do not remove the predefined permissions that are built into the System Administrator Console. These predefined permissions are essential for stable and reliable performance of all Oracle CRM modules. Removal of these permissions could cause serious or fatal performance problems.

Using the Security Subtab

2-1

Creating Permissions

Steps
1. 2. 3.

In the Settings tab, navigate to Security > Access Controls > Permissions. If you want to create a new permission, then click Create. This opens the page where you edit the details of a new permission. If you want to search for a permission, then:
a. b.

Type a search phrase into the Find Permission field. Click Go to display the search results.

4.

To change which rows display in the table, you have the following options:
a. b.

Click the Previous or Next buttons. Choose an entry range from the drop-down list.

5. 6.

If you want to assign a permission to roles, then click the name of a permission in the table. This opens the page where you assign a permission to roles. If you want to delete a permission, then:
a. b.

Select the appropriate check box in the Remove column of the table. Click Update to save. The permission is removed.

Related Procedures
Creating Permissions Assigning a Permission to Roles Managing Security

2.3 Creating Permissions


Use this procedure to create a new permission.For an introduction to permissions and roles, please see Understanding Security.

Steps
1. 2.

In the Settings tab, navigate to Security > Access Controls > Permissions, then click Create. Type a new permission name into the Name field. The first two or three letters of a permission name correspond to the module shortcode. Permission names must be unique.

2-2

Oracle CRM System Administrator Console Concepts and Procedures

Assigning a Permission to Roles

3. 4.

Type a description of the permission into the Description field. Click Create to save your work. The new permission is filed in alphabetical order.

Related Procedures
Managing Permissions Assigning a Permission to Roles Managing Security

2.4 Assigning a Permission to Roles


Use this procedure to assign a permission to one or more roles. For an introduction to permissions and roles, please see Understanding Security.

Steps
1. 2. 3. 4. 5. 6. 7.

In the Settings tab, navigate to Security > Access Controls > Permissions, then click the name of a permission in the table. Choose the name of a role in one list and click > or < to move it to the other list. Repeat step 2 as desired. If you want to move all items from the Available Roles list to the Assigned Roles list, then click >>. This assigns the permission to all roles. If you want to move all items from the Assigned Roles list to the Available Roles list, then click <<. This removes the permission from all roles. Optionally, click Restore to reset the fields to their original values. Click Update to save. The permission will be assigned to the roles specified in the Assigned Roles list.

Related Procedures
Creating Permissions Managing Permissions Managing Security

Using the Security Subtab

2-3

Managing Roles

2.5 Managing Roles


Use this procedure to manage roles. A role is a grouping of one or more permissions. For an introduction to permissions and roles, please see Understanding Security.

Steps
1. 2. 3.

In the Settings tab, navigate to Security > Access Controls > Roles. If you want to create a new role, then click Create. This opens the page where you edit the details of a new role. If you want to search for a role, then:
a. b.

Type a search phrase into the Find Role field. Click Go to display the search results.

4.

To change which rows display in the table, you have the following options:
a. b.

Click the Previous or Next buttons. Choose an entry range from the drop-down list.

5.

If you want to map permissions to a particular role, then click an entry in the Name column of the table. This opens the page where you map permissions to a role. If you want to delete a role, then:
a.

6.

Select the appropriate check box in the Remove column of the table. If the check box is disabled, then you cannot remove the role. For example, seeded roles are not deleteable. Click Update to save. You will be asked to confirm that you want to delete the role. To cancel, click Cancel. To delete the role, click Update. The role is removed and revoked from all users who are assigned to the role.

b. c.

Related Procedures
Creating Roles Mapping Permissions to a Role Managing Security

2-4

Oracle CRM System Administrator Console Concepts and Procedures

Mapping Permissions to a Role

2.6 Creating Roles


Use this procedure to create a new role. For an introduction to permissions and roles, please see Understanding Security.

Steps
1. 2.

In the Settings tab, navigate to Security > Access Controls > Roles, then click Create. Type a new role name into the Name field. The first two or three letters of a role name correspond to the module shortcode. Role names must be unique.

3. 4.

Type a description of the role into the Description field. Click Create to save. The new role is filed in alphabetical order.

Related Procedures
Mapping Permissions to a Role Managing Roles Managing Security

2.7 Mapping Permissions to a Role


Use this procedure to map permissions to a role. A role is a grouping of one or more permissions. For an introduction to permissions and roles, please see Understanding Security.

Steps
1. 2. 3. 4. 5.

In the Settings tab, navigate to Security > Access Controls > Roles, then click the name of a role in the table. Choose the name of a permission in one list and click > or < to move it to the other list. Repeat step 2 as desired. If you want to move all items in the Available Permissions list to the Assigned Permissions list, then click >>. This assigns the role to all permissions. If you want to move all items in the Assigned Permissions list to the Available Permissions list, then click <<. This removes the role from all permissions.

Using the Security Subtab

2-5

Mapping Permissions to a Role

6.

Click Update to save.

Related Procedures
Creating Roles Managing Roles Managing Security.

2-6

Oracle CRM System Administrator Console Concepts and Procedures

3
Using the Site Preferences Subtab
3.1 Setting Up the Interapplication Bar
You can perform the following tasks from the Site Preferences subtab:

Setting Up Navigation Groups Editing Navigation Group Details

For an introduction to the Interapplication Bar, please see the topic Understanding the Interapplication Bar.

3.2 Setting Up Navigation Groups


Use the following procedure to set up navigation groups, which represent customizable sets of applications with defined responsibility settings. They act as links in the Interapplication Bar. The Interapplication Bar is the set of navigation groups that displays at the top of every page in HTML-based CRM applications. For an introduction to the Interapplication Bar, please see the topic Understanding the Interapplication Bar.

Steps
1. 2.

In the Settings tab, navigate to Site Preferences > Interapplication Bar > Navigation Group Setup. To create a new navigation group, do the following:
a. b.

Type a name and description into an empty row in the table. In the Status column, choose Active from the drop-down list if you want the navigation group to display in the Interapplication Bar. Choose Inactive if you do not want it to display.

Using the Site Preferences Subtab

3-1

Editing Navigation Group Details

c.

In the Display Order column, use the drop-down list to select the navigation groups placement in the Interapplication Bar. If a navigation group called "Sales" is has a display order of 0, one called "Marketing" has a display order of 1, and another called "Service" has a display order of 2, then the Interapplication Bar will look like the following: Sales Marketing Service, provided the end user has responsibilities within all three navigation groups. (For example, if the end user does not have any responsibilities for service applications, then he or she will not see Service.) (Note that if your deployment is in a language that reads from right to left, then 0 will set the navigation group at the far right hand side of the screen, and so on.)

d. e. 3. 4.

Click Update to save your work. Click the icon in the Detail column to map CRM applications to this navigation group.

To edit an existing navigation group, please see steps 2b - 1e. To delete a navigation group from the table, do the following:
a. a.

Select the check box in the Remove column that corresponds to the navigation group that you want to delete. Click Update.

Related Procedures
Editing Navigation Group Details

3.3 Editing Navigation Group Details


Use this procedure to map CRM applications to navigation groups. A navigation group is a customizable set of applications with defined responsibility settings that is launched when you click its link in the Interapplication Bar. The Interapplication Bar displays at the top of every page in HTML-based CRM applications. For an introduction to the Interapplication Bar, please see the topic Understanding the Interapplication Bar.

Steps
1.

There are two ways to access this page:

In the Settings tab, navigate to Site Preferences > Interapplication Bar > Navigation Group Details.

3-2

Oracle CRM System Administrator Console Concepts and Procedures

Editing Navigation Group Details

In the Settings tab, navigate to Site Preferences > Interapplication Bar > Navigation Group Setup, then click the icon in the Detail column that corresponds to the navigation group you are working with.

2.

If you came to this page by way of the first method above, then you will need to choose a navigation group from the drop-down list before you can begin selecting applications. Choose the name of an application in one list and click > or < to move it to the other list. Repeat step 3 as desired. If you want to move all Available Applications to the Selected Applications list, then click >>. If you want to move all Assigned Applications to the Selected Applications list, then click <<. Click Update to save.

3. 4. 5. 6. 7.

Related Procedures
Setting Up Navigation Groups

Using the Site Preferences Subtab

3-3

Editing Navigation Group Details

3-4

Oracle CRM System Administrator Console Concepts and Procedures

4
Using the System Subtab
4.1 Using the System Subtab
In the System subtab, you can define the system level properties that you need to set up during deployment. You can reconfigure the properties later as necessary. You can perform the following tasks from the System subtab:

Setting Up Sessions Setting Up Cookies Setting Up Branding Setting Up the Self Service User Setting Up Property Categories Managing Properties Editing the Details of Keys Setting Up Debug Logging Viewing the Debug Log Setting Up Page Flow Logging Viewing Page Flow Logging Reports

4.2 Setting Up Sessions


Use this procedure to set up sessions. Sessions are a system property that carries user identity and credentials throughout the duration of a users activity. For security purposes, user sessions can be set to expire according to three rules:

Using the System Subtab

4-1

Setting Up Sessions

A specified number of hours has passed since the session began. A specified number of minutes has passed since the users last activity, such as clicking a button. This setting is intended to prevent unauthorized users from taking advantage of an unattended session. A specified number of "hits" have occurred during the session. A hit means a user action such as submitting a query or clicking a link. This setting is also intended to limit damage in case of an intrusion.

Sticky Sessions are a special kind of session. When using Sticky Sessions, all requests from the same user session will attempt to go to the same JVM, regardless of whether the application is in stateless mode or stateful mode. Sticky Sessions allow for several performance enhancements. In particular, the hit ratio of middle tier caching is improved because all cached data for a particular user resides on a single JVM rather than being scattered across different JVM instances. In addition, session attributes and resources will not have to be recreated and duplicated across different JVMs, but can be reused in the JVM associated with the session. Connection Reuse refers to the sticky connection that is remembered in the sticky session. Turning on connection reuse means that if the JVM finds an open connection in the connection pool, then it can reuse the connection. Saved Cursor Idle Time refers to the maximum time an active open cursor can be idle before the cursor connection is closed.

Steps
1. 2.

In the Settings tab, navigate to System > Properties > Sessions. In the User Sessions area, you can specify how many hours pass before an active session expires, how many minutes pass before an idle session expires, and the maximum number of hits allowed per session. In the Sticky Sessions area, you can turn Sticky Sessions on or off, specify how many minutes pass before a session expires, turn Connection Reuse on or off, and specify the saved cursor idle time. Click Update to save your work.

3.

4.

Related Procedures
Using the System Subtab

4-2

Oracle CRM System Administrator Console Concepts and Procedures

Setting Up Branding

4.3 Setting Up Cookies


Use this procedure to set up cookies. Cookies are a system property that stores session information about users and systems.

Steps
1. 2.

In the Settings tab, navigate to System > Properties > Cookies. Use the drop-down list labeled Mode to set whether a browser cookie or URL rewriting is used. Browser cookies are the recommended setting, for the following reasons:

A cookie stores up to 4K of data, while a URL can only store 2K of data. Using URL rewriting prohibits any customizations that rely on cookies. For example, some customized pages in the iStore application rely upon a cookie.

3.

Type the encryption key into the Encryption Key field. Encryption keys are a means to protect the information stored in cookies. A key is usually an alphanumeric string of twenty to thirty characters. Type a number into the Expiration Time field. This is the number of expiration units (time intervals) that pass before the cookie expires. Set the expiration unit below. Choose Day(s), Hour(s), or Minute(s) from the Expiration Unit drop-down list. Click Update to save.

4.

5. 6.

Related Procedures
Using the System Subtab

4.4 Setting Up Branding


Use this procedure to set up branding. Branding is the wording that displays at the top of every application page. You can customize the branding once the application has been deployed at a customer site. The branding can be defined at both application level and responsibility level. A responsibility can only belong to one application, and an application can have multiple responsibilities. If the branding for a particular responsibility is not set, then the branding for all responsibilities within the application will be used. If the branding for a particular responsibility is

Using the System Subtab

4-3

Setting Up the Self Service User

set, that branding will take precedence and override the branding that is set at application level. For example, for the application CRM Foundation, you could set the branding to "Admin Console" at application level (the default for all responsibilities). Given two CRM Foundation users, one with the CRM Administrator responsibility and the other with the HTML Foundation User responsibility, when they log in, both will see "Admin Console." However, if you customize the branding for the HTML Foundation User responsibility to "HTML User," then when those users log in they will see "HTML User." Users having the responsibility CRM Administrator will still see "Admin Console."

Steps
1. 2. 3.

In the Settings tab, navigate to System > Properties > Branding. Choose an application from the Application Name drop-down list. Choose which responsibility applies to the branding from the Responsibility Name drop-down list. In some cases, you may only have one option, Default Branding for this Application. Type into the Branding Name field to set the branding. Click Update to save. The page refreshes to display a preview of the new branding.

4. 5.

Related Procedures
Using the System Subtab

4.5 Setting Up the Self Service User


Use this procedure to set up the self service user. You must set up the self service user after deploying applications. The self service user is also known as the "guest user." It represents an internal user who is granted certain responsibilities and permissions so that new users can be given the appropriate responsibilities and permissions during the self-registration process.

Steps
1.

In the Settings tab, navigate to System > Properties > Self Service User.

4-4

Oracle CRM System Administrator Console Concepts and Procedures

Setting Up Property Categories

2. 3.

Enter a name for the self service user and set a password. All three fields are required. Click Update to save.

Related Procedures
Using the System Subtab

4.6 Setting Up Property Categories


Use this procedure to set up applications in the system properties framework. In this procedure, you will assign roles to have either read or update permission for a given application (AKA category). For an introduction to permissions and roles, please see Understanding Security.

Steps
1. 2.

In the Settings tab, navigate to System > Properties > Category. Choose an application from the Application Name drop-down list.

Note: This list displays the full names of applications (for

example, "Oracle Enterprise Asset Management"). However, in the Properties screen where you manage properties, the drop-down list displays only the abbreviated application shortname (such as "EAM")

3. 4.

Choose Read or Update from the READ/UPDATE drop-down list, depending on what type of permission you will be granting. Click Next. This opens the page where you can map the permission to one or more roles.

Related Procedures
Assigning a Permission to Roles Using the System Subtab

Using the System Subtab

4-5

Setting Up Password Expiration

4.7 Setting Up Password Expiration


Note: This page no longer controls password expiration.

4.8 Managing Properties


Use this procedure to manage properties. A property is a key/value pair that is application-specific. A key is what is used by an application to retrieve data. Keys are unique, but can have multiple values. Values are the content or data that binds to a particular key. You can view, create, modify, delete, and copy properties.

Steps
1. 2.

In the Settings tab, navigate to System > Properties > Advanced. Choose a application shortname from the View drop-down list. The page will refresh to display the properties registered for that module. If your desired application shortname does not appear in the drop-down list, you will need to do the procedure Setting Up Property Categories.

3. 4. 5.

If you want to create a key, then click Create. This opens the page where you specify the details of a new key. If you want to view or modify the details of a key, then click a key name in the table. This opens the page where you view or edit the details of an existing key. If you want to remove a key, then:
a. b.

Select the appropriate check box in the Remove column of the table. Click Update to save.

Related Procedures
Editing the Details of Keys Using the System Subtab

4.9 Editing the Details of Keys


Use this procedure to edit the details of new or existing keys. A property is a key/value pair that is application-specific. A key is what is used by an application to retrieve data. Keys are unique, but can have multiple values. Values are the content or data that binds to a particular key.

4-6

Oracle CRM System Administrator Console Concepts and Procedures

Setting Up Debug Logging

Steps
1. 2. 3.

In the Settings tab, navigate to System > Properties > Advanced, then either click Create or click the name of a key in the table. Type a key name into the Key field. Edit the table.
a. b. c. d.

Type values into the Value fields as desired. Type sequence numbers into the Sequence fields as desired. If you want to remove a value, then select the appropriate check box in the Remove column. Optionally, click More Rows to add empty rows to the table.

4. 5. 6. 7. 8.

If you want to resequence the key, then click Resequence. If you want to copy the key, then click Copy Key. If you are creating a new key and want to clear the fields, then click Clear. If you are editing an existing key and want to restore the fields to their original settings, then click Restore. Click Update to save.

Related Procedures
Managing Properties Using the System Subtab

4.10 Setting Up Debug Logging


Use this procedure to set up debug logging. Debug logging allows messages to be logged to a central repository at runtime. The logged messages can be viewed for troubleshooting purposes. The repository is shared by both the database and the middle-tier servers.

Steps
1. 2.

In the Settings tab, navigate to System > Properties > Debug Logging > Configuration. In the Enabled field, you can turn debug logging on or off.

Using the System Subtab

4-7

Setting Up Debug Logging

3.

In the Level field, you select what severity of messages will be logged. Only messages with a level equal to or greater than the specified level will be logged. Level 1 messages have low severity, such as "Obtained Connection From Pool." Level 2 messages occur upon entry and/or exit from a method, such as "Leaving MyClass.myMethod()." Level 3 messages are significant in the normal execution path of an application, such as "Retrieved User Preferences Successfully." Level 4 messages occur when a lower level API is returning a failure code or exception, but the error does not necessarily indicate a problem at the level of the calling code. For example, "Profile not found." Level 5 messages are error messages to users, such as "Invalid username or password." Level 6 messages occur when an unexpected situation has occurred which is likely to indicate or cause instabilities in the runtime behavior, and the system administrator should take action to address the situation. For example, "Configuration error - required property not set, cannot access configuration file." In the Repository field, you can set either the database or a file as the log repository. If you select File, you must specify a complete file path in the Filename field below.

4.

Note: Only messages that are logged to the database repository

are searchable in the UI. Messages that are logged to a file are not searchable in the UI.

5.

In the Module Filter field, you can set up a module filter. A module filter is an optional comma-delimited list or strings that you can configure to permit logging for a specific group of modules. The wild-card character (%) is permitted. An example module filter might be: "fnd%, jtf%, %store%." Or to select all modules, use "%." Click Update to save your configuration. Restart your middle-tier server.

6. 7.

Related Procedures
Viewing the Debug Log Using the System Subtab

4-8

Oracle CRM System Administrator Console Concepts and Procedures

Viewing the Debug Log

4.11 Viewing the Debug Log


Use this procedure to search for, view, download, and/or purge the messages generated from debug logging.

Steps
1. 2.

In the Settings tab, navigate to System > Properties > Debug Logging > Messages. To search for messages, do one or more of the following:
a. b.

To limit the messages displayed to a specific date range, use the date picker widgets provided in the From and To fields. To set which logging levels are displayed, choose a level from the Level drop-down list. Check the check box next to the field to include higher (more severe) messages as well. Please see Setting Up Debug Logging for details about logging levels. To limit the messages displayed to a particular node, choose a host name from the Node drop-down list. In the JVM field, you can specify the ID of the Java process where the message was generated. In the Thread field, you can specify the ID of the thread within the Java process where the message was generated. In the Module field, you can specify the source code origin of the message. Typically in Java this is the full class name. When a class name begins with "oracle.apps." the leading "oracle.apps." is dropped in the logged message. For example, "oracle.apps.jtf.util.Encoder" will be logged as "jtf.util.Encoder." In the User field, you can specify the user name of the application user who was active when the message was logged. In the Message field, you can specify a particular log message that you want to search for. In the Session field, you can specify a session ID. Optionally, you can select the View Details check box to show expanded information in the log display below. If unchecked, the message table on this screen will have the following columns: Seq

c. d. e. f.

g. h. i. j.

Using the System Subtab

4-9

Setting Up Page Flow Logging

User Level Timestamp Module Message

If checked, the message table on this screen will have the following columns:
k. 3. 4.

Seq User Level Timestamp Session Node JVM Thread Module Message

Click View Log to display messages.

To download the logged messages as a space-delimited text file, click Download Log. To purge logged messages, click Purge Log. This purges the log based on the criteria you have specified in the above fields. As the system administrator, you should periodically rotate or remove the log files as necessary.

Related Procedures
Setting Up Debug Logging Using the System Subtab

4.12 Setting Up Page Flow Logging


Use this procedure to configure page flow logging.

4-10

Oracle CRM System Administrator Console Concepts and Procedures

Viewing Page Flow Logging Reports

Steps
1. 2. 3.

In the Settings tab, navigate to System > Properties > Page Flow Logging > Configuration. To turn page flow logging on or off, use the Enabled drop-down list. To specify which request attributes to log, check or uncheck the check boxes in the Select Request Attributes to Log area. You can choose to log one or more of the following request attributes for each application page that is accessed:

Client browser information Application parameters Client language (character encoding, language, character set) JTF session cookie All other incoming HTTP headers All other incoming cookies

4.

In the Only log these Applications area, you can specify which applications are logged. Use the arrow buttons to move application names between the Disabled list and the Enabled list. In the Only log these Business Flows area, to specify which business flows are logged. Use the arrow buttons to move application names between the Disabled list and the Enabled list. Click Update to save. Configuration changes will take effect when all the JVMs that use page flow logging are restarted.

5.

6.

Related Procedures
Viewing Page Flow Logging Reports Migrating Page Flow Data Setting Page Flow Buffer Size and Flush Interval Using the System Subtab

4.13 Viewing Page Flow Logging Reports


Use this procedure to view page flow logging reports.

Using the System Subtab

4-11

Migrating Page Flow Data

Note: You must migrate the page flow data from a staging area to

the mining area before the materialized views can be refreshed for UI reports. Please see the procedure Migrating Page Flow Data.

Steps
1. 2. 3.

To view the screen which displays the reports, in the Settings tab, navigate to System > Properties > Page Flow Logging > Reports. Consult the tables provided to view data about application usage and middle-tier usage. Optionally, to customize the dates that display in a table, click Edit. Using the date picker widgets provided, choose your desired date range and click Update to save. If desired, you can drill down into the generated report table to view detailed reports on page hits, sessions, and users.

4.

Related Procedures
Setting Up Page Flow Logging Migrating Page Flow Data Setting Page Flow Buffer Size and Flush Interval Using the System Subtab

4.14 Migrating Page Flow Data


Use this procedure to migrate page flow data. Page flow data is logged in the database in a staging area. This data needs to be migrated to the mining area before the materialized views can be refreshed for the UI reports.

Steps
1. 2. 3. 4.

Log in to Forms (JInitiator) with the CRM Administrator, Vision Enterprises responsibility. Navigate to Concurrent > Requests. Double-click Requests. Click Submit a New Request or Run.

4-12

Oracle CRM System Administrator Console Concepts and Procedures

Setting Page Flow Buffer Size and Flush Interval

5. 6. 7. 8.

Select Request Set. Click OK. In the Request field, enter Page Flow. Then press the Tab key on your keyboard to select Page Flow Data Migration and Refresh. Schedule and submit the request.

After the Concurrent Request-Set completes, you should be able to view the latest data reports and statistics in the System Administrator Console UI. To do so, please see the procedure Viewing Page Flow Logging Reports.

Related Procedures
Setting Up Page Flow Logging Viewing Page Flow Logging Reports Setting Page Flow Buffer Size and Flush Interval Using the System Subtab

4.15 Setting Page Flow Buffer Size and Flush Interval


Use this procedure to set the buffer size and flush interval for page flow logging. Page flow data is buffered within each JVM and periodically asynchronously flushed to the database. The flush is triggered by two parameters: a time interval and the maximum number of page log accesses in the buffer. The data is flushed to the database when the specified flush interval is reached, or when the number of page log accesses exceeds the configured buffer size.

Steps
1. 2. 3. 4. 5. 6.

In the Settings tab, navigate to System > Advanced. In the View field, select JTF. In the Key column, find the property JTF_PF_BUFFER_SIZE. To change the value from the default (5 page hits), click JTF_PF_BUFFER _SIZE and modify the value as desired. Click Update to save. In the Key column, find the property JTF_PF_FLUSH_INTERVAL. To change the value from the default (30 seconds), click JTF_PF_FLUSH_ INTERVAL and modify the value as desired. Click Update to save.

Using the System Subtab

4-13

Setting Page Flow Buffer Size and Flush Interval

Related Procedures
Setting Up Page Flow Logging Viewing Page Flow Logging Reports Migrating Page Flow Data Using the System Subtab

4-14

Oracle CRM System Administrator Console Concepts and Procedures

5
Using the Deployment Tab
5.1 Viewing System Alerts
Use this procedure to use the Application Alert Board. The Application Alert Board allows you check the health of a deployed system by displaying a filterable test summary. It complements the Diagnostics framework to guide you when troubleshooting failures or misconfigurations.

Steps
1.

In the Deployment tab, navigate to System Statistics > System Alerts. Alternatively, you can view only Security-related alerts in the Settings tab by navigating to Security > Alerts Monitor. The Alerts Monitor is a summary of security-related tests that are run on each registered host. In the Filters Selection area, you can set what displays below in the Monitor Board area. You can filter by application, node, test status, and date range. The entire page refreshes automatically each time you make a selection from one of the drop-down lists. To set a date range, use the date picker widgets to select the appropriate dates and then click Go. If needed, click Restore to return the date fields to their original values.

2.

Note: If you are in the Security subtab and are viewing the Alerts

Monitor, then you can only filter by node.

3.

The Monitor Board area displays tests and their results. The tests are organized by test group and application. Colored icons express whether the test has

Using the Deployment Tab 5-1

Viewing Jserv Statistics

succeeded, failed, or resulted in a warning. Refer to the Nodes Alias area below to find out which registered node is mapped to each numbered column (labeled 0, 1, 2, etc.) in the table.

Related Procedures
Viewing Jserv Statistics

5.2 Viewing Jserv Statistics


Use this procedure to view the Jserv statistics of a particular host.

Steps
1. 2. 3. 4. 5. 6.

In the Deployment tab, navigate to System Statistics > Jserv Statistics. Type a host name into the Hostname field. Optionally, type a Jserv ID into the Jserv ID field. Click Submit. On new page that displays, you can view memory, thread, connection pool, session, and services statistics. Optionally, click Back to return to the previous page.

Related Procedures
Viewing System Alerts

5.3 Managing Configuration


You can perform the following tasks from the Configuration subtab:

Setting Up Hosts Editing Host Details Editing Resource Settings

5.4 Setting Up Hosts


Use this procedure to manage hosts. The Hosts Setup page is the starting point for viewing, creating, updating, and removing hosts.

5-2

Oracle CRM System Administrator Console Concepts and Procedures

Editing Host Details

Steps
1. 2. 3.

In the Deployment tab, navigate to Configuration > Hosts. If you want to register a host, then click Create. This opens the page where you edit the details of a new host. You must register all mid-tier hosts. If you want to modify the attributes of a host, then click a name in the Host Name column. This opens the page where you edit the details of an existing host. If you want to remove a host, then:
a. b.

4.

Select a check box in the Remove column. Click Update to save.

Related Procedures
Editing Host Details Managing Configuration

5.5 Editing Host Details


Use this procedure to edit the details of new or existing hosts.

Steps
1. 2.

In the Deployment tab, navigate to Configuration > Hosts, then either click Create or click the name of a host in the table. If you are creating a new host, then type the name of the mid-tier URL into the Hostname field. For example, "computername.companyname.com.". If you are updating an existing host, then you cannot edit this field.) Type a description into the Description field. Edit port numbers:
a. b.

3. 4.

Type the port number where the Apache in this mid-tier host runs into the first Port field. For example, "9999." If there are multiple Apache instances running on the same mid-tier host, then type additional port numbers into the Port column. For example, "9999" and "8080." If you want to remove an existing port, then select the appropriate check box in the Remove column.

c.

Using the Deployment Tab 5-3

Editing Resource Settings

5.

Edit application deployment: This information is used by the caching framework to cache and prime only the data for the configured set of applications.
a. b. c. d.

Choose the name of an application in one list and click > or < to move it to the other list. Repeat step a as desired. If you want to move all Available Applications to the Deployed Applications list, then click >>. If you want to move all Deployed Applications to the Available Applications list, then click <<.

6. 7.

If you are creating a new host, then click Create to save. If you are updating an existing host, then click Update to save.

Related Procedures
Setting Up Hosts Managing Configuration

5.6 Editing Resource Settings


Use this procedure to manage resource settings for the cache. The cache is a data structure that holds frequently used Java objects. It is composed of component caches. Component caches hold the objects of application modules that pertain to specific application functionality. In the Resource Settings subtab, you can set the maximum size of the cache (in megabytes). This is used to prevent the JVM memory from bloating because of caching. When the JVMs memory usage reaches this limit, the cache stops growing in size. Elsewhere, in the Cache subtab, you can manage cache policies, manage component caches, and view cache statistics.

Steps
1. 2.

In the Deployment tab, navigate to Configuration > Resource Settings. To define cache resource settings, type a number into the Disable Cache if Total Memory Exceeds field. Typically this represents a percentage of the maximum memory of the JVM (in megabytes). Click Update to save.

3.

5-4

Oracle CRM System Administrator Console Concepts and Procedures

Editing Resource Settings

Related Procedures
Using Cache

Using the Deployment Tab 5-5

Editing Resource Settings

5-6

Oracle CRM System Administrator Console Concepts and Procedures

6
Using the Diagnostics Framework
6.1 Using Diagnostics
Note: You can also navigate to the CRM Diagnostics page by

typing the following URL into a Web browser: http://hostname:portnumber/OA_HTML/jtfqalgn.htm This is particularly useful if the deployment is having startup problems. You can perform the following tasks from CRM Diagnostics: Running Test Groups In the Basic tab, you can run groups of tests either all at once or individually. Running Tests In the Advanced tab, you can run tests one at a time. If desired, you can specify input values that are different from the defaults. Managing Test Groups Creating Test Groups Updating Test Groups Managing Tests Registering Tests Setting Default Test Input Values Managing Applications

Using the Diagnostics Framework

6-1

Running Test Groups

In the Configuration tab, you can set up the applications, test groups, and tests that are used in Diagnostics. For information on Diagnostics framework concepts, see Understanding Diagnostics.

6.2 Running Test Groups


You can perform the following tasks from the Basic tab: Running All Test Groups Running One Test Group For information on Diagnostics framework concepts, see Understanding Diagnostics.

6.3 Running All Test Groups


Use this procedure to run all test groups on an application. Test groups are logical sets of one or more related tests. For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2. 3. 4. 5.

In the Diagnostics UI, navigate to the Basic tab. Choose an application from the Application drop-down list. Click Run All Groups. View the test results. If you want to view a detailed summary of a test, then click the icon in the Report column.

Related Procedures
Running All Test Groups Managing Test Groups Using Diagnostics

6-2

Oracle CRM System Administrator Console Concepts and Procedures

Running Tests

6.4 Running One Test Group


Use this procedure to run a specific test group on an application. Test groups are logical sets of one or more related tests. For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2. 3. 4.

In the Diagnostics UI, navigate to the Basic tab. Choose an application from the Application drop-down list. Click the name of the test group. If you want to run the test groups prerequisite group or groups, then click Run With Prerequisite. You can view the names of the prerequisite group or groups in the Prerequisites drop-down list. If you want to run the test group alone, then click Run Without Prerequisite. View the test results. If you want to view a detailed summary of a test, then click the icon in the Report column.

5. 6. 7.

Related Procedures
Running One Test Group Managing Test Groups Using Diagnostics

6.5 Running Tests


Use this procedure to run a test on an application. Tests verify the correct behavior of a particular feature or function. For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2. 3.

In the Diagnostics UI, navigate to the Advanced tab. Choose an application from the Application drop-down list. Click the name of the test.

Using the Diagnostics Framework

6-3

Managing Test Groups

4. 5. 6. 7.

If you want to specify your own input values, then type them into the appropriate fields. Otherwise, the test runs using default values. Click Run Test. View the test results. If you want to view a detailed summary of a test, then click either the icon in the Report column or View Report.

6.6 Managing Test Groups


Use this procedure to manage test groups. The main page for test groups is the starting point for viewing, creating, updating, prioritizing, and removing test groups. Please note that this procedure is not applicable to the application "HTML Platform." For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2.

In the Diagnostics UI, navigate to the Configuration tab, choose an application from the drop-down list, then choose Groups. If you want to create a new test group, then click Create. This opens the page where you edit the details of a new test group.

3.

If you want to update an existing test group, then click a link in the Group Name column. This opens the page where you edit the details of an existing test group. If you want to change the test group sequence, then choose the appropriate numbers from the drop-down lists in the Sequence column. If you want to remove a test group, then select the appropriate check box in the Remove column. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

4. 5. 6. 7.

Related Procedures
Creating Test Groups Updating Test Groups Using Diagnostics

6-4

Oracle CRM System Administrator Console Concepts and Procedures

Updating Test Groups

6.7 Creating Test Groups


Use this procedure to create test groups. Test groups are logical sets of one or more related tests. Please note that this procedure is not applicable to the application "HTML Platform." For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2. 3. 4. 5. 6.

In the Diagnostics UI, navigate to the Configuration tab, choose an application from the drop-down list, choose Groups, then click Create. Type the name of the test group into the Group Name field. If you want to set Group Prerequisites, then choose from the drop-down lists in the Group Name column. Optionally, click More Prerequisites to add more rows to the table. Optionally, click Restore to reset the fields to their original settings. Click Create to save.

Related Procedures
Updating Test Groups Managing Test Groups Using Diagnostics

6.8 Updating Test Groups


Use this procedure to view or edit the name and prerequisites of an existing test group. Test groups are logical sets of one or more related tests. Please note that this procedure is not applicable to the application "HTML Platform."For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1.

In the Diagnostics UI, navigate to the Configuration tab, choose an application from the drop-down list, choose Groups, then click the name of a group in the table. If you want to rename the group, then type into the Group Name field.

2.

Using the Diagnostics Framework

6-5

Managing Tests

3. 4. 5.

If you want to remove a prerequisite, then select the appropriate check box in the Remove column. If you want to add a prerequisite, then choose from the drop-down lists in the Group Name column. If you want to view the individual tests that belong to that test group, then click View Tests. This opens the page where you manage how tests are organized into test groups. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

6. 7.

Related Procedures
Creating Test Groups Managing Test Groups Using Diagnostics

6.9 Managing Tests


Use this procedure to manage tests. The Tests Administration page is the starting point for viewing, creating, updating, prioritizing, and removing individual tests. Please note that this procedure is not applicable to the application "HTML Platform." For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2. 3. 4. 5. 6. 7.

In the Diagnostics UI, navigate to the Configuration tab, choose an application from the drop-down list, then choose Tests. Choose a group from the Group drop-down list. View test names and class names display in the table. If you want to create a test, then click Create. This opens the page where you specify the details of a new test. If you want to change the test sequence, then choose the appropriate numbers from the drop-down lists in the Sequence column. If you want to remove a test, then select the check box in the Remove column. Optionally, click Restore to reset the fields to their original settings.

6-6

Oracle CRM System Administrator Console Concepts and Procedures

Setting Default Test Input Values

8.

Click Update to save.

Related Procedures
Registering Tests Setting Default Test Input Values Using Diagnostics

6.10 Registering Tests


Use this procedure to register a test. For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Steps
1. 2. 3. 4. 5. 6.

In the Diagnostics UI, navigate to the Configuration tab, choose an application from the drop-down list, choose Tests, then click Create. Type the fully qualified name of the Java class into the Test Class Name field. View the class names of any existing tests in the Existing Tests field. Choose a sequence number from the Sequence drop-down list. Optionally, click Restore to reset the fields to their original settings. Click Create to save.

Related Procedures
Setting Default Test Input Values Managing Tests Using Diagnostics

6.11 Setting Default Test Input Values


Use this procedure to set the default input values for a test. Please note that this procedure is not applicable to the application "HTML Platform." For an introduction to Diagnostics concepts, please see Understanding Diagnostics.

Using the Diagnostics Framework

6-7

Managing Applications

Steps
1. 2. 3. 4. 5. 6. 7.

In the Diagnostics UI, navigate to the Configuration tab, choose an application from the drop-down list, then choose Inputs. Click the name of a test. Type default input values into the appropriate fields. Click Update to save. Optionally, type an additional set of default values and click Update to save. Repeat step 4 as desired. If you want to delete an input value, then select the check box in the Remove column and click Update to save.

Related Procedures
Registering Tests Managing Tests Using Diagnostics

6.12 Managing Applications


Applications must be registered to be included in CRM Diagnostics. Applications can have other applications as prerequisites. You can perform the following tasks to manage applications: Registering Applications Editing Application Prerequisites For an introduction to Diagnostics framework concepts, please see Understanding Diagnostics.

6.13 Registering Applications


Use this procedure to register an application in the CRM Diagnostics framework. For an introduction to Diagnostics framework concepts, please see Understanding Diagnostics.

6-8

Oracle CRM System Administrator Console Concepts and Procedures

Editing Application Prerequisites

Steps
1. 2. 3. 4. 5.

In the Diagnostics UI, navigate to Configuration > Applications, then click Create. Choose an application from the Choose an Application drop-down list. If you want to set Application Prerequisites, then choose from the drop-down lists in the Application Name column. Click Register to register the application. View the new application display in the Application drop-down list at the top of the page.

Related Procedures
Editing Application Prerequisites Using Diagnostics

6.14 Editing Application Prerequisites


Use this procedure to edit application prerequisites. For an introduction to Diagnostics framework concepts, please see Understanding Diagnostics.

Steps
1. 2. 3. 4. 5.

In the Diagnostics UI, navigate to Configuration > Applications. Choose an application from the Application drop-down list. If you want to remove an Application Prerequisite, then select the appropriate check box in the Remove column. If you want to add an Application Prerequisite, then choose from the drop-down lists in the Application Prerequisites table. Click Update to save.

Related Procedures
Registering Applications Using Diagnostics

Using the Diagnostics Framework

6-9

Editing Application Prerequisites

6-10

Oracle CRM System Administrator Console Concepts and Procedures

7
Using the Cache Subtab
7.1 Using Cache
You can perform the following tasks from the Cache subtab:

Managing Cache Policies Editing Cache Policy Details

Managing Cache Filters Viewing Cache Filter Details Creating and Editing Cache Filters

Managing Component Cache Editing Component Cache Details

Viewing Cache Statistics

For an introduction to cache concepts, please see Understanding Cache.

7.2 Managing Cache Policies


Use this procedure to manage cache policies. The main cache policies screen lists the cache policy of each application on each host. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2.

In the Performance tab, navigate to Cache > Applications > Policies. Choose a host name or All Hosts from the drop-down list labeled View to select which cache policies display in the table.

Using the Cache Subtab

7-1

Editing Cache Policy Details

3. 4. 5.

To sort the table alphabetically by host name or application, click the appropriate link in the top row of the table. To edit the details of a cache policy, click a link in the table. This opens the page where you edit the details of a cache policy. To set a cache policy, choose Cache Only, Cache and Priming, Disabled, or Custom from the drop-down lists in the Policy column. If you enable caching, then all components of the application use the caching. If you enable priming, then the components read some initial cache data when the Jserv process begins. Priming can improve the performance for the first set of users because the data that they need is already available in the cache. However, priming can increase the size of the Java Virtual Machine. Disable the cache if the size of the Java Virtual Machine grows too large.

6. 7.

To set filters, then choose Enabled, Disabled, or Custom from the drop-down lists in the Filters column. Click Update to save.

Related Procedures
Editing Cache Policy Details Using Cache

7.3 Editing Cache Policy Details


Use this procedure to edit the details of cache policies and cache filters. The Cache Policy Detail page displays the cache policy types for components of applications running on a particular host. It also displays cache filters. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2. 3. 4.

In the Performance tab, navigate to Cache > Applications > Policies, then click the name of a policy in the table. To modify a cache policy, choose Cache Only, Cache and Priming, or Disabled from the drop-down list in the Policy column of the table. Click Update to save. To enable or disable a cache filter, go to the Enabled column and select or deselect the check box as desired.

7-2

Oracle CRM System Administrator Console Concepts and Procedures

Managing Cache Filters

5.

Click Update to save.

Related Procedures
Managing Cache Policies Using Cache

7.4 Managing Cache Filters


Use this procedure to manage cache filters. The main page for cache filters is the starting point for viewing, creating, updating and removing cache filters. Cache filters are application-specific components that indicate the responsibility IDs and language codes for priming. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2. 3. 4. 5.

In the Performance tab, navigate to Cache > Applications > Filters. Choose an application name from the drop-down list labeled View to choose which cache filters display in the table. If you want to create a new cache filter, then click Create. This opens the page where you begin editing the details of a new cache filter. If you want to view the details of a cache filter, then click a filter name in the table. This opens the page where you view the details of a Cache Filter. If you want to remove a filter, then:
a. b.

Select the appropriate check box in the Remove column. Click Update. This removes the filter from the table.

Related Procedures
Viewing Cache Filter Details Creating and Editing Cache Filters Using Cache

Using the Cache Subtab

7-3

Viewing Cache Filter Details

7.5 Viewing Cache Filter Details


Use this procedure to view the details of a cache filter. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2. 3.

In the Performance tab, navigate to Cache >Applications > Filters, then click a filter name in the table. The page displays information about the cache filters responsibilities and languages. If you want to edit the details of the cache filter, then click Edit. This opens the page where you edit the details of an existing cache filter.

Related Procedures
Creating and Editing Cache Filters Managing Cache Filters Using Cache

7.6 Creating and Editing Cache Filters


When you create a new cache filter or modify an existing cache filter, you complete three different screens. The following procedures guide you through each screen: Step 1: Editing Basic Information Step 2: Choosing Responsibilities Step 3: Choosing Languages After you finish creating or editing a cache Filter, you are automatically returned to the main cache filters page. For an introduction to cache concepts, please see Understanding Cache.

7.7 Step 1: Editing Basic Information


Use this procedure to enter basic information about a cache filter. For an introduction to cache concepts, please see Understanding Cache.

7-4

Oracle CRM System Administrator Console Concepts and Procedures

Step 2: Choosing Responsibilities

Steps
1.

In the Performance tab, navigate to Cache >Applications > Filters. If you are creating a new filter, then click Create. If you are modifying an existing filter, then click a policy name in the table and click Edit after the new page displays. Type a filter name into the Filter Name field. Type a description into the Description field. Choose an application from the Application drop-down list. Click Continue to save and move on to the next screen.

2. 3. 4. 5.

Related Procedures
Step 2: Choosing Responsibilities Step 3: Choosing Languages Creating and Editing Cache Filters Managing Cache Filters Using Cache

7.8 Step 2: Choosing Responsibilities


Use this procedure to choose which responsibilities apply to a particular cache filter. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2. 3. 4. 5.

Select the name of a responsibility in one list and click > or < to move it to the other list. Repeat step 1 as desired. If you want to move all Available Responsibilities to the Configured Responsibilities list, then click >>. If you want to move all Configured Responsibilities to the Available Responsibilities list, then click <<. Click Continue to save and move on to the next page.

Related Procedures
Step 3: Choosing Languages

Using the Cache Subtab

7-5

Step 3: Choosing Languages

Creating and Editing Cache Filters Managing Cache Filters Using Cache

7.9 Step 3: Choosing Languages


Use this procedure to choose which languages apply to a particular cache filter. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2. 3. 4. 5. 6.

Select a language in one list and click > or < to move it to the other list. Repeat step 1 as desired. If you want to move all Available Languages to the Configured Languages list, then click >>. If you want to move all Configured Languages to the Available Languages list, then click <<. If you are creating a new Cache Filter, then click Create to save. If you are updating an existing Cache Filter, then click Update to save.

Related Procedures
Creating and Editing Cache Filters Managing Cache Filters Using Cache

7.10 Managing Component Caches


Use this procedure to manage component caches. The main page for component caches is the starting point for viewing, creating, updating, and removing component caches. Each application uses one or more component caches. For an introduction to cache concepts, please see Understanding Cache.
Note: Before modifying a component cache, please ensure that the

corresponding code has already been modified.

7-6

Oracle CRM System Administrator Console Concepts and Procedures

Editing Component Cache Details

Steps
1. 2. 3. 4. 5. 6.

In the Performance tab, navigate to Cache > Components. Choose an application from the drop-down list labeled View to choose which component caches display. If you want to create a component cache, then click Create. This opens the page where you edit the details of a new component cache. If you want to update a component cache, then click its name. This opens the page where you edit the details of an existing component cache. If you want to remove a component cache, then select the check box in the Remove column. Click Update to save.

Related Procedures
Editing Component Cache Details Using Cache

7.11 Editing Component Cache Details


Use this procedure to edit the details of new or existing component caches. For an introduction to cache concepts, please see Understanding Cache.
Note: Before modifying a component cache, please ensure that the

corresponding code has already been modified.

Steps
1. 2.

In the Performance tab, navigate to Cache > Components, then either click Create or click the name of a component cache in the table. If you are creating a new component cache, then choose an application from the Application drop-down list. If you are updating an existing component cache, then you cannot edit this field. If you are creating a new component cache, then type a component identifier into the Component Identifier field. The component identifier should start with the appropriate application shortcode. If you are updating an existing component cache, then you cannot edit this field.

3.

Using the Cache Subtab

7-7

Editing Component Cache Details

4. 5. 6.

Type a component name into the Component Name field. Type a description into the Description field. Type into a loader class name into the Loader Class Name field. Each component cache has an associated loader class that is used by the caching framework to load the corresponding object into the cache, if it is not already in the cache.

7.

Choose Time to Live or Idle Time from the drop-down list. The Time to Live is the maximum length of time for a cache to be considered valid. The Idle Time is the maximum length of time for an object to go unused before it is flushed from the cache.
a. b.

Type a number of seconds, minutes, or hours into the text input field to edit the Time to Live or Idle Time. Choose seconds, minutes, or hours from the drop-down list.

8.

If you are creating a new component cache, then select or deselect the check box labeled Enable Security Group ID. The Security Group ID is used in the hosting environments. If you are updating an existing component cache, then you cannot edit this field. Select or deselect the check box labeled Enable Statistics Collection. Enabling statistics collection can slow the cache down. Use it if there are problems with using the cache or if you need to check the cache efficiency. means that object updates are propagated across computers and across Java VMs.

9.

10. Select or deselect the check box labeled Distributed Mode. Distributed Mode

11. Select or deselect the check box labeled HTML Platform Component. HTML

Platform Components are generic caches that are common to all applications. Usually, you only select this check box for JTF component caches. It is merely a logical grouping that does not change the assigned application.
12. If you are creating a new component cache, then click Create to save. 13. If you are updating an existing component cache, then click Update to save.

Related Procedures
Managing Component Caches Using Cache

7-8

Oracle CRM System Administrator Console Concepts and Procedures

Viewing Cache Statistics

7.12 Viewing Cache Statistics


Use this procedure to view statistics about caches. For an introduction to cache concepts, please see Understanding Cache.

Steps
1. 2. 3.

In the Performance tab, navigate to Cache > Statistics. Choose from the drop-down lists next labeled View to select which hosts and applications have data about them displayed below. You can use these statistics to configure the component caches based on how each component cache is performing. You can interpret the data to decide how effective the component caches are and whether or not they should be disabled. For example, if the cache has a high hit ratio, then the cache is useful and should not be disabled.

Related Procedures
Using Cache

Using the Cache Subtab

7-9

Viewing Cache Statistics

7-10

Oracle CRM System Administrator Console Concepts and Procedures

8
Using the XML Integration Subtab
8.1 Using XML Services
You can perform the following tasks from the XML Integration subtab:

Managing Service Groups Editing the General Settings of New Service Groups Editing the Services of New Service Groups Editing the Type Mappings of New Service Groups Updating the General Settings of Service Groups Updating the Services of Service Groups Updating the Type Mappings of Service Groups

Managing Invocations Creating Invocations Updating Invocations

Managing Authentication Profiles Creating Authentication Profiles Updating Authentication Profiles

For information on XML Services concepts, please see Understanding XML Services.

Using the XML Integration Subtab

8-1

Managing Service Groups

8.2 Managing Service Groups


The main page for Service Groups is the starting point for viewing, creating, updating, and removing service groups. A Service Group is the logical name for a Java class that contains functions for loading services into a system. Use this procedure to manage service groups. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2.

In the Integration tab, navigate to XML Integration > Services. If you want to modify the service group prefix, then:
a.

Type into the Service Group Prefix field at the top of the page. The service group prefix is the first part of a service group full name. The format of service group full names is the following: <service group prefix>.<application shortname>.<service group name>

b. 3. 4.

Click Update to save.

If you want to create a new service group, then click Create. This opens the page where you start to edit the details of a new service group. If you want to view the service groups of a particular application, then choose an application name from the drop-down list at the top of the table. Optionally, choose ALL to view all service groups. The page refreshes to display the choice that you made. If you want to update a service group, then click its name in the table. This opens the page where you start to edit the details of an existing service group. If you want to remove a service group, then:
a. b.

5. 6.

Select the corresponding check box in the Remove column of the table. Click Update to save.

Related Procedures
Using XML Services

8.3 Editing the General Settings of New Service Groups


A Service Group is the logical name for a Java class that contains methods that are exposed as services. Services are function calls with defined inputs and outputs that

8-2

Oracle CRM System Administrator Console Concepts and Procedures

Editing the Services of New Service Groups

are implemented as methods of the Java class. Creating a new service group requires completing three screens. Use this procedure to complete the first screen. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2. 3.

In the Integration tab, navigate to XML Integration > Services, then click Create. Choose an application from the drop-down list. Type the Service Group name into the Service Group field. If you type "TestService" as your service group name while your prefix is "oracle.apps" and your application short name is "JTF," then the service groups full name is oracle.apps.JTF.TestService Type the Java Class name into the Java Class field. For example, "samples.test.TestServiceGroup" Optionally, type a description into the Description field. Click Continue.

4. 5. 6.

Related Procedures
Using XML Services

8.4 Editing the Services of New Service Groups


A Service Group is the logical name for a Java class that contains methods that are exposed as services. Services are function calls with defined inputs and outputs that are implemented as methods of the Java class. Creating a new service group requires completing three screens. Use this procedure to complete the second screen. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2. 3.

View a table that lists the services defined in the class that you set up on the previous screen. Select check boxes in the Enable column to enable services, or click Enable All to enable all services. Optionally, type descriptions into the Description column.

Using the XML Integration Subtab

8-3

Editing the Type Mappings of New Service Groups

4.

Click Continue.

Related Procedures
Using XML Services

8.5 Editing the Type Mappings of New Service Groups


A Service Group is the logical name for a Java class that contains methods that are exposed as services. Services are function calls with defined inputs and outputs that are implemented as methods of the Java class. Creating a new service group requires completing three screens. Use this procedure to complete the third screen. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2. 3.

If you want to use your own settings, then type them into the Data Type, Encoding, Namespace, Serializer, and Deserializer columns. If you want to use default settings, then select the check box in the Use Default column. Click Create to save the new service group.

Related Procedures
Using XML Services

8.6 Updating the General Settings of Service Groups


A Service Group is the logical name for a Java class that contains methods that are exposed as services. Services are function calls with defined inputs and outputs that are implemented as methods of the Java class. Updating an existing service group requires completing three screens. Use this procedure to complete the first screen. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2.

In the Integration tab, navigate to XML Integration > Services, then click a service group name in the table. Optionally, type into the Description field to edit the service group description.

8-4

Oracle CRM System Administrator Console Concepts and Procedures

Updating the Type Mappings of Service Groups

3.

Click Continue.

Related Procedures
Using XML Services

8.7 Updating the Services of Service Groups


A Service Group is the logical name for a Java class that contains methods that are exposed as services. Services are function calls with defined inputs and outputs that are implemented as methods of the Java class. Updating an existing service group requires completing three screens. Use this procedure to complete the second screen. For information on XML Services concepts, please see Understanding XML Services.

Steps
1.

Edit the Previously Existing Services area:


a. b. c.

Select or deselect the check boxes in the Enable column as desired. Optionally, click Disable All to disable all previously existing services. Optionally, type descriptions into the Description fields.

2.

Edit the Added Services area: If there are no added services for this service group, the fields will be empty.
a. b. c.

Select or deselect the check boxes in the Enable column as desired. Optionally, click Disable All to disable all added services. Optionally, type descriptions into the Description fields.

3.

Click Continue.

Related Procedures
Using XML Services

8.8 Updating the Type Mappings of Service Groups


A Service Group is the logical name for a Java class that contains methods that are exposed as services. Services are function calls with defined inputs and outputs that are implemented as methods of the Java class. Updating an existing service group requires completing three screens. Use this procedure to complete the third screen.

Using the XML Integration Subtab

8-5

Managing Invocations

For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2. 3. 4.

If you want to use your own settings, then type them into the Data Type, Encoding, Namespace, Serializer, and Deserializer columns. If you want to use default settings, then select the check box in the Use Default column. If you want to remove a type mapping, then select the appropriate check box in the Remove column of the table. Click Update to save.

Related Procedures
Using XML Services

8.9 Managing Invocations


The main page for invocations is the starting point for viewing, creating, updating, and removing invocations. An invocation is the logical name for a record that contains all information about a service on a remote machine. Use this procedure to manage invocations. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2. 3.

In the Integration tab, navigate to XML Integration > Invocations. If you want to create a new invocation, then click Create. This opens the page where you edit the details of a new invocation. If you want to view the invocations of a particular application, then choose an application name from the drop-down list at the top of the table. Optionally, choose ALL to view all invocations. If you want to update the details of a particular invocation, then click its name in the table. This opens the page where you edit the details of an existing invocation. If you want to remove an invocation, then:
a.

4.

5.

Select the corresponding check box in the Remove column of the table.

8-6

Oracle CRM System Administrator Console Concepts and Procedures

Creating Invocations

b.

Click Update to save.

Related Procedures
Using XML Services

8.10 Creating Invocations


An invocation is the logical name for a record that contains all information about a service on a remote machine. Use this procedure to create invocations. For information on XML Services concepts, please see Understanding XML Services.
Note: Before performing this procedure, please confirm that the

following have been done:

The service group has been created. The appropriate service in the service group has been enabled. The authentication has been created.

Steps
1. 2.

In the Integration tab, navigate to XML Integration > Invocations, then click Create. Complete the General Settings area:
a. b. c. d. e. f.

Choose an application from the drop-down list. Type an invocation name into the Invocation Name field. Optionally, type a description into the Description field. Type the full name of the service group into the Service Group Full Name field. For example, "oracle.apps.JTF.TestService" Type the name of the service into the Service field. This is a Java method. Type a number into the Timeout field. This is the number of milliseconds to wait before a response. A timeout of zero means it will wait forever.

3.

Complete the Authentication Profile area:


a.

Choose a URL from the URL drop-down list.

Using the XML Integration Subtab

8-7

Creating Invocations

b.

Choose a User from the User drop-down list. If you are not setting a user, then choose No_Authentication. You can change the list of available users by editing the authentication profile.

4.

Complete the Target Service Signature area. This is the format of the method that you are calling.
a. b. c. d. e.

Type a data type into the Return Data Type field. If the data type is a string, then you must type java.lang.string If you want to set your own return data type encoding, then type it into the Encoding field. If you want to use the default return data type encoding, then select the Use Default check box. Type a parameter name into the Parameter Name column. Type a data type into the Data Type column. Instead of using primitive object types like java.lang.Integer, enter the actual primitive, such as "int" or "float." If you want to use the default encoding, then select the Use Default check box. If you want to set your own encoding, then type it into the Encoding field.

f. g. 5.

Complete the Type Mappings area. This section is for user-defined types.
a. b. c.

Type the name of a fully qualified Java class into the Data Type column. If you want to set your own parameters, then type them into the Encoding, Name Space, Serializer and Deserializer columns. If you want to use defaults (recommended), then select the Use Default check box.

6.

Click Create to save.

Related Procedures
Using XML Services

8-8

Oracle CRM System Administrator Console Concepts and Procedures

Updating Invocations

8.11 Updating Invocations


An invocation is the logical name for a a record that contains all information about a service on a remote machine. Use this procedure to modify the details of existing invocations. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2.

In the Integration tab, navigate to XML Integration > Invocations, then click an invocation name in the table. Edit the General Settings area:
a. b. c. d.

Optionally, type a description into the Description field. Type the full name of the service group into the Service Group Full Name field. For example, "oracle.apps.JTF.TestService" Type the name of the service into the Service field. This is a Java method. Type a number into the Timeout field. This is the number of milliseconds to wait before a response. A timeout of zero means it will wait forever.

3.

Complete the Authentication Profile area:


a. b.

Choose a URL from the URL drop-down list. Choose a User from the User drop-down list. If you are not setting a user, then choose No_Authentication. You can change the list of available users by editing the authentication profile.

4.

Complete the Target Service Signature section. This is the format of the method that you are calling.
a. b. c. d.

Type a data type into the Return Data Type field. If the data type is a string, then you must type java.lang.string If you want to set your own return data type encoding, then type it into the Encoding field. If you want to use the default return data type encoding, then select the Use Default check box. Type a parameter name into the Parameter Name column.

Using the XML Integration Subtab

8-9

Managing Authentication Profiles

e.

Type a data type into the Data Type column. Instead of using primitive object types like java.lang.Integer, enter the actual primitive, such as "int" or "float." If you want to set your own encoding, then type it into the Encoding field. If you want to use the default encoding, then select the Use Default check box. If you want to delete an entry in the table, then select the appropriate Remove check box.

f. g. h. 5.

Complete the Type Mappings area. This section is for user-defined types.
a. b. c. d.

Type the name of a fully qualified Java class into the Data Type column. If you want to set your own parameters, then type them into the Encoding, Name Space, Serializer and Deserializer columns. If you want to use defaults (recommended), then select the Use Default check box. If you want to delete an entry in the table, then select the appropriate Remove check box.

6.

Click Update to save.

Related Procedures
Using XML Services

8.12 Managing Authentication Profiles


The main page for authentication profiles is the starting point for viewing, creating, updating, and removing authentication profiles. Authentication profiles tell an invocation what machine, user name and password to use. Use this procedure to manage authentication profiles. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2.

In the Integration tab, navigate to XML Integration > Authentications. If you want to create a new authentication profile, then click Create. This opens the page where you edit the details of a new authentication profile.

8-10

Oracle CRM System Administrator Console Concepts and Procedures

Creating Authentication Profiles

3.

If you want to update an authentication profile, then click its name in the table. This opens the page where you edit the details of an existing authentication profile. If you want to remove an authentication profile, then:
a. b.

4.

Select the corresponding check box in the Remove column of the table. Click Update to save.

Related Procedures
Using XML Services

8.13 Creating Authentication Profiles


Authentications tell an invocation what machine, user name and password to use. Use this procedure to create authentications. For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2. 3.

In the Integration tab, navigate to XML Integration > Authentications, then click Create. Type the URL of the SOAP server of the target machine into the URL field. If you want to enter a username and password combination, then:
a. b. c.

Type a username into the Username column. Type a password into the Password column. Retype the password into the Retype Password column.

4. 5.

Repeat step 3 as desired. Click Create to save.

Related Procedures
Using XML Services

Using the XML Integration Subtab 8-11

Updating Authentication Profiles

8.14 Updating Authentication Profiles


Authentications tell an invocation what machine, user name and password to use. Use this procedure to view or modify the details of an authentication.For information on XML Services concepts, please see Understanding XML Services.

Steps
1. 2.

In the Integration tab, navigate to XML Integration > Authentications, then click a URL in the table. If you want to modify the URL of the target machine, then:
a. b.

Type the URL of the SOAP server of the target machine into the URL field. Click Update to save.

3.

If you want to reset a password, then:


a. b.

Type a password into the Password column. Retype the password into the Retype Password column.

4.

If you want to add a username and password combination, then:


a. b. c.

Type a username into the Username column. Type a password into the Password column. Retype the password into the Retype Password column.

5. 6.

If you want to remove a username and password combination, then select the appropriate check box in the Remove column. Click Update to save.

Related Procedures
Using XML Services

8.15 Managing Events


Note: The XML Events feature is currently under transition and

may not be supported in the future. Therefore, please do not use the XML Events screens. We apologize for any inconvenience.

8-12

Oracle CRM System Administrator Console Concepts and Procedures

9
Using the Declarative Page Flows Subtab
9.1 Using Declarative Page Flows
The Introduction page for Declarative Flows is the starting point for setting up and using Declarative Page Flows. The Declarative Page Flows framework enables you to customize, upgrade, and troubleshoot the content and flow of JSPs, without having to modify code. The key concept of the framework involves the abstraction of JSPs into named logical entities, called Logical Pages. The components of the Declarative Page Flows framework are Physical Pages, Logical Pages, Rules, and Business Flows. You can perform the following tasks from the Declarative Page Flows subtab:

Managing Physical Pages Editing Physical Page Details

Managing Logical Pages Editing Logical Page Details

Managing Rules Editing Rule Details

Managing Business Flows Editing Business Flow Details Creating Flow Branches Duplicating Flows Viewing Flow Versions

For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Using the Declarative Page Flows Subtab

9-1

Managing Physical Pages

9.2 Managing Physical Pages


The main page for Physical Pages is the starting point for viewing, registering, and updating Physical Pages. Physical Pages are JavaServer Pages (JSPs). Use this procedure to manage Physical Pages. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2.

In the Design tab, navigate to Declarative Page Flows > Physical Pages. If you want to change which Physical Pages display in the table, then:
a. b. c.

To make Physical Pages from all applications to display in the table, then choose All from the drop-down list at the top of the table. If you want to filter the table by application, then choose a module prefix from the drop-down list labeled View at the top of the table. If you want to search the table of Physical Pages, then type the name of a Physical Page or part of the name of a Physical Page into the text input field. Optionally, use the percent sign (%) as a wild card in your search phrase. For example, the search phrase "sales%" returns the Physical Pages whose names begin with "sales." Alternatively, the search phrase "%sales" returns the Physical Pages whose names end with "sales." The search phrase "sales" returns the Physical Page named "sales."

d. 3. 4.

Click Go. The results display in the table.

If you want to register a Physical Page, then click Create. This opens the page where you edit the details of a new Physical Page. If you want to update an existing Physical Page, then click its name in the table. This opens the page where you edit the details of an existing Physical Page.

Related Procedures
Editing Physical Page Details Using Declarative Page Flows

9.3 Editing Physical Page Details


On the details page for Physical Pages, you complete the procedures of either registering or updating Physical Pages. Use this procedure to edit the details of new

9-2

Oracle CRM System Administrator Console Concepts and Procedures

Managing Logical Pages

or existing Physical Pages. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1.

In the Design tab, navigate to Declarative Page Flows > Physical Pages, then either click Create to register a new page or click the name of a JSP to modify its details. Type into the Name field to edit the name of the Physical Page. Type into the Description field to edit the description of the Physical Page. This field is optional. If you are registering a new Physical Page, then choose an application from the Application drop-down list. If you are updating an existing Physical Page, then you cannot edit this field. It is permanently set when you create the Physical Page. If you are registering a new Physical Page, then click Create to save. If you are updating an existing Physical Page, then click Update to save.

2. 3. 4.

5. 6.

Related Procedures
Managing Physical Pages Using Declarative Page Flows

9.4 Managing Logical Pages


The main page for Logical Pages is the starting point for viewing, creating, and updating Logical Pages. Logical Pages can be utilized either stand-alone or to represent nodes in a Business Flow. One or more Physical Pages map to each Logical Page. Use this procedure to manage Logical Pages. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2.

In the Design tab, navigate to Declarative Page Flows > Logical Pages. If you want to change which Logical Pages display in the table, then:
a.

If you want to allow Physical Pages from all applications to display in the table, then choose All from the drop-down list labeled View at the top of the table.

Using the Declarative Page Flows Subtab

9-3

Editing Logical Page Details

b. c.

If you want to filter the table by application, then choose a module prefix from the drop-down list labeled View at the top of the table. If you want to search the table of Physical Pages, then type the name of a Physical Page or part of the name of a Physical Page into the text input field. Optionally, use the percent sign (%) as a wild card in your search phrase. For example, the search phrase "sales%" returns the Physical Pages whose names begin with "sales." Alternatively, the search phrase "%sales" returns the Physical Pages whose names end with "sales." The search phrase "sales" returns the Physical Page named "sales."

d. 3. 4.

Click Go. The results display in the table.

If you want to create a Logical Page, then click Create. This opens the page where you edit the details of a new Logical Page. If you want to update an existing Logical Page, then click its name in the table. This opens the page where you edit the details of an existing Logical Page.

Related Procedures
Editing Logical Page Details Using Declarative Page Flows

9.5 Editing Logical Page Details


On the details page for Logical Pages, you complete the procedures of either creating or updating Logical Pages. Use this procedure to edit the details of new or existing Logical Pages. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2. 3. 4.

In the Design tab, navigate to Declarative Page Flows > Logical Pages, then either click Create or click a page name in the table. Type into the Name field to edit the name of the Logical Page. Type into the Description field to edit the description of the Logical Page. This field is optional. If you are creating a new Logical Page, then choose an application from the Application drop-down list. If you are updating an existing Logical Page, then you cannot edit this field. It is permanently set when you create the Rule.

9-4

Oracle CRM System Administrator Console Concepts and Procedures

Managing Rules

5.

Edit the Page Controller field if you do not want to use the default Java class which is prefilled in the field. The class designated here implements the Logical Page Controller interface and provides values to evaluate Rules. Type into the Default Physical Page field to edit the name of the Physical Page that displays when none of the Rules evaluate to true. Optionally, click Go to choose from a list of values. Edit the Page Display Rules table; one row in the table represents one Rule:
a. b. c. d.

6.

7.

Type into the Sequence column to edit the order in which the Rules are evaluated. Type into the Rule Name column to edit the name of the Rule. Optionally, click Go to choose from a list of values. Type into the Description column to edit the description of the Rule. Type into the Physical column to edit the name of the Physical Page that is associated with the Rule. Optionally, click Go to choose from a list of values.

8. 9.

Repeat step 7 as desired. Optionally, click Add Rows to add empty rows to the table.

10. If you are creating a new Logical Page, then click Create to save. 11. If you are updating an existing Logical Page, then click Update to save.

Related Procedures
Managing Logical Pages Using Declarative Page Flows

9.6 Managing Rules


The main page for Rules is the starting point for viewing, creating, and updating Rules. In the context of a Logical Page, Rules determine either what Physical Page needs to be rendered or what Logical Page displays next. Use this procedure to manage Rules. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1.

In the Design tab, navigate to Declarative Page Flows > Rules.

Using the Declarative Page Flows Subtab

9-5

Editing Rule Details

2.

If you want to change which Rules display in the table, then:


a. b. c.

If you want Rules from all applications to display in the table, then choose All from the drop-down list labeled View at the top of the table. If you want to filter the table by application, then choose a module prefix from the drop-down list labeled View at the top of the table. If you want to search the table of Rules, then type the name of a Rule or part of the name of a Rule into the text input field. Optionally, use the percent sign (%) as a wild card in your search phrase. For example, the search phrase "sales%" returns the Rules whose names begin with "sales." Alternatively, the search phrase "%sales" returns the Rules whose names end with "sales." The search phrase "sales" returns the Rule named "sales."

d. 3. 4.

Click Go. The results display in the table.

If you want to create a Physical Page, then click Create. This opens the page where you edit the details of a new Rule. If you want to update an existing Rule, then click its name in the table. This opens the page where you edit the details of an existing Rule.

Related Procedures
Editing Rule Details Using Declarative Page Flows

9.7 Editing Rule Details


On the details page for Rules, you complete the procedures of either creating or updating Rules. Use this procedure to edit the details of new or existing Rules. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2.

In the Design tab, navigate to Declarative Page Flows > Rules, then either click Create or click a Rule name in the table. Type into the Name field to edit the name of the Rule. If you are working with an existing Rule, then you cannot edit this field.

9-6

Oracle CRM System Administrator Console Concepts and Procedures

Managing Business Flows

3. 4.

Type into the Description field to edit the description of the Rule. This field is optional. If you are creating a new Rule, then choose an application from the Application drop-down list. If you are updating an existing Rule, then you cannot edit this field. It is permanently set when you create the Rule. Edit the Rule Conditions table; one row in the table represents one Rule Condition:
a. b. c.

5.

Type a parameter into the Parameter column. Choose an operator from the drop-down list in the Condition column. Type a value into the Value column.

6. 7. 8. 9.

Repeat step 5 as desired. Optionally, click Add Rows to add empty rows to the table. If you are creating a new Rule, then click Create to save. If you are updating an existing Rule, then click Update to save.

Related Procedures
Managing Rules Using Declarative Page Flows

9.8 Managing Business Flows


The main page for Business Flows is the starting point for viewing, creating, updating, previewing, and cloning Business Flows. Business Flows are page display sequences that address specific business processes. For example, you can create a Business Flow for the process of purchasing an item from an online store, or you can create a Business Flow for the process of resolving a users service request. Business Flows can be either linear or branched in structure. Use this procedure to manage Business Flows. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2.

In the Design tab, navigate to Declarative Page Flows > Business Flows. If you want to change which Business Flows display in the table, then:

Using the Declarative Page Flows Subtab

9-7

Managing Business Flows

a.

If you want Business Flows from all applications to display in the table, then choose All from the drop-down list labeled View at the top of the table. If you want to filter the table by application, then choose a module prefix from the drop-down list labeled View at the top of the table. If you want to search the table of Business Flows, then type the name of a Business Flow or part of the name of a Business Flow into the text input field. Optionally, use the percent sign (%) as a wild card in your search phrase. For example, the search phrase "sales%" returns the Business Flows whose names begin with "sales." Alternatively, the search phrase "%sales" returns the Business Flows whose names end with "sales." The search phrase "sales" returns the Business Flow named "sales."

b. c.

d. 3. 4. 5. 6. 7. 8.

Click Go. The results display in the table.

To update an existing Business Flow, click its name in the table. To create a branch in this Business Flow, click the icon in the Create Flow Branch column. To preview an existing Business Flow, click the icon in the Preview column. To view the different versions of a flow, then click the icon in the View Versions column. If you want to create a Business Flow, then click Create Flow. If you want to create a duplicate of a flow, then click Duplicate Flow.

Related Procedures
Editing Business Flow Details Creating Flow Branches Duplicating Flows Viewing Flow Versions Using Declarative Page Flows

9-8

Oracle CRM System Administrator Console Concepts and Procedures

Creating a New Business Flow

9.9 Editing Business Flow Details


On the details page for Business Flows, you can edit the basic settings of new or existing Business Flows. After using this page, you can open the Map Flows page to define the conditional branches in the Business Flow. Use one of the following procedures: Creating a New Business Flow Updating an Existing Business Flow For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

9.10 Creating a New Business Flow


Use this procedure to edit the basic settings of a new business flow. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2. 3. 4. 5. 6.

In the Design tab, navigate to Declarative Page Flows > Business Flows, then click Create. Type a flow name into the Name field. Choose an application from the Application drop-down list. Optionally, type a description into the Description field. Optionally, select the Secure check box if the flow is to use HTTPS. Edit the Finalization Class field if you want use a Java class other than the default Finalization Class (which is prefilled in the field). The class designated here implements the FlowFinalizer interface and executes at the end of the Business Flow. Type the name of the Logical Page that should be invoked after the completion of the flow into the Page to Display After Completing the Flow field. Optionally, click Go to choose from a list of values. Type the name of the first Logical Page in the flow into the First Page of the Flow field. Optionally, click Go to choose from a list of values.

7.

8.

Using the Declarative Page Flows Subtab

9-9

Updating an Existing Business Flow

9.

Optionally, edit the Default Flow Sequence table; if the flow you are creating is linear, then complete this table. If the flow you are creating has conditional branches, then proceed to step 10.
a. b.

Type numbers into the Sequence fields to indicate the page order within the flow. Click Go to choose a Logical Page to set as the Next Logical. When you make your choice, the Next Logical and Description fields will automatically fill. Repeat step b as desired. If needed, click Add Rows to add additional rows to the table.

c.

10. Click Create to save. 11. Click Create Flow Branch. This opens the page where you define the

conditional branches of a nonlinear flow.


12. Optionally, click View Flow Versions to view all the versions of this business

flow.

Related Procedures
Managing Business Flows Using Declarative Page Flows

9.11 Updating an Existing Business Flow


Use this procedure to edit the basic settings of an existing business flow. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2. 3. 4.

In the Design tab, navigate to Declarative Page Flows > Business Flows, then click a flow name in the table. Optionally, type a flow description into the Description field. Optionally, select the Secure check box if the flow is to use HTTPS. Type the name of the Finalization Class into the Finalization Class field. This is the name of a Java class. The class implements the FlowFinalizer interface and executes at the end of the Business Flow.

9-10

Oracle CRM System Administrator Console Concepts and Procedures

Creating Flow Branches

5.

Type the name of the Logical Page that should be invoked after the completion of the flow into the Page to Display after Completing the Flow field. Optionally, click Go to choose from a list of values. Type the name of the first Logical Page in the flow into the First Page of the Flow field. Optionally, click Go to choose from a list of values. If the flow you are working with is linear (does not contain any conditional branches), then you can define the flow sequence in the Default Flow table. Click Update to save. If the flow you are working with is nonlinear (contains one or more conditional branches), then click Create Flow Branch to begin defining the branches of the flow.

6. 7. 8. 9.

10. To view the different versions of this flow, click View Flow Versions.

Related Procedures
Managing Business Flows Using Declarative Page Flows

9.12 Creating Flow Branches


Business Flows are page display sequences that address specific business processes. The Create Flow Branch page allows you to define conditional branches within nonlinear business flows. Use this procedure to set the sequences of Logical Pages within Business Flows. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1.

Choose a Logical Page from the Current Logical drop-down list. The Current Logical Page is the name of the Logical Page that you are setting up on this screen. After you save your work, you can repeat this entire procedure with another Logical Page within the Business Flow. In the Default Next Logical field, type the name of the Logical Page that displays if there are no Rules in the table below, or if none of the Rules in the table below evaluate to "true." Optionally, click Go to choose from a list of values. Edit the Logical Node Rules table.

2.

3.

Using the Declarative Page Flows Subtab 9-11

Duplicating Business Flows

a. b.

Type numbers into the Sequence fields to set the order in which the Rules are evaluated. In the Next Logical fields, type the name of the Logical Page that you want to display after the Current Logical Page, only if the Rule in the next column evaluates to "true." Optionally, click Go to choose from a list of values. In the Rule Name fields, type name of the Rule that controls whether or not the Logical Page in the previous column displays. Optionally, click Go to choose from a list of values.

c.

4. 5.

Optionally, click Add Rows to add empty rows to the table. If you are creating a new Current Logical Page setup, then click Create to save. This opens another Create Flow Branch page where you can repeat this entire procedure with another Current Logical Page. If you are updating an existing Flow Branch setup, then click Update to save. This opens another Create Flow Branch page where you can repeat this entire procedure with another Current Logical Page. If you have no more Current Logical Pages to set up, then click Finish. This completes the procedures of either creating or updating Business Flows.

6.

7.

Related Procedures
Managing Business Flows Using Declarative Page Flows

9.13 Duplicating Business Flows


Use this procedure to duplicate business flows. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2. 3.

In the Design tab, navigate to Declarative Page Flows > Business Flows, then click Duplicate Flow. Click Go to choose the flow from a list of values. Edit the name of the flow if desired. Click Duplicate to generate a duplicate of the flow. The Flow Details page automatically opens, where you can edit the details of the duplicate flow.

9-12

Oracle CRM System Administrator Console Concepts and Procedures

Viewing Flow Versions

Related Procedures
Managing Business Flows Using Declarative Page Flows

9.14 Viewing Flow Versions


Use this procedure to view all of the versions of a given business flow. For an introduction to Declarative Page Flows concepts, please see Understanding Declarative Page Flows.

Steps
1. 2. 3.

Choose which of the flows will be "active" by selecting the appropriate radio button in the table. Click Update to save. Optionally, click a flow name in the table. This opens the page where you can edit the basic details of an existing flow.

Related Procedures
Managing Business Flows Using Declarative Page Flows

Using the Declarative Page Flows Subtab 9-13

Viewing Flow Versions

9-14

Oracle CRM System Administrator Console Concepts and Procedures

10
Using the Declarative Components Subtab
10.1 Using Declarative Components
The Declarative Components framework enables you to quickly develop bins, graphs, reports, graph/report combinations, and LOVs that can be personalized by end users. Key features of the Declarative Components framework include the uniform look and feel of all UI components, compatibility with multiple data sources, and built in security. You can perform the following tasks from the Declarative Components subtab:

Managing Components Previewing Components Registering Components * Editing Component Metadata

Defining Bin or Report Columns Editing Bin or Report Column Details

Managing LOV Columns Editing LOV Column Details

Defining Graph Metadata Managing Graph Columns * Editing Graph Column Details

Managing Parameters Editing Parameter Metadata

Managing Component Security

Using the Declarative Components Subtab 10-1

Managing Components

Assigning a Responsibility to Components * Selecting Components

Assigning a Component to Responsibilities * Selecting Responsibilities

For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

10.2 Managing Components


The main page for Declarative Components is the starting point for viewing, creating, modifying, and previewing bins, graphs, reports, graph/report combinations, and LOVs. Use this procedure to manage Declarative Components. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2.

In the Design tab, navigate to Declarative Components > Components. If you want to change the contents of the table, then:
a. b. c.

To filter the table by application, choose an application from the Application drop-down list at the top of the page. To filter the table by component type, then choose All or a component type from the drop-down list at the top of the page. If you want to search by component code, then type the component code into the text entry field and click Go. The wild card character (%) is allowed. The search is case sensitive.

d. 3. 4. 5.

Click First, Previous, Next, and Last to navigate within the table.

If you want to create a component, then click Create. This opens the page where you register a new component. If you want to preview a component, then click Preview. This opens the page where you preview a component. If you want to update or modify a component, then click its component code in the table. This opens the page where you update the registration of a component.

10-2

Oracle CRM System Administrator Console Concepts and Procedures

Previewing Components

6.

If you want to set the status of a component, then:


a.

In the Action column, choose Remove, Enabled, or Disabled. Removing a component deletes it. You cannot delete a LOV component if it is being used by other components. Enabling a component makes it available for display. Disabling a component makes it unavailable for display or for selection from the homepage.

b.

Click Update to save.

Related Procedures
Previewing Components Registering Components Using Declarative Components

10.3 Previewing Components


Use this procedure to preview a declarative component. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2.

In the Design tab, navigate to Declarative Components > Components, then click Preview. View the preview. In the case of a LOV component, the Preview does not have validations. Use the wildcard character (%) in the text entry field.

3.

When you are finished, click OK to return to the main components page.

Related Procedures
Registering Components Managing Components Using Declarative Components

Using the Declarative Components Subtab 10-3

Registering Components

10.4 Registering Components


Use this procedure to edit the registration details of a new or existing component. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2.

In the Design tab, navigate to Declarative Components > Components, then either click Create or click a component code in the table. If you are creating a new component, then choose an application from the Application drop-down list at the top of the page. If you are updating an existing component, this field is not editable. If you are creating a new component, then choose Bin, Report, Graph, Graph Report, or LOV from the Component Type drop-down list. If you are updating an existing component, this field is not editable. If you are creating a new component, then type a component code into the Component Code field. If you are updating an existing component, this field is not editable. The maximum length of a component code is 26 characters. A component code must be unique and it cannot contain any spaces or nonalphanumeric characters except underscore (_). It is recommended to prefix the component code with the application short name. For example, JTF_component_code.

3.

4.

5. 6.

Type a descriptive component name into the Component Name field. Optionally, type a description into the Description field. If you want to enable the component, then select the Enable check box. If you want to disable the component, then deselect the Enable check box. Enabling a component makes it available for display. Disabling a component makes it unavailable for display or for selection from the homepage.

7.

If you want to allow the component to be a candidate for display as a Portlet in Oracle Portal, then select the Show as Portlet check box. If you deselect this check box, then the component will not be shown in the list of available components for Portlet enabling. Optionally, type an image filename into the Image Filename field. If defined, this image is displayed with the Bin Title. The image that you specify must exist in the image file location (/OA_MEDIA/).

8.

10-4

Oracle CRM System Administrator Console Concepts and Procedures

Editing Component Metadata

9.

Ignore the Metadata Source area. The only choice for the Type field is AK. The Declarative Components framework uses the AK Runtime Dictionary to store metadata.

10. Optionally, click Restore to restore the fields to their original settings. 11. Click Update to save. 12. Click Next. This opens the page where you can begin editing the metadata

associated with this component.

Related Procedures
Editing Component Metadata Managing Components Using Declarative Components

10.5 Editing Component Metadata


Use this procedure to edit the Pre-Process type, Data Source, Title, and other general settings (such as headers and footers) of a new or existing Declarative Component. This procedure takes place after you have completed the Registering Components procedure. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1.

Edit the Pre-Process area:


a.

If you want to execute a PL/SQL procedure or Java method before the Declarative Components framework extracts the data content for this component, then choose Java Class Name or PL/SQL Procedure from the Type drop-down list. If you do not require a preprocessing event, then leave this field blank and skip to step 2.

b.

Type the preprocessing PL/SQL procedure or Java method into the Name field. The procedure name should be of the format procedure_name.package_ name, where the package name is the fully qualified package name.

2.

Edit the Data Source Provider area:


a.

If you are editing a Bin, Report, Graph, or Graph Report, then choose HTML, Class Name, or SQL Query from the Type drop-down list.

Using the Declarative Components Subtab 10-5

Editing Component Metadata

If you are editing a LOV component, then choose Class Name or SQL Query from the drop-down list, as the valid data source types for LOV components are Java and SQL.
b.

Type HTML code, a SQL query, or the name of a Java class that implements the DataSource interface into the Name field. If you use a SQL query, then the SELECT statement must not end with a semicolon (;).

3.

If you are editing a Bin, Report, Graph, or Graph Report, then edit the Custom Edit Link area. This feature is not available for LOVs.
a.

If you do not want a Custom Edit Link, then leave this section blank and skip to step 4. This generates the default Edit link that navigates you to the Personalization and Runtime Parameter section. If you want the Custom Edit Link to have a constant value, then choose Constant from the Type drop-down list. If you want the Custom Edit Link to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.

b.

c.

If the Custom Edit Link is constant, then type the name of the JSP file into the Name field. If the Custom Edit Link is dynamically generated, then type the name of the PL/SQL package.procedure or Java Class.method into the Name field. The PL/SQL procedure must take in a single DEFAULT NULL VARCHAR2 argument and return a VARCHAR2. The Java method should take in a ParameterList and return a String.

d. 4.

If you do not want the Edit link to be generated, then choose Constant from in the Type drop-down list and leave the Name field blank.

Edit the Title area:


a.

If you want the component title to have a constant value, then choose Constant from the Type drop-down list. If you want the component title to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.

b.

If the component title is constant, then type the title text into the Name field. If the component title is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Name field. The PL/SQL procedure must return a value of the type VARCHAR2.

10-6

Oracle CRM System Administrator Console Concepts and Procedures

Editing Component Metadata

c. d.

Choose Left, Right, or Center from the Alignment drop-down list to set how the component title is aligned. If you are editing a Bin, Report, Graph, or Graph Report and want to allow the end user to personalize the component title, then select the check box labeled Personalizable.

5.

If you are editing a Bin, Report, Graph, or Graph Report, then edit the Header area. This feature is not available for LOVs.
a.

If you want the header to have a constant value, then choose Constant from the Type drop-down list. If you want the header to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.

b.

If the header is constant, then type the text into the Name field. If the header is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Name field. The PL/SQL procedure must return a value of the type VARCHAR2.

c. d. 6.

Choose Left, Right, or Center from the Alignment drop-down list to set how the header is aligned. If you want to allow the end user to personalize the header, then select the check box labeled Personalizable.

If you are editing a Bin, Report, Graph, or Graph Report, then edit the Footer area. This feature is not available for LOVs:
a.

If you want the footer to have a constant value, then choose Constant from the Type drop-down list. If you want the footer to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.

b.

If the footer is constant, then type the text into the Name field. If the footer is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Name field. The PL/SQL procedure must return a value of the type VARCHAR2.

c. d.

Choose Left, Right, or Center from the Alignment drop-down list to set how the footer is aligned. If you want to allow the end user to personalize the footer, then select the check box labeled Personalizable.

Using the Declarative Components Subtab 10-7

Defining Bin or Report Columns

7. 8.

Click Update to save. Optionally, click Next to save and move on to screens where you can further define the columns and settings of the component.

Related Procedures
Defining Bin or Report Columns Managing LOV Columns Defining Graph Metadata Using Declarative Components

10.6 Defining Bin or Report Columns


Use this procedure to manage the columns in a new or existing bin or report component. This does not apply to components with a HTML Data Source Type. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1.

To navigate to this page:


a. b. c.

In the Design tab, navigate to Declarative Components > Components. Locate your desired bin or report in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the Component Columns page.

2. 3. 4.

Select or deselect the check box labeled Number Of Rows to enable or disable allowing the end user to personalize the number of rows displayed. Select or deselect the check box labeled Number Of Columns to enable or disable allowing the end user to personalize the number of columns displayed. If you want to set the status of a column, then choose Enabled or Disabled from the Action column. Enabling a component makes it available for display. Disabling a component makes it unavailable for display. Type integers into the Display Order column to set the display order (from left to right) of the columns in the Bin or Report. Make sure that the values of this field are sequential.

5.

10-8

Oracle CRM System Administrator Console Concepts and Procedures

Editing Bin or Report Column Details

6. 7. 8.

Click Update to save. Optionally, click Next. This opens the page where you manage the parameters of the component. If you want to edit the details of a column, then click its name in the table. This opens the page where you edit the details of a column.

Related Procedures
Editing Bin or Report Column Details Managing Parameters Using Declarative Components

10.7 Editing Bin or Report Column Details


Use this procedure to edit the details of columns in bin or report components. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1.

To navigate to this page:


a. b. c. d.

In the Design tab, navigate to Declarative Components > Components. Locate your desired bin or report in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the Component Columns page. Click a column name in the table to open the column details page.

2. 3. 4.

Optionally, type a brief description of the column into the Description field. Type an integer into the Display Order field to set the display order of the column. Edit the Label area:
a.

If you want the column label to have a constant value, then choose Constant from the Type drop-down list.

Using the Declarative Components Subtab 10-9

Managing LOV Columns

If you want the column label to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.
b.

If the column label is constant, then type the text into the Method field. If the column label is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Method field. The PL/SQL procedure must return a value of the type VARCHAR2. The Java method must be of the format ClassName.MethodName.

c. d. e. f. g.

Choose Left, Right, or Center from the Horizontal Alignment drop-down list to set how the column label is aligned. Select the check box labeled Raw Column if you want to display the column as a raw column. If you selected the Raw Column check box, then type the appropriate URL into the URL field. Choose the name of the ID column associated with the hyperlink from the ID column drop-down list. Type a value into the Low Watermark field. When the component is displayed, any values below the Low Watermark value will display in a negative color. Type a value into the High Watermark field. When the component is displayed, any values above the High Watermark value will display in a positive color.

h.

5. 6.

Click Update to save. Click Component Columns to return to the page that lists the components columns.

Related Procedures
Defining Bin or Report Columns Using Declarative Components

10.8 Managing LOV Columns


Use this procedure to manage the columns in a new or existing LOV component. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

10-10 Oracle CRM System Administrator Console Concepts and Procedures

Managing LOV Columns

The LOVs that you create can be used across applications. LOV means "list of values." It is a UI component that facilitates the completion of a text entry field when there are numerous values that may be assigned. LOVs are a useful alternative to drop-down lists, particularly in cases where displaying a long list of selections in a drop-down list would require excessive scrolling. In short, when using a LOV to complete a text entry field, you type a query into the field and then click a button labeled Go. This opens a screen where you view a list of values that match the query you submitted. You can then select the value that you desire and return to the original screen, where what you selected will populate the original text entry field.

Steps
1.

To navigate to this page:


a. b. c.

In the Design tab, navigate to Declarative Components > Components. Locate your desired LOV in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the LOV Columns List page.

2. 3. 4. 5. 6.

Choose a radio button in the Select column of the table to specify that column as searchable. Choose Enabled or Disabled from the Action column in the table to make the column available or unavailable for display. Type an integer into the Display Order field to set the display order of the column. Make sure that the values of this field are sequential. Click Update to save. Note that you do not define parameters for LOV components. If you want to edit the details of a column, then click its name in the table. This opens the page where you edit the details of a column.

Related Procedures
Editing LOV Column Details Using Declarative Components

Using the Declarative Components Subtab

10-11

Editing LOV Column Details

10.9 Editing LOV Column Details


Use this procedure to edit the details of columns in a new or existing LOV component. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components. The LOVs that you create can be used across applications. LOV means "list of values." It is a UI component that facilitates the completion of a text entry field when there are numerous values that may be assigned. LOVs are a useful alternative to drop-down lists, particularly in cases where displaying a long list of selections in a drop-down list would require excessive scrolling. In short, when using a LOV to complete a text entry field, you type a query into the field and then click a button labeled "Go." This opens a screen where you view a list of values that match the query you submitted. You can then select the value that you desire and return to the original screen, where what you selected will populate the original text entry field.

Steps
1.

To navigate to this page:


a. b. c. d.

In the Design tab, navigate to Declarative Components > Components. Locate your desired LOV in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the LOV Columns List page. Click a column name in the table to open the column details page.

2. 3. 4. 5.

Optionally, type a brief description of the column into the Description field. Type an integer into the Display Order field to set the display order of the column. Choose a column type of Date, Number, or Varchar2 from the Column Type drop-down list. If the column is searchable on the main LOV columns page, then the check box fields for Display and Carry Over are automatically selected and cannot be deselected. If the column is not searchable on the main LOV columns page, then you can select or deselect these two check boxes. Edit the Label area:
a.

6.

If you want the column label to have a constant value, then choose Constant from the Type drop-down list.

10-12 Oracle CRM System Administrator Console Concepts and Procedures

Editing LOV Column Details

If you want the column label to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.
b.

If the column label is constant, then type the text into the Method field. If the column label is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Method field. The PL/SQL procedure must return a value of the type VARCHAR2. The Java method must be of the format ClassName.MethodName.

7.

If the column is searchable on the main LOV columns page, then you will see a section for Validation Rules. If the column is not searchable on the main LOV columns page, then this feature is not available.
a. b.

If you want to choose a Javascript Validation Type, then select Error or Warning from the drop-down list. Otherwise, leave the field blank. In the Min. Characters field, type an integer representing the minimum number of characters the user is required to submit when using the LOV component. In the Min. Characters before % field, type an integer representing the minimum number of characters the user is required to submit before the wildcard character (%) when using the LOV component. Select or deselect the Auto Append % check box to choose whether or not to automatically append any queries submitted by the user with the wildcard character (%). If you want to specify the case of the value when it populates the original text entry field, then choose Lowercase or Uppercase from the Change Case drop-down list.

c.

d.

e.

8. 9.

Click Update to save. Note that you do not define parameters for LOV components. Optionally, click LOV Column List to return to the page that lists the components columns.

Related Procedures
Managing LOV Columns Using Declarative Components

Using the Declarative Components Subtab

10-13

Defining Graph Metadata

10.10 Defining Graph Metadata


Use this procedure to edit the X-axis, Y-axis, and other basic settings of a new or existing graph component. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1.

To navigate to this page:


a. b. c.

In the Design tab, navigate to Declarative Components > Components. Locate your desired graph or graph-report in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the Graph Metadata page.

2. 3.

Optionally, type a description of the graph into the Description field. If you want the graph title to have a constant value, then choose Constant from the Type drop-down list. If you want the graph title to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.

4.

If the graph title is constant, then type the text into the Method field. If the column label is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Method field. The PL/SQL procedure must return a value of the type VARCHAR2. The Java method must be of the format ClassName.MethodName.

5. 6. 7. 8. 9.

Choose a graph type from the Graph Type drop-down list. If you want to allow the end user to personalize the graph type, then select the check box labeled Allow Personalization? If you want the graph to display in 2D, then select the check box labeled Display in 2-D? If you want to display or not display a grid, then choose an option from the Display Grid drop-down list. To set how the graph legend displays, choose an option from the Graph Legend drop-down list. Set the position of the graph legend in the Legend Position drop-down list.

10. Type pixel values into the Graph Height and Graph Width fields.

10-14 Oracle CRM System Administrator Console Concepts and Procedures

Defining Graph Metadata

11. Type a number into the Graph Color field to set the graph color. 12. Edit the X-axis section: a.

If you want the X-axis label to have a constant value, then choose Constant Value from the Label Type drop-down list. If you want the X-axis label to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Label Type drop-down list.

b.

If the X-axis label is constant, then type the text into the Method field. If the X-axis label is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Method field. The PL/SQL procedure must return a value of the type VARCHAR2. The Java method must be of the format ClassName.MethodName.

c.

Choose Vertical, Horizontal or Slanting from the Tick Label Orientation drop-down list. Vertical orientation tilts the tick label 90 degrees. Horizontal orientation tilts the tick label 180 degrees. Slanted orientation tilts the tick label 270 degrees.

d.

Choose the amount of tick labels you want to display in the Tick Label Interval drop-down list.

13. Edit the Y-axis section: a.

If you want the Y-axis label to have a constant value, then choose Constant Value from the Label Type drop-down list. If you want the Y-axis label to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Label Type drop-down list.

b.

If the Y-axis label is constant, then type the text into the Method field. If the Y-axis label is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Method field. The PL/SQL procedure must return a value of the type VARCHAR2. Java method must be of the format ClassName.MethodName.

c.

Choose Vertical, Horizontal or Slanting from the Tick Label Orientation drop-down list. Vertical orientation tilts the tick label 90 degrees. Horizontal orientation tilts the tick label 180 degrees. Slanted orientation tilts the tick label 270 degrees.

Using the Declarative Components Subtab

10-15

Managing Graph Columns

d. e.

To display the Y-axis as currency, select the Display Currency? check box. Choose Yes or No from the Auto Scaling drop-down list. If you choose Yes, then the minimum and maximum values displayed on the Y-axis are determined by BI Beans, depending on the graph data. If you choose No, then the minimum and maximum values displayed on the Y-axis are specified manually.

f. g.

If you chose No in step d, then type an integer into the Tick Interval field to specify the interval on the Y-axis scale. If you chose No in step d, then enter integers into the Minimum Value and Maximum Value fields.

14. Click Update to save. 15. Click Next to open the page where you manage the columns of the graph

component.

Related Procedures
Managing Graph Columns Editing Graph Column Details Using Declarative Components

10.11 Managing Graph Columns


Use this procedure to view, update, and remove columns in a graph component. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1.

To navigate to this page:


a. b. c. d.

In the Design tab, navigate to Declarative Components > Components. Locate your desired graph or graph-report in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the Graph Metadata page. Click Next a third time to open the Graph Columns page.

10-16 Oracle CRM System Administrator Console Concepts and Procedures

Editing Graph Column Details

2.

If you want to set the status of a column, then choose Enabled or Disabled from the Action column. Enabling a component makes it available for display. Disabling a component makes it unavailable for display.

3. 4. 5. 6.

For each column, choose X-axis, Y-axis, or SubX-axis from the Axis drop-down list. Type integers into the Sequence fields to set the sequence of the columns. Click Update to save. Optionally, click Next. This opens the page where you manage the parameters of the component.

7.

If you want to edit the details of a column, then click its name in the table. This opens the page where you edit the details of a column.

Related Procedures
Editing Graph Column Details Managing Parameters Using Declarative Components

10.12 Editing Graph Column Details


Use this procedure to edit the details of new or existing columns in graph components. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1.

To navigate to this page:


a. b. c. d.

In the Design tab, navigate to Declarative Components > Components. Locate your desired graph or graph-report in the table. Click its component code in the table. Click the Next button, once on the Component Registration page and again on the Component Metadata page to open the Graph Metadata page. Click Next a third time to open the Graph Columns page.

Using the Declarative Components Subtab

10-17

Managing Parameters

e. 2. 3.

Click a column name in the table.

Optionally, type a description into the Description field. Edit the Label section:
a.

If you want the column label to have a constant value, then choose Constant Value from the Type drop-down list. If you want the column label to be dynamically generated by a PL/SQL procedure or Java method, then choose PL/SQL or Java from the Type drop-down list.

b.

If the column label is constant, then type the text into the Method field. If the column label is dynamically generated, then type the name of the PL/SQL procedure or Java method into the Method field. The PL/SQL procedure must return a value of the type VARCHAR2. The Java method must be of the format ClassName.MethodName.

4.

Edit the Axis section:


a. b.

Choose X-axis, Y-axis, or SubX-axis from the Plot drop-down list. Type the appropriate integer into the Sequence field. The sequence number is with respect to axis information. It is the indexing information for columns mapped on the same axis. For example, if COL1 and COL3 are plotted on the Y-axis, then they should have the sequence numbers 1 and 2, respectively. COL2 plotted on the X-axis should have the sequence number 1.

5. 6.

Click Update to save. Click Graph Columns to return to the page that lists the components columns.

Related Procedures
Managing Graph Columns Using Declarative Components

10.13 Managing Parameters


Use this procedure to create, update, and remove component parameters. You can define date pickers (calendars), text input fields, drop-down lists, multi-select lists, and hidden fields. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

10-18 Oracle CRM System Administrator Console Concepts and Procedures

Editing Parameter Metadata

Steps
1.

You reach this page by clicking Next from the column summary page of a component. Please see Defining Bin or Report Columns and Managing Graph Columns. If you want to create a parameter, then click Create Parameter. This opens the page where you edit the details of a new parameter.

2.

3. 4. 5. 6.

If you want to delete a parameter, then select the appropriate check box in the Remove column of the table. Type integers into the Sequence fields to set the order in which the parameters will be rendered. This order is also used in parameter value resolution. Click Update to save. If you want to edit the details of a parameter, then click its name in the table.

This opens the page where you edit the details of an existing parameter.

Related Procedures
Using Declarative Components

10.14 Editing Parameter Metadata


Use this procedure to edit the details of a new or existing component parameter. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2. 3. 4. 5. 6.

You reach this page from the Component Parameters page: Click either a parameter name or the Create Parameters button. Type a unique parameter name into the Parameter Name field (this field is not editable if you are working with a parameter that already has been defined). Type a label for the parameter in to the Label field. Select the Enable? check box if you want to enable the parameter. Optionally, type a brief description into the Description field. If you want the parameter to be rendered on the parameter page, then select the check box labeled Enable.

Using the Declarative Components Subtab

10-19

Editing Parameter Metadata

7. 8. 9.

If you want to allow the end user to personalize the parameter, then select the check box labeled Personalizable. Choose VARCHAR2, Number, or Date from the Parameter Data Type drop-down list. Choose Calendar, Drop Down, Hidden, LOV, Multiselect, or Text from the Item Style drop-down list. For drop-down lists, you are responsible for writing a well-tuned query that will return the number of rows as recommended by the UI team. For hidden fields, the end user will not see the parameter, but you can use the value as needed (for example, passing ID columns).

10. If you chose the Item Style Drop Down in step 6, then type the appropriate

source SQL query into the SQL for Dropdown field.


11. If you chose the Item Style LOV in step 6, then the screen refreshes to display a

section about LOV details. This section includes fields for LOV App Id, LOV Component Code, and Mapped LOV Column:
a.

Choose an LOV App Id from the drop-down list. This is the application that owns the LOV component. When you have chosen the application, the screen refreshes to display a list of LOV components specific to that application. Choose a LOV component from the list of available choices. The screen refreshes to display the list of searchable columns that can be mapped to the current parameter. Choose the Searchable LOV column and map it to this parameter. You may need to create additional parameters if you want to carry over ID Columns.

b.

c. d.

12. If you chose the Item Style LOV in step 6 and there is a LOV parameter already

defined for this component, then the screen refreshes to display a drop-down list called Related LOV Parameter. The drop-down list contains all the LOV parameters that have been defined for this component:
a.

Choose a LOV parameter as the Related LOV parameter. The screen refreshes to display a list of the Carried Over Column(s) of the chosen LOV parameter. The Mapped LOV Column drop-down list displays the LOV Columns that have been defined to be carried over. Therefore, you can use the value of this Mapped LOV Column, for example, in a Data Source Query.

b.

10-20 Oracle CRM System Administrator Console Concepts and Procedures

Managing Component Security

13. If available, edit the Default Value Setting section: a. b.

Choose Constant, PL/SQL, or Java from the Type drop-down list. If you chose Constant in step a, then type the text of the default value into the Name field. If you chose PL/SQL in step a, then type the complete signature of a PL/SQL function, including any package name, into the Name field. This function must return a Varchar2. For example, My_Package.Get_Default_ Value(?P_Context). Optionally, the function can take a p_context as an argument. If you chose Java in step a, then type the signature of a Java method into the Name field, in the format package_name.function_name. This method must return a string.

14. Click Update to save. 15. Optionally, click Component Parameter to return to the page that lists the

components parameters.

Related Procedures
Managing Parameters Using Declarative Components

10.15 Managing Component Security


Use this procedure to manage component security assignments. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2. 3.

In the Design tab, navigate to Declarative Components > Component Security. Choose a radio button, Component to Responsibilities or Responsibility to Components. Click Next. This opens the page where you choose either the component that you will be mapping to responsibilities or the responsibility that you will be assigning to components.

Using the Declarative Components Subtab

10-21

Assigning a Component to Responsibilities

Related Procedures
Assigning a Component to Responsibilities Assigning a Responsibility to Components Using Declarative Components

10.16 Assigning a Component to Responsibilities


Use this procedure to assign a component to one or more responsibilities. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2. 3. 4.

In the Design tab, navigate to Declarative Components > Component Security, then select the radio button labeled Component to Responsibilities. Choose an application from the Application Code drop-down list. Choose a component code from the Component Code drop-down list. Click Next to continue.

Related Procedures
Selecting Responsibilities Managing Component Security Using Declarative Components

10.17 Selecting Responsibilities


Use this procedure to select which responsibilities will apply to the component that you have chosen. This procedure takes place after you have completed the e Assigning a Component to Responsibilities procedure. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2.

Choose the name of a responsibility in one list and click > or < to move it to the other list. Repeat step 1 as desired.

10-22 Oracle CRM System Administrator Console Concepts and Procedures

Assigning a Responsibility to Components

3. 4. 5. 6. 7.

If you want to move all Available Responsibilities to the Selected Responsibilities list, then click >>. If you want to move all Selected Responsibilities to the Available Responsibilities list, then click <<. Optionally, choose an application from the Responsibility App Code drop-down list. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

Related Procedures
Managing Component Security Using Declarative Components

10.18 Assigning a Responsibility to Components


Use this procedure to assign a responsibility to one or more components. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2. 3. 4.

In the Design tab, navigate to Declarative Components > Component Security, then select the radio button labeled Responsibility to Components. Choose an application from the Responsibility App Code drop-down list. Choose a responsibility from the Responsibility drop-down list. Click Next to continue.

Related Procedures
Selecting Components Managing Component Security Using Declarative Components

Using the Declarative Components Subtab

10-23

Selecting Components

10.19 Selecting Components


Use this procedure to select which components will apply to the responsibility that you have chosen. This procedure takes place after you have completed the procedure Assigning a Responsibility to Components. For an introduction to Declarative Components concepts, please see the topic Understanding Declarative Components.

Steps
1. 2. 3. 4. 5. 6. 7.

Choose the name of a component in one list and click > or < to move it to the other list. Repeat step 1 as desired. If you want to move all Available Components to the Selected Components list, then click >>. If you want to move all Selected Components to the Available Components list, then click <<. Optionally, choose an application from the Component App Code drop-down list. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

Related Procedures
Managing Component Security Using Declarative Components

10-24 Oracle CRM System Administrator Console Concepts and Procedures

11
Using the Homepage Subtab
11.1 Configuring Default Homepages
Use this procedure to set up default homepages for users who do not personalize their homepages. If a homepage is configured for a particular responsibility, then all users of that responsibility who have not already personalized their homepages will see this configuration by default. As soon as a user personalizes his or her homepage, then the default configuration will no longer be seen. A homepage has either two columns or three columns. Components in a column are selected from an available list and laid out vertically. For more information on UI components, please see Understanding Declarative Components.

Steps
1. 2. 3. 4.

In the Design tab, navigate to Homepage > Configuration. Choose an application name from the Select an application drop-down list. Choose a responsibility from the Select a responsibility drop-down list. Choose a layout, either Two Columns or Three Columns, from the Select a layout drop-down list. Once you have set the value of this field, do not change it again unless you are willing to lose all edits you have made to the column setup lists below. Set up the bins and modules that will display in each column as follows:
a. b. c.

5.

Choose the name of a bin or module in one list and click > or < to move it to the other list. Repeat step b as desired. If you want to move all bins or modules from one list to the other, then click >> or <<.

Using the Homepage Subtab 11-1

Configuring Default Homepages

d.

In a Displayed Bins or Displayed Modules list, you can highlight and entry and then click the up and down arrows to set the order in which bins or modules displays in that column.

6.

Click Update to save.

11-2

Oracle CRM System Administrator Console Concepts and Procedures

12
Setting Profile Options
12.1 Setting Navigation Preferences
Use this procedure to set navigation preferences.

Steps
1. 2. 3.

Click the Profile button, then select Navigation Preferences. If you want to change your current responsibility, then choose an option from the Current Responsibility drop-down list. If you want to set default responsibilities for registered Navigation Groups, then choose from the drop-down lists in the Default Responsibility column. For information on Navigation Groups, please see Understanding the Interapplication Bar and Setting Up the Interapplication Bar.

4. 5.

Optionally, click Restore to reset the fields to their original settings. Click Update to save.

12.2 Setting Display Preferences


Use this procedure to set display preferences.

Steps
1. 2.

Click the Profile button, then select Display Preferences. Choose options from the drop-down lists in the General Display section to select language, currency, date format, time zone, and display style settings.

Setting Profile Options

12-1

Setting Up the Quick Menu

3.

Choose numbers from the drop-down lists in the Table Display section to select how many rows to display per page and how many blank rows to display per table. In the Search Display section, choose the radio button that suits how you want the Quick Find to return results. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

4. 5. 6.

12.3 Setting Up the Quick Menu


The Quick Menu is a feature that allows you to display links to your most frequently visited pages on the Introduction pages of every subtab in the System Administrator Console. Use this procedure to choose which pages have links in the Quick Menu and also turn the Quick Menu on or off.

Steps
1. 2. 3. 4. 5. 6. 7. 8. 9.

Click the Profile button, then select Quick Menu. Select or deselect the check box labeled Display the Quick Menu to turn the Quick Menu on or off. Choose the name of a menu in one list and click > or < to move it to the other list. Repeat step 3 as desired. If you want to move all Available Menus to the Favorite Menus list, then click >>. If you want to move all Favorite Menus to the Available Menus list, then click <<. Optionally, click the up and down arrows to change the sequence of menus in the Favorite Menus list. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

12.4 Changing Your Password


Use this procedure to change your password.

12-2

Oracle CRM System Administrator Console Concepts and Procedures

Viewing Quick Find Search Results

Steps
1. 2. 3.

Click the Profile button, then select Change Password. Type your current password into the Current Password field. Type your new password into the New Password field. Passwords must be at least six characters long.

4. 5. 6.

Retype your new password into the Re-Enter New Password field. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

12.5 Setting Personal Information


Use this procedure to edit your personal information.

Steps
1. 2. 3. 4.

Click the Profile button, then select Personal Information. Edit the fields as desired. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

12.6 Setting Address Information


Use this procedure to edit your address information.

Steps
1. 2. 3. 4.

Click the Profile button, then select Address Information. Edit the fields as desired. Optionally, click Restore to reset the fields to their original settings. Click Update to save.

12.7 Viewing Quick Find Search Results


The Quick Find feature appears underneath each pages tabs. Use this procedure to view the results of a Quick Find search operation.

Setting Profile Options

12-3

Viewing Quick Find Search Results

Prerequisites
1. 2.

Choose an item from the Quick Find drop-down list. Type a search query into the text input field. Optionally, you can use the wildcard character (%) as needed. For example, to find items that begin with "crm," type "crm%" into the text input field. Click Go.

3.

Steps
1.

The search results display.


Note: If in the Display Preferences page you have selected the

option "Go to record detail when there is one result," then you will not see this page. Instead, you will bypass this page and be automatically redirected to the page that resulted from your search.
2.

Click one of the links offered to you in the Search Results list. You will be redirected to the associated record detail page.

12-4

Oracle CRM System Administrator Console Concepts and Procedures