You are on page 1of 340

Oracle Enterprise Performance Management

System
Oracle Hyperion Reporting and Analysis Framework
User's Guide
Release 11.1.2.2

Reporting and Analysis Framework User's Guide, 11.1.2.2


Copyright 1989, 2012, Oracle and/or its affiliates. All rights reserved.
Authors: EPM Information Development Team
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective
owners.
This software and related documentation are provided under a license agreement containing restrictions on use and
disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or
allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,
perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation
of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find
any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of
the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS:
Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers
are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition
Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and
adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to
the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial
Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software or hardware is developed for general use in a variety of information management applications. It is not
developed or intended for use in any inherently dangerous applications, including applications that may create a risk of
personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all
appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates
disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
This software or hardware and documentation may provide access to or information on content, products, and services
from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any
kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible
for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Documentation Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 1. Using Reporting and Analysis Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Using Data Source Elements for Reporting and Analysis . . . . . . . . . . . . . . . . . . . . . . . . . 15
Web Analysis Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Reporting Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Interactive Reporting Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Production Reporting Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Essbase Features Available to the Studios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Financial Management Features Available to the Studios . . . . . . . . . . . . . . . . . . . . . . 18
Planning Details as a Database Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Relational Access Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Personalizing Reporting and Analysis Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Subscribing to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Working with Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Using Workspace Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Using Personal Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Reporting and Analysis Framework Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Standard Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Production Reporting Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Interactive Reporting Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Explore Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Administer and Impact Manager Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Schedule Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Favorites Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
About Reporting and Analysis Framework Preferences . . . . . . . . . . . . . . . . . . . . . . . 25
Setting Authentication Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting Explore Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Formatting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Setting Preferences for Production Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting Preferences for Interactive Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Personalizing EPM Workspace for Reporting and Analysis Framework Products . . . . . 30
Chapter 2. Using Search Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Indexing Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Using the Search Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Contents

iii

Using Advanced Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37


Search Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Supported MIME Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Chapter 3. Exploring and Managing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Using Explore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
File Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Supporting Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Other Standard Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Basics of Explore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Viewing Priorities, Exceptions, and Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Managing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Opening or Selecting Files or Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Creating Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Creating Documents or Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Moving or Copying Files or Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Renaming Files or Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Deleting Files or Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Searching for Files or Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Linking to Web Analysis Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Creating Email Links to Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Using Ambiguous Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Registering a File Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Exporting Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Exporting to Smart View for Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
About Hyperion Reporting and Analysis Smart View Export Options . . . . . . . . . . . . . 57
Importing Reporting and Analysis Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Installing Smart View From EPM Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Exporting Production Reporting Content to Microsoft Excel . . . . . . . . . . . . . . . . . . . 63
Chapter 4. Importing Artifacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Interactive Reporting Documents and Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

iv

Contents

HTML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Importing Artifacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Importing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Importing Multiple Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Importing Files as Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Importing a URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Importing Microsoft Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Setting Permissions and Pushing Artifacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Setting Permissions on Interactive Reporting Documents . . . . . . . . . . . . . . . . . . . . . 74
Creating Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Working with Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
General Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Changing Ownership of Artifacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Advanced Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Output Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Interactive Reporting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Production Reporting Properties and Generic Job Properties . . . . . . . . . . . . . . . . . . . 78
Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
HTML File Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
URL Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Interactive Reporting Database Connection Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Working with Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Opening a Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Adding a Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Viewing or Modifying Properties of Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Version Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Listing Multiple Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Deleting Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Chapter 5. Viewing and Organizing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Using Different File Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Creating a New Book, Batch, Document, or Workspace Page . . . . . . . . . . . . . . . . . . . . . . 84
Selecting a Data Source for a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Using Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Adding Items to Your Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Pushing Items to Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Managing Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Contents

Using Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Creating a Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Modifying or Removing Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Subscribing to Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Receiving and Viewing Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Using Personal Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Customizing Personal Page Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Working With Personal Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Workspace Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Creating Workspace Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Workspace Page Content Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Using Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Home Page Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Setting Start Page back to Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Chapter 6. Interactive Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Using Interactive Reporting Documents in EPM Workspace . . . . . . . . . . . . . . . . . . . . . 111
Using the Interactive Reporting Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Standard Interactive Reporting Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Navigation Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Paging Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Shortcut Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Alert Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Interacting with Interactive Reporting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Understanding Interactive Reporting Document Files . . . . . . . . . . . . . . . . . . . . . . . 115
Creating An Interactive Reporting Document File (BQY) From Another Interactive
Reporting Document File (BQY) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Database Connection File (OCE) Selection For Interactive Reporting Document
(BQYs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Selecting an Interactive Reporting Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Accessing Interactive Reporting Document Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Saving Interactive Reporting Document Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Using the Save Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Using the Save As Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Working with Interactive Reporting Document File Sections . . . . . . . . . . . . . . . . . . . . . 120
Sections Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Selecting Interactive Reporting Document File Sections . . . . . . . . . . . . . . . . . . . . . . 121
Adding Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Moving Between Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Duplicating Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

vi

Contents

Renaming Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122


Deleting Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Dashboard Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Refreshing Interactive Reporting Document File Sections . . . . . . . . . . . . . . . . . . . . 123
Printing Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Exporting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Exporting a Section as a .PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Exporting a Section to MS Excel (.XLS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Exporting an Interactive Reporting Document File in Native File Format . . . . . . . . . 126
Query Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Interactive Reporting Database Connection Files (OCEs) . . . . . . . . . . . . . . . . . . . . 127
Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Topics and Topic Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Query Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Inserting a New Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Working with Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Working with Items on the Request Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Picture (BLOB Image) Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Adding a Computed Item in Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Computed Items and Data Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Data Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Applying A Query Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Variable Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Applying Query Sorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Refreshing a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Results and Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Adding a Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Working with Columns and Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Sorting Results/Table Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Number Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Applying a Results and Table Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Results and Table Totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Adding Computed Items in Results and Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Paging Through Results Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Chart Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Understanding Chart Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Chart Data Layout Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Legends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Changing Chart Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Contents

vii

Working with Charted Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168


Working with Chart Facts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Paging Through the Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Pivot Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Pivot Table Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Working with Pivot Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Focusing and Hiding Pivoted Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Working with Row and Column Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Working with Pivot Facts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Analyzing Pivot Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Paging Through Pivot Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Common Chart/Pivot Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Sorting Charts/Pivots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Drill Anywhere into Charts/Pivots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
DrillDown into Dimensional Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
OLAPQuery Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Working with OLAP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
OLAP Data Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
CubeQuery Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
About Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
About Multidimensional Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Catalog List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
OLAPQuery and CubeQuery Data Layout Differences . . . . . . . . . . . . . . . . . . . . . . . 195
Building a CubeQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
DB Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Searching Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Member Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Filter Member Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Navigating CubeQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Using Swing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Downloading to Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Formatting CubeQuery Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Query Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Launching Smart View from CubeQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Embedded Section Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Report Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Paging Through the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

viii

Contents

Chapter 7. Using Production Reporting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235


Viewing a Production Reporting Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Viewing Functionality for HTML Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Using the Navigation Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Navigating with the Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Chapter 8. Scheduling Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Scheduling and Running Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
About Job Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Event Status and Schedule Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Running Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Scheduling Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Using Job Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Managing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Managing Job Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Viewing Job Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Using the Consolidated Job Status List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Retrieving Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Chapter 9. Using Interactive Reporting Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Interactive Reporting Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Import Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Pass-Through Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Supporting Exceptions in Interactive Reporting Programs . . . . . . . . . . . . . . . . . . . . 258
Setting Interactive Reporting Job Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Setting Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Setting Data Source and Query Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Setting Interactive Reporting General Properties and Options . . . . . . . . . . . . . . . . . 261
Setting Job Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Selecting Database-Connection File Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Pass-Through Using Multiple, Interactive Reporting, Database-Connection Files . . . 262
Setting Processing and Metadata Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Setting Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Setting Single-Cycle Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Modifying Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Setting Multiple-Cycle Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Contents

ix

Job Parameter Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266


Filter Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Process Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Action Options for Multiple-Cycle Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Example: Importing and Scheduling a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Chapter 10. Using Production Reporting and Generic Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Prerequisites for Importing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Job Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Dependency Analysis Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Connectivity and Run Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Job Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Compile Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Generic Job Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Generic Job Output Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Required Files for Generic Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Database Connectivity for Generic Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Output Options for Generic Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Modifying Production Reporting and Generic Job Properties . . . . . . . . . . . . . . . . . . . . . 287
Setting Production Reporting and Generic Job Parameters . . . . . . . . . . . . . . . . . . . . . . 288
Output Options for Scheduling Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Email Notification Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Output Directory Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Working with Secure Production Reporting Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Access Privileges on Secure Production Reporting Jobs . . . . . . . . . . . . . . . . . . . . . . 290
Security Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Recommendations for Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Programmer Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Viewing Security Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Supporting Exceptions in Production Reporting or Generic Programs . . . . . . . . . . . . . . 292
Production Reporting Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Generic Report Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Setting Priority on Output Programmatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Chapter 11. Using Custom Parameter Forms for Production Reporting Jobs . . . . . . . . . . . . . . . . . . . . . . . . . 295
Customizing Parameter Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Parameter Form Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

Contents

Assigning Parameter Forms Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296


Assigning the Standard Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Editing Parameter Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Parameter Form Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Element Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Required Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Nonrequired Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Standard Parameter Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Standard Parameter Form Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Parameter Forms: Example and Tip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Contents

xi

xii

Contents

Documentation Accessibility

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

Access to Oracle Support


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

13

14

Documentation Accessibility

Using Reporting and Analysis


Framework

In This Chapter
Using Data Source Elements for Reporting and Analysis ..............................................15
Personalizing Reporting and Analysis Framework.......................................................19
Reporting and Analysis Framework Toolbars ............................................................21
Setting Preferences ........................................................................................25

Content that relates to Oracle Hyperion Reporting and Analysis Framework includes Reporting
and Analysis Framework Services, Oracle Hyperion Interactive Reporting Services, Oracle
Hyperion SQR Production Reporting Services, Oracle Hyperion Impact Management Services,
Search Services, Oracle Hyperion Shared Services, Workspace Pages, and Explore.

Using Data Source Elements for Reporting and Analysis


Subtopics
l
l
l
l
l
l
l
l

Web Analysis Studio


Reporting Studio
Interactive Reporting Studio
Production Reporting Studio
Essbase Features Available to the Studios
Financial Management Features Available to the Studios
Planning Details as a Database Connection
Relational Access Methods

Data sources (generic data storage mechanisms) can be multidimensional databases, relational
databases, or files. Database connections are portable files stored in the repository. They define
the terms, conditions, and methods for connecting to data sources. In Oracle Hyperion
Enterprise Performance Management Workspace, you cannot create or modify database
connections; rather, you must use the applicable Oracle Hyperion Reporting and Analysis
product. You see only database connections that you own and to which you are granted
permissions. Multiple permissions are needed to read, write, edit, and change databaseconnection file properties. For permission descriptions, see the Oracle Hyperion Enterprise
Performance Management Workspace Administrator's Guide.
Database servers typically use server, application, and database names to create unique
identifiers. Such identifiers make database references not readily portable. The studios use
Using Data Source Elements for Reporting and Analysis

15

database aliases instead of long identifiers. Aliases are easier to remember and more economical
to employ and enable a database to be maintained on multiple servers.
Repository documents are dependent on a database-connection file to query data sources for
values. A document can use only one database connection but can use any of several data sources.
For a complete list of supported data sources and relational databases by Reporting and Analysis
product, see Oracle Enterprise Performance Management System Installation and Configuration
Guide.
l

Different data sources have different system requirements. See the Oracle Enterprise
Performance Management System Installation and Configuration Guide for descriptions of
system requirements.
The View pane displays specific information for the document currently open in the content
area. For example, the database connection used by the current data object. The View pane
displays two database connection segments for Oracle Hyperion Web Analysis:
m

The Database segment displays the database connection name for the current data
object.
The Database User Name segment displays the user name by which access to the database
connection was granted.

Web Analysis Studio


Oracle Hyperion Web Analysis Studio users can construct seamless liaisons between OLAP data
and relational data sources. Navigation from OLAP to relational data is typically called relational
drill-through.
After relational drill-through is configured, users can navigate to level 0 (the bottom) of the
OLAP database and drill down to relational data. Relational drill-through, a client-based
integration solution, is comparable to the server-based Analytic Integration Services drillthrough.
Relational drill-through supports an array of JDBC relational data sources but does not support
queries by level, generation, or previously selected member. Relational drill-through definitions
are saved as a property of the database-connection file.

Reporting Studio
For Oracle Hyperion Financial Reporting Studio, you must be defined as a user, with a user
name and password, in the data source that your document uses. For example, to view
documents that use Oracle Essbase, you must logon to the database with a user account defined
in Essbase. Logging on usually occurs automatically; however, if you are not registered in the
database, you are prompted for logon credentials.
Note: This release of Financial Reporting does not support SAP BW and MS OLAP as data

sources.

16

Using Reporting and Analysis Framework

Interactive Reporting Studio


Interactive Reporting documents can contain multiple Query sections, each of which can access
a range of data sources (relational databases, OLAP servers, imported data sets, and local joins).
Each section can reference zero (if using only local joins) or one database-connection file. The
file can reference only one data source. When a query section associated with a relational database
connection or using only local joins is processed, a corresponding Results section is produced.
If the database-connection file is associated with a multidimensional database connection,
results are shown in the Query section.

Production Reporting Studio


Using Oracle Hyperion SQR Production Reporting Studio, you can develop a range of reports,
from small ad hoc reports to mission-critical operational reports. Various data sources can be
used; for example, relational databases, OLAP servers, and transactional systems.
After creating a data source connection, use the Production Reporting Studio wizard, layout
editor, and explorers to design and customize enterprise reports. You can also insert and update
database tables to incorporate data transformations into report processing.
Whether you are creating budgets, building exception reports, producing invoices from millions
of records, or distributing Web-based reports to help end-users make quick, effective decisions,
Production Reporting manages the secure delivery of content across the enterprise.

Essbase Features Available to the Studios


Essbase integrates data from multiple sources, meets user needs across an enterprise, adds value
to previously inaccessible data, and transforms data into actionable information.
Essbase features available to studios:
l

Data restriction

Top and bottom only retrieval

Data edits

Suppression of rows that contain #MISSING values, zero values, and shared members

Label mode and alias tables

Drill settings specific to Essbase

Linked reporting objects

Relational drill-through

Analytic Integration Services drill-through

Advanced member selection

Attribute dimensions and attribute calculations

Using Data Source Elements for Reporting and Analysis

17

Financial Management Features Available to the Studios


Oracle Hyperion Financial Management is a centralized, scalable, financial management and
reporting solution. Financial Management features that are extended through EPM Workspace:
l

Organization by period

Advanced member selection specific to Financial Management

Cell text, related content

Line item, detail-related content

Advanced member selection

User-defined fields

Entity currency display

Planning Details as a Database Connection


After installing the Planning Details ADM driver, you can choose Planning Details as a database
connection for Oracle Hyperion Financial Reporting Studio. The Planning Details ADM driver
is optimized as a data source to provide Oracle Hyperion Planning features such as supporting
details, planning unit annotations, and metadata filtering. If your report grid does not use
Planningfeatures, for optimal performance, choose Essbase as the database connection. See the
Oracle Hyperion Financial Reporting Studio User's Guide.

Relational Access Methods


Some documents, such as Web Analysis documents, can access OLAP, Oracle, and supported
relational databases.
Methods for accessing relational data from Web Analysis:
l

Custom document SQL spreadsheet

Custom document free-form grid

Relational drill-through

Relational database connection

Analytic Integration Services drill-through

Repository

Controlling the Size of the Query Result Set


Query governors vary for relational access methods. Custom document SQL spreadsheets and
relational drill-through methods enable users to declare query governors as they create SQL
queries or relational drill-through definitions.
When you drill from OLAP to relational data, passing only the drilled OLAP dimension member
to the relational data source may result in a large query result set. To reduce and simplify the
query result set, you can pass the page and filter dimensions specified in the OLAP document.

18

Using Reporting and Analysis Framework

In Interactive Reporting documents, Query section properties can govern the number of rows
returned from relational data sources and impose time limits on queries. Users can cancel queries
through the keyboard in some cases.

Personalizing Reporting and Analysis Framework


Subtopics
l
l
l
l

Subscribing to Documents
Working with Favorites
Using Workspace Pages
Using Personal Pages

You can be notified when documents are changed, use EPM Workspace favorites, Workspace
pages, and personal pages to personalize the process of organizing, accessing, and viewing
documents. See Chapter 5, Viewing and Organizing Information.

Subscribing to Documents
When documents are changed or updated, subscribing users can be informed:
l

By email notifications with attached files

By bookmarked personal pages

By images that represent bookmarks

For information on Subscribe, see Chapter 5, Viewing and Organizing Information.

Working with Favorites


Favorites provide quick access to frequently used items and documents. With appropriate access
permissions, you can add items (push items) to other users favorites.

Using Workspace Pages


Workspace Pages enable you to create, edit, and aggregate content from Oracle (Reporting and
Analysis and Application products) and non-Oracle sources (URL and Office documents), into
a single environment. Templates are provided to create a Workspace page.
There are two types of Workspace Pages:
l

My Workspace PagesStored in any folder to which users have access. There is a favorites
like implementation for Workspace Pages that creates shortcuts to the My Workspace Pages
that can be stored in any folder.

Personalizing Reporting and Analysis Framework

19

Shared Workspace PagesStored in a system folder that authorized users can access from
Explore. Users who have access to this folder can move their personal pages manually within
Explore to promote them to the rest of the organization.

See Workspace Pages on page 104 for additional information.

Using Personal Pages


Use Personal Pages to view frequently used information. You can have multiple personal pages
and choose a default personal page, which is displayed when you open Personal Pages from
Favorites. You can customize personal page content and layout, create personal pages, and copy
and customize imported personal pages.
Personal page features:
l

Broadcast MessagesA link to a folder, the contents of which are set up and managed by
the administrator. Folder contents are displayed as one or more content window, and
displayed to every user. The Broadcast Messages folder contains two sub-folders:
m

Personal Page ContentPublished personal pages


Sample Personal PageContent set up by the administrator and content added by
subscription

My BookmarksLinks to Web pages or repository items that open as new tabs in EPM
Workspace.
Image bookmarksGraphic links to Web pages or repository items.
HTML file or job output displayed as a file content windowEPM Workspace HTML items
and URLs
Exceptions Dashboard-Traffic light indicatorsIf the traffic light is red, the item is flagged
as an exception or the job generated an exception. If the traffic light is green, the job did not
generate an exception.
Displayable Interactive Reporting sectionsSections from Interactive Reporting
documents and job output that you can access.

For details on the following tasks, see Chapter 5, Viewing and Organizing Information:
l

Adding personal page contents

Modifying personal page layout

Changing personal page colors

Displaying HTML content on personal pages

Creating bookmarks

Using exception notifications

Embedding Interactive Reporting document sections in personal pages

20

Using Reporting and Analysis Framework

Reporting and Analysis Framework Toolbars


Subtopics
l
l
l
l
l
l
l
l

Standard Toolbar
Production Reporting Toolbar
Interactive Reporting Toolbar
Explore Toolbar
Administer and Impact Manager Toolbars
Schedule Toolbar
Favorites Menu
Shortcut Menu Commands

Standard Toolbar
Table 1

Button

Standard Toolbar Buttons


Menu Command

Description

File, then New, then Document

Create documents, such as Financial Reporting books and batches, Web Analysis
documents, Interactive Reporting document, and Workspace Pages

File, then Open, then Document

Open repository documents

NA

Displays the default startup option for content area

NA

Open Explore, to display the repository as a file management system

Production Reporting Toolbar


When viewing Production Reporting documents in EPM Workspace, no buttons are displayed
in the toolbar area except for navigation buttons. Navigate among HTML-report pages and
viewing reports in multiple output formats. The navigation buttons are dynamic, based on job
output. For button descriptions, see Chapter 7, Using Production Reporting Documents.

Interactive Reporting Toolbar


The Interactive Reporting toolbar displays standard buttons and buttons specific to it. For button
descriptions, see Chapter 6, Interactive Reporting.

Reporting and Analysis Framework Toolbars

21

Explore Toolbar
Table 2

Button

Explore Toolbar Buttons


Menu Command

Description

File, then New Folder

Creates folders

NA

Navigates up to the repository location that contains the current folder

Edit, then Cut

Marks repository files to be moved

Edit, then Copy

Marks repository files to be duplicated

File, then Properties

Open the Properties dialog box, used to set file properties; for example, file permissions

Edit, then Paste

Pastes files to the current repository location

View, then Refresh

Updates EPM Workspace with changes to scheduled batches

Administer and Impact Manager Toolbars


The Administer and Impact Manager toolbars enable you to manage EPM Workspace
properties, performance, and user interaction. For button descriptions, see the Oracle Hyperion
Enterprise Performance Management Workspace Administrator's Guide.

Schedule Toolbar
Schedule module toolbars enable you to perform the following tasks:
l

Run and schedule job types:


m

22

Interactive Reporting jobAn Interactive Reporting document imported into EPM


Workspace as a job and its associated files.
Production Reporting jobA Production Reporting report or program and its
associated files. A Production Reporting job can be secure or nonsecure.
Generic jobA report or program from another software provider (for example, an
Oracle report or a Crystal report), and any associated files.

Run and schedule batches, which are collections of reports.

Using Reporting and Analysis Framework

Favorites Menu
Use the Favorites menu to set up personal pages and favorites and to select from a list of favorite
documents. This menu is only displayed if you have installed Reporting and Analysis Framework.
Table 3

Favorites Menu

Command

Description

Manage Favorites

Opens the Favorites Manager dialog box

Show Subscribed Items

Documents to which you are subscribed and manage personal pages

Manage Personal Pages


Available application products

Displays in alphabetical order a list of favorite documents or folders defined by you or pushed to you;
for example, Oracle Hyperion Performance Scorecard.

My Personal Page

Opens your personal page

Shortcut Menu Commands


Shortcut menu commands are displayed by right-clicking an item in Explore. Option availability
depends on the content of the current window and the module from which the menu is accessed.
Table 4

Shortcut Menu: Explore

Explore - Right Click Menu


Menu Command

Description

Go Up A Level

Display the contents of the parent folder

New Folder

Add folders to the repository

Open

Select, open, and use repository documents

Open In, then HTML Preview

View documents in browsers as HTML or PDF

PDF Preview
Import,
then File,

Open the Import to Repository dialog box, used to import reports, books, snapshot reports and books,
Microsoft reports, report objects (grid, text, image, and chart) and row and column templates into the
repository

then URL,
then File as Job,
then Financial Reports,
Microsoft Reports
Expand

From the View pane, display sub-folders under selected folder

Collapse

From the View pane, collapse selected folder

Export

Open the Export dialog box, used to export saved reports, snapshot reports and books, and report objects
(grids, text, image, and chart) from the repository

Reporting and Analysis Framework Toolbars

23

Explore - Right Click Menu


Menu Command

Description

Email Link

Display the Email Editor dialog box, used to indicate recipient names and email message subjects. Email
Links Editor creates hyperlinks to files so recipients can view the files in Web browsers. Only Financial
Reporting users can view hyperlinked files.

Cut

Remove repository items and place copies on the clipboard

Copy

Copy a repository item

Paste

Place cut and copied items in reports

Delete

Remove files from the repository upon confirmation

Delete with Outputs

For Interactive Reporting documents, delete items with job outputs, if there are outputs

Rename

Changes name of file or folders

Properties

Display scheduled batch detail; for example, the time for which a batch is scheduled

Run Job

For Interactive Reporting jobs, set job parameters and run jobs

Subscribe

Inform subscribing users of document changes

Create Shortcut

Create document shortcuts, for example, create shortcuts to Interactive Reporting, PDF, and HTML
documents

Retrieve

Download and save an Interactive Reporting document

Schedule Job

Schedule Interactive Reporting Job

Add to Favorites

Add files to the favorites list

Refresh

Refresh the repository to include new folders and files

Edit Permissions

Change or update access rights for an artifact

Apply Permissions to Children

Select the access rights to apply for all children objects of a folder.
Note: The only objects updated are the ones you have Full Control permission.

24

Using Reporting and Analysis Framework

Setting Preferences
Subtopics
l
l
l
l
l
l
l

About Reporting and Analysis Framework Preferences


Setting Authentication Preferences
Setting Explore Preferences
Formatting Preferences
Setting Preferences for Production Reporting
Setting Preferences for Interactive Reporting
Personalizing EPM Workspace for Reporting and Analysis Framework Products

About Reporting and Analysis Framework Preferences


Web Analysis, Financial Reporting, Production Reporting, Interactive Reporting, Performance
Scorecard, Financial Management, Planning, Oracle Business Intelligence Enterprise Edition,
and Oracle BI Publisher preferences are accessed from the Preferences dialog box:
l

Web Analysis preferences are organized on three tabs. These options specify the active
preference file, set default leading and trailing data value formatting, numeric formatting,
and database connection parameters for Web Analysis documents. See Oracle Hyperion
Enterprise Performance Management Workspace User's Guide.
Financial Reporting includes options for previewing documents, POV settings, export
options, and formatting options, preferences for designing reports, the language to use, units
of measure and guidelines document layouts. See Oracle Hyperion Enterprise Performance
Management Workspace User's Guide
Setting Preferences for Production Reporting on page 28 include scanning folders for
Production Reporting Jobs.
Setting Preferences for Interactive Reporting on page 29 include options for setting
locale defaults based upon the country of origin, date and time formatting, and number
formatting.
Oracle Business Intelligence Publisher includes options for UI language, report locale, SVG
supports in HTML, report time zone, and setting password. See Oracle Hyperion Enterprise
Performance Management Workspace User's Guide.
Oracle Business Intelligence Enterprise Edition includes viewing general account
information, preferences for default dashboard, locale, and language, time zone, delivery
options, and so on. See Oracle Hyperion Enterprise Performance Management Workspace
User's Guide.

Setting Preferences

25

To display the Preferences dialog box, select File, and then Preferences.

Setting Authentication Preferences


Set Authentication Preferences for Interactive Reporting and Production Reporting
authentication using Pass-Through.
Note: To enable this functionality, contact your System Administrator.

To set Authentication preferences:


1

Select File then Preferences, and click Authentication.

In User Name, enter the user name you want to use for Pass-Through.

In Password, enter the password to use for Pass-Through.

In Confirm Password, re-enter your password to confirm.

Click OK.

Setting Explore Preferences


Explore preferences define default folders and default permissions for items that you create or
import. You can specify default permissions for specific users, groups, or roles. If you do not set
these preferences, the Default folder and New Document folder are set to the top-most, or root
folder and permissions for items are set to Empty.
You can modify the following Explore Preferences:
l

Default FolderYour default folder is shown when you use Explore. Set it to the folder you
access most frequently.
New Document FolderDefault folder where the new document wizard searches for Web
Analysis database connection files and Interactive Reporting documents. If you are creating
new Interactive Reporting documents and browse for data sources, this folder is used.
Default File PermissionsApplied when you create a folder or import artifacts. These
permissions determine the ability of a user, group, or role to access the item and whether to
automatically push the item to the user, group, or role favorites.
Note: Default file permissions are automatically applied to all artifacts you create or import.

You can override these defaults by manually changing the permissions when you
create or import the artifact.

To set default folders:


1

Select File, then Preferences, and then select Explore.

Set the Default folder and New Document folder.

Click Select, and do one of the following steps:

26

Using Reporting and Analysis Framework

From Look in, select a folder.

From the list of names, select a folder.


To navigate, double-click a folder. The folder you select is displayed in the Name text
box. (Do not type a name in the Name text box.)

From Default File Permissions, select one of the following:


l

Interactive Reporting documents

Interactive Reporting jobs

Production Reporting jobs

Generic jobs

All other documents

Folders

Click OK or Cancel.

To continue setting default permissions, repeat step 3.

Select Set Permissions to set default permissions for users, groups, and roles. The Permissions
dialog is displayed. See Setting Permissions and Pushing Artifacts on page 70.

Formatting Preferences
The following preferences can be set for all reports created from EPM Workspace:
l

Default Formatting Preferences on page 27

User Preferences and Formatting Options on page 28

Default Formatting Preferences


Default Formatting preferences specify default data formatting for all subsequently created
reports. Options are organized by their ability to amend, format, or replace data returned from
the data source.
Table 5

Default Formatting Preferences

Formatting Options

Description

Leading and Trailing Formatting


Currency Symbol

Inserts the following currency formatting symbols into the Positive Prefix and Negative Prefix text boxes:
Dollar ($), Cents (), Pound (), Euro(E), Deutschmark (DM), Franc (F), and Yen ().

Positive Prefix

Character to precede positive numeric values

Positive Suffix

Character to follow positive numeric values

Negative Prefix

Character to precede negative numeric values. Warning: The minus sign (-) is the default prefix. Deleting
the default prefix without replacing it causes negative values to display positively.

Setting Preferences

27

Formatting Options

Description

Negative Suffix

Character to follow negative numeric values

Numeric Formatting
Grouped Thousands Check Box

Numeric digits grouped by thousands

Minimum Decimals

Minimum number of decimal places to display

Maximum Decimals

Maximum number of decimal places to display

Scale

Abbreviated values by tens, hundreds, thousands, ten-thousands, hundred-thousands, millions, and


billions.

Use Negative Color Check Box

Negative numbers are signified by a selected color

Select Negative Color

Color representing negative values

Samples
Update Samples

Updates the samples panel based on the most recent formatting selections

Replace Missing With

Replaces missing values with either a text string or zero

User Preferences and Formatting Options


There are identical formatting options and user preferences. User preferences are global settings
applied to new documents. User Preferences can be overridden by database connection
formatting and document-based formatting.
Order of Formatting Precedence:
1. Options saved with documents
2. Options saved with the database connection
3. Options specified in the User Preferences dialog box
Spreadsheet user preferences and chart user preferences are identical to spreadsheet options and
chart properties. They are only applied to subsequently created documents.

Setting Preferences for Production Reporting


To set preferences for Production Reporting:
1

Select File, then Preferences, and then Production Reporting.

Do one of the following:

28

Select All Folders to scan folders listed in Explore.

Select the Selected Folders option to search folders listed in the Folder window.

Use the Add and Remove buttons to add and delete folders from the Folder window.

Using Reporting and Analysis Framework

Selecting Add opens a Select dialog from which you can select the folders to add to your
search. To remove a folder from the Folder window, select the folder and click Remove.

Select OK.

Setting Preferences for Interactive Reporting


To set preferences for Interactive Reporting:
1

Select File, then Preferences, and then Interactive Reporting.

Select the country for the locale for which you are setting the defaults.

The locale sets the locale or country associated with the default format. The locale determines
the available number, date, and currency formats

Select a format for the date, timestamp, time, and month.

Date sets the default date format, timestamp sets the default time and date format, time sets
the default time format, and month sets the default month format for the month used in Add
Date Groups.

Select a format for the real number, integer, and null option. .

Null sets the default format for null values Null values are empty values for which no data
exists. Null values are not equal to zero. Real sets the default format for real values and integer
sets the default format for integer values.

Select OK.

Default Open Interactive Reporting Format


The Default Open Format drop-down on the Interactive Reporting Preferences window enables
you to set the default program to open Interactive Reporting documents when you select open
from the menus. The default program can be set to HTML or Interactive Reporting Web Client.
If the Interactive Reporting document is opened as HTML, the document is displayed in HTML
format in the Content pane. In Interactive Reporting Web Client format, the document is opened
in a special application file placed in a Web browser's plug-in directory.

To select the default program:


1

Select File, then Preferences, and then Interactive Reporting.

Select the default program to open the document from the Default Open Format drop-down and click
OK.

Formatting
You can change the way numbers, currency values, and dates are displayed, or you can create
new custom formats. Use the Numbers tab of the Default Fonts and Styles dialog box to specify
default settings for number formats.

Setting Preferences

29

Default Number Formats

Table 6

Field

Description

Select a Formatting Locale

Locale or country associated with the default format


The locale determines the available number, date, and currency formats.

Date

Default date format

Timestamp

Default time and date format for the timestamp


The timestamp is a set of characters in sequential order that show the date and time on which an event
occurred. This information is used for tracking events.

Time

Default time format

Month (For Add Date


Groups)

Default month format for the month used in Add Date Groups

Real Number

Default format for real values

Integer

Default format for integer values

Null

Default format for null values


Null values are empty values for which no data exists. Null values are not equal to zero.

Personalizing EPM Workspace for Reporting and Analysis


Framework Products
When using EPM Workspace, perform customization tasks to change the user interface
appearance. Use the View menu or user preferences for customization.
Note: User interface settings made with the View menu override default settings defined in the

General Preferences tab and remain in effect until you log off. See the Oracle Hyperion
Enterprise Performance Management Workspace User's Guide
Table 7

Customization Tasks for Workspace Modules and Menu Commands

Customization Task

Modules

Menu Bar Command

Show/hide View pane

All modules

View, then View Pane

Show/hide Masthead

All modules

View, then View Masthead

Resize View pane and content area or Masthead

All modules

See Resizing the View Pane and Content Area on page 31


or Resizing the Masthead on page 31

Which file types are listed in the content area

Explore

View, then Display Items of Type. See Showing Specific File


Types on page 32

Whether to show hidden files in the content area

Explore

View, then Show Hidden

30

Using Reporting and Analysis Framework

Customization Task

Modules

Menu Bar Command

Which item properties are displayed in the content area

Explore

View, then Show Columns. See Displaying Columns on page


31

Sort items in the content area

Explore

See Sorting Items on page 32

Resizing the Masthead


To resize the masthead:
1

Drag the mouse and point to the header border between the View pane and content area and the
masthead.

Point to the Masthead Area Adjuster which is displayed as a faint double line in the border.

When the pointer changes to a horizontal double-headed arrow, drag the border up or down.

Resizing the View Pane and Content Area


To resize the View pane and content area:
1

Drag the mouse and point to the column border between the View pane and the content area.

Point to the View Pane/Content Area Adjuster which is displayed as a faint double line in
the border.

When the pointer changes to a horizontal double-headed arrow, drag the border to the right or left.

Displaying Columns
From Explore, items and properties display in the columns within the content area. Column
settings are retained after you log off.

To hide or display columns:


1

Select View, and then Show Columns.

Display or hide columns by setting or clearing its check-box.

For example, select the check box for Size to display as a column in the content area.

To specify the column width, click a column check box, and enter the new column width in pixels.

You cannot specify the column width for exceptions, priority, or versions.

Click Save.

To reorder columns, do one of the following steps:


and

arrows.

Click a column, use

Select View, and then Show Columns.

Setting Preferences

31

From the content area, drag and drop the columns.

To resize column widths:


1

Drag the mouse and point to a column border in the column header.

When the pointer changes into a horizontal double-headed arrow, drag the border to the right or left.

Sorting Items
From Explore, alphabetically sort by items in the columns within the content area. Sort using
any column heading. Date columns are sorted chronologically.

To sort a column, click the column heading, then do one of the following:
l

To sort items in ascending order, click the icon next to the column heading to point up.

To sort items in descending order, click the icon next to the column heading to point down.

Showing Specific File Types


From Explore, you can specify which file types to display in the content area.
Note: Your role and permissions also determine if an item is displayed.

To display specific file types:


1

Select View, then Display Items of Type, and select an option:


l

All FilesDisplays all files in Explore

Select from a list of file type groupsSee step 2.

Hyperion or StandardDisplays either Hyperion type files or standard files, see


Standard Files on page 34.
OtherSelect a particular file from the dialog box displayed.

Optional: For the list of file type groups, you can select only one file type group from the list.
Table 8

32

File Type Groups

Option

Description

All Jobs (and Output)

All jobs and all job output

All Jobs

All jobs, including all items imported as a job

All Job Output

All job output produced from running a job

External Links

All items imported as a URL

All Office Files

Microsoft Word, Excel, Power Point, and Project files. It also displays files with the file extensions .mht, .
mhtml, or .nws

Using Reporting and Analysis Framework

Option

Description

All Reports

Production Reporting documents; Interactive Reporting documents; Web Analysis documents; and Financial
Reporting reports, snapshot reports, books, snapshot books and batches

All Financial
Reporting Objects

All Financial Reporting reports, snapshot reports, books, snapshot books and batches

All Connections

All database connection files:

All Images

Hyperion

Interactive Reporting database connection

Web Analysis (Essbase) database connection

Web Analysis Financial Management database connection

Web Analysis Relational database connection

Web Analysis SAP Info Cube database connection

Web Analysis SAP Multiprovider database connection

Web Analysis SAP InfoSet database connection

Web Analysis SAP ODS database connection

Web Analysis SAP Query Cube database connection

All image files with the following extensions:


l

.gif

.jpeg

.png

.bmp

.tiff

.xbm

.xwb

Production Reporting documents

Interactive Reporting documents

Web Analysis documents, presentations, database-connection files.

Financial Reporting reports, snapshot reports, books, snapshot books and batches

All jobs

All Job output

All connections

HTML files

SPF security files

Setting Preferences

33

Option

Description

Standard

All files with the following extensions:

Other

.xls

.doc

.mpp

.ppt

.pdf

.html

.txt

.xml

.zip

.rtf

Select one file type to display from the list of file types.

Standard Files
Standard files include text files, log files, HTML files, and Microsoft Office files. The
administrator sets up the types of files that the repository supports. See Chapter 3, Exploring
and Managing Items. Open the following standard file types from EPM Workspace:
l

.xls

.doc

.mpp

.ppt

.pdf

.html

.txt

.xml

.zip

.rtf

34

Using Reporting and Analysis Framework

Using Search Services

2
In This Chapter

Introduction.................................................................................................35
Indexing Keywords .........................................................................................36
Using the Search Service..................................................................................36
Using Advanced Search ...................................................................................37
Search Syntax ..............................................................................................38
Supported MIME Types ....................................................................................39
Security .....................................................................................................41

Introduction
Search Services enables users to search for and retrieve documents, reports, and dashboards from
any repository in EPM Workspace. The search operation returns a list of results based on locating
the users keywords in document-specific metadata; for example, document name, date created
or author (for Financial Reporting Word or PDF documents only), and extracting content-based
information from documents.
The following searches can be performed:
l

General searchSearch keywords in any part of all supported content published in EPM
Workspace
Context-sensitive searchSearch keywords associated with specific aspects of some content
in all supported content published in EPM Workspace
Search within a hierarchyGeneral or context-sensitive searches restricted to selected
branches of EPM Workspace or to selected repositories (Scorecard for example)
Data or metadata searchIf content is static in nature, then both metadata and data is
indexed (for example, filter name and selected values for the filter). If content is dynamic
in nature, then only metadata is indexed (for example, column name only).

When a search request is initiated, the index is searched for terms entered in the request. The
results are returned on another page as a list of document references and synopses, ranked in
order of relevance.
Search results are:
l

Categorized based on content type, modified date, and file locations within EPM Workspace

Introduction

35

Sorted by relevance or by modified date

Authorized; user credentials ensure that only user-authorized content authorized is returned

Search Services can also integrate with external applications and services. Connectors are
available for Oracle Secure Enterprise Search and Google OneBox. See Integrating Search
Services with External Applications in theOracle Hyperion Enterprise Performance Management
Workspace Administrator's Guide .

Indexing Keywords
Search Services are based on an index of keywords that is updated whenever documents are
modified. Different document types require different methods for keyword extraction.
Specialized parsers generate keyword information for different document types in a common
format. Whenever documents are published or updated in EPM Workspace, the appropriate
parser is activated to index or re-index keywords. The specialized parser understands the
document content and returns keywords to the indexing facility in a standard format. The
indexing facility creates the keyword index to facilitate a prompt search operation.
Parsers are available for the following content:
l

Interactive Reporting files (.bqy, .oce files)

Production Reporting (SQR programs, reports) files

Web Analysis files (.apt, .ard, database connection files)

Financial Reporting files (.des files)

Oracle's Hyperion Annotations database content

Impact Management Services transformation scripts (.js files)

HTML, PDF, RTF and TXT files

Microsoft Office documents (.doc, .xls and .ppt files)

Using the Search Service


A search can be initiated by typing one or more keywords in a text box located in the upper right
hand part of all EPM Workspace screens, and then either pressing Enter or clicking the search
button.

To use the Search Service:


1

Enter a keyword in the Search text box.

A Suggestion feature is available that spell-checks text and suggests alternative keywords if
available.
The search results are displayed on a separate page and include:
l

36

File name (clicking on this launches the document)

Using Search Services

Description

Document type

Last modified date

File path (double-clicking on this launches the folder)

If a Planning result is selected, a Planning tab is launched and supporting detail is displayed.

Optional. Order the search results according to Score or Last modified date.

By default, search results are sorted by score. A documents score or relevance is determined
by how many times the keyword appears in the document and how many other keywords
are in the document. For example, a document where the keyword appears three times but
only has five words scores higher than a document where the keyword appears 10 times but
with 1000 other keywords.

Optional. Filter the search results according to document type, modified date, or publish location.

Using Advanced Search


Search Services includes an Advanced Search feature that provides a convenient way to generate
advanced search queries.

To use advanced search:


1

Click the Advanced Search link on the Search Results page, or select Tools, then Advanced Search.

Enter or select the desired search criteria and click Search.

Advanced search options include:


l

All wordsEach document in the search results contains all the keywords entered.
At least one wordEach document in the search results contains at least one of the keywords
entered.
Without the wordsEach document in the search results does not contain any of the
keywords entered.
Written in (language)Restricts the results to documents written in a specific language.
The language is determined by an entry in the metadata and may not be applicable to all
document types.
To refine a search to allow for multiple languages, edit the search text field at the top of the
Search Results page.

Created in the pastRestricts results to documents created within a specific time frame,
such as within the past 24 hours or the past week.
The Custom date option activates a calendar control to search for documents created on a
specific date.

Using Advanced Search

37

The Custom date range option activates calendar controls to search for documents created
between a specified date range.
Modified in the pastRestricts results to documents modified within a specific time frame.

The Custom date option activates a calendar control to search for documents last modified
on a specific date.
The Custom date range option activates calendar controls to search for documents last
modified between a specified date range.
l

In folderRestricts results to a specific repository and folder name.

Only search (document type)Restricts results to documents of a specific MIME type.


To allow for multiple document types, edit the search text field at the top of the Search
Results page. For example, change sales +MimeType:application/x-brioquery to
sales +(MimeType:application/x-brioquery MimeType:application/pdf).
Hidden file optionsDefines whether to retrieve hidden files. The "hidden" attribute of a
file is set within the context of its repository. For example, it can be viewed or altered by the
Properties dialog in the EPM Workspace repository.

PriorityRestricts the results to documents of High or Normal priority. The "priority"


attribute of a file is set within the context of its repository. For example, it can be viewed or
altered by the Properties dialog in the EPM Workspace repository.

Order byDefines the sort sequence of the search results.

Table 9

Advanced Search Examples

Search Term

Request

"sales +LanguageCodes:de"

Documents that contain the term sales and the language to be German

"sales +(LanguageCodes:de LanguageCodes:es)"

Documents that contain the term sales and the language to be German, or documents
that contain the term sales and the language to be Spanish

Search Syntax
The basic Search Services syntax follows a number of rules. Terms can be logically grouped using
the following operators:
Table 10

Search Syntax Operators

Syntax

Description

AND

NOT

()

Parenthesis Apply an operator to a group of keywords

Quotes Search for the exact occurrence

38

Using Search Services

Syntax

Description

[]

Brackets Search for a range value

*, ?

Wild-card Used in the middle or at the end of words to indicate any values in place of the *

You can further restrict searches by searching for or excluding a specific category. The syntax
for a category is of the form category:search_term. Use quotes to search for exact strings in
categories. Use AND and NOT operators to logically add or remove categories.
Examples
Search for documents containing sales but not oracle:
+sales oracle

Search for documents containing the phrase radio sales:


radio sales

Search for documents containing sales but not oracle, or sales but not radio:
+sales (oracle radio)

Search for documents containing the terms sales and oracle:


+sales +oracle

Search for documents containing the terms rent and sales or rent and oracle:
+rent +(sales oracle)
(+rent +sales) (+rent +oracle)

Search for documents that have a file name starting with revenue but are not in the Sample
Content folder:
+FileName:revenue* -Path:Sample Content

Search for documents modified in the date range 15th Dec 2007 and 21st Dec 2007
+LastModifiedDate:[2007-12-15 TO 2007-12-21]

Search for documents modified in 2007


+LastModifiedDate:[2007]

Search for documents modified in December 2007


+LastModifiedDate:[2007-12]

Supported MIME Types


The following Mime Types are indexed by Search Services and can be used with Search
expressions.

Supported MIME Types

39

Table 11

MIME Types

MIME Type

Description

application/hyperion-analyzer-presentation

Presentation

application/hyperion-analyzer-report

Web Analysis Document

application/hyperion-annotation

Annotations

application/hyperion-reports-batch

Financial Reporting Batch

application/hyperion-reports-book

Financial Reporting Book

application/hyperion-reports-chart

Financial Reporting Chart

application/hyperion-reports-grid

Financial Reporting Grid

application/hyperion-reports-image

Financial Reporting Image

application/hyperion-reports-report

Financial Reporting Report

application/hyperion-reports-row_column

v Row and Column Template

application/hyperion-reports-snapshot_book

Financial Reporting Snapshot Book

application/hyperion-reports-snapshot_report

Financial Reporting Snapshot Report

application/hyperion-reports-text

Financial Reporting Text

application/msword

PDF File (.pdf)

application/pdf

PDF File (.pdf)

application/rtf

RTF File (.rtf)

application/sqr_viewer

Production Reporting Document (.spf)

application/vnd.ms-excel

MS Excel File (.xlsx,.xls)

application/vnd.ms-powerpoint

Powerpoint File (.pptx,.ppt)

application/x-brioquery

Interactive Reporting Document (.bqy)

application/x-SQR

application/x-SQR Production Reporting Job (.sqr)

BrioQueryJob

Interactive Reporting Job

OCEFile

Interactive Reporting Database Connection (.oce)

text/html

HTML File (.htm,.html)

text/im-javascript

Oracle Hyperion Impact Management Services JavaScript File (.js)

text/plain

text/plain Plain Text (.text,.txt)

40

Using Search Services

Security
End user queries return results and related content without breaching the security of documents
or data. Search results are based on a users security profile. The results do not include documents
that users are not authorized to see.

Security

41

42

Using Search Services

Exploring and Managing Items

3
In This Chapter

Using Explore ...............................................................................................43


Actions ......................................................................................................43
Locations ...................................................................................................44
File Permissions ............................................................................................44
Items ........................................................................................................45
Basics of Explore...........................................................................................48
Viewing Priorities, Exceptions, and Versions.............................................................49
Managing Files .............................................................................................50
Linking to Web Analysis Studio ...........................................................................53
Creating Email Links to Items .............................................................................54
Using Ambiguous Items ...................................................................................55
Registering a File Type.....................................................................................55
Exporting Items.............................................................................................55
Exporting to Smart View for Office ........................................................................56

Using Explore
Use Explore to list and navigate repository contents; manage and control files and folders; and
use elements, like the Open dialog box, that present the repository as a file management system.
Users roles and the installed Reporting and Analysis modules determine what parts of the user
interface is shown. As a result, some documents are displayed in the content area and others can
also be opened in their own studios. For example, you can set Interactive Reporting to always
open documents in the Oracle Hyperion Interactive Reporting Web Client.
Access privileges or permissions determine which items you can view, modify, run and delete
in the repository. See Setting Permissions and Pushing Artifacts on page 70.

Actions
l

Documents, files, and folders can be opened in four formats:


m

Interactive HTML

Portable Document Format (PDF), displayed by Adobe Reader

Using Explore

43

Text files

Operation messages, which are generated by applications or services and stored in logs

Interactive Reporting, Production Reporting, and Financial Reporting users can subscribe
to documents. When the documents are changed or updated, the users are informed.
Interactive Reporting, Production Reporting, and Financial Reporting users must import
documents before the documents can be accessed by other users. Importing distributes
previously private information for public consumption.

Locations
User preferences specify default startup options:
l

The Content area can be Explore, documents, Workspace Pages, repository locations, or
applications such as Performance Scorecard, Financial Management, Planning, Oracle
Hyperion Profitability and Cost Management, or Oracle Business Intelligence application
products. Startup options are loaded and displayed when users log on to EPM Workspace.
Tip: Set a folder to the directory which contains the most frequently-accessed content.

A Favorites folder contains a users most frequently sought repository content. All user
profiles feature Favorites folders, the files of which are accessed through the Favorites menu.
Favorites Manager can push content to users Favorites folders, providing one access point
for content.

File Permissions
EPM Workspace file permissions determine who has access to what files or folders and what
operations can be performed. You obtain access items as a user, as a group member, or through
a role given to you by the system administrator. For information on roles, see the Oracle
Enterprise Performance Management System Security Administration Guide. The level at which
you can access items and perform tasks is called access privilege.
Access to specific repository items is controlled by the document owner. Access to operations,
such as importing, running jobs, or updating document POV, is controlled through roles. For
example, the owner gives you the modify and run access privilege to Job A, but you can run the
job only if you have the Job Runner role. The owner gives you the full control access privilege
to Document B, so you can open and update the file. For information on setting file permissions,
see File Permissions.
Tip: When equivalent permissions conflict with each other, the permission that grants lesser

access takes precedence.

44

Exploring and Managing Items

When you import a file, you become the file owner, and you specify the access level of other
users. You might specify that all users can read the file, your group can modify the file, and only
you can delete, change access for, and move the file.

Items
Subtopics
l
l
l
l
l

Documents
Collections
Supporting Files
Other Standard Files
Folders

Items are objects stored in the repository, including files, folders, URL's and shortcuts. Items
are HTML files, Interactive Reporting database connections, jobs, batches, documents, reports,
and presentations.
All items have properties that store information about files such as attributes and access control
information. Properties include: type, a description of the file, and search keywords.

Documents
Documents are files created using Oracle's Hyperion applications. Documents include
Interactive Reporting documents, Financial Reporting reports, snapshots, Web Analysis
documents and Production Reporting documents. Documents are listed and viewed using
Explore. Items opened from Explore display as tabs at the top of EPM Workspace. The following
table describes viewable documents. Documents can contain and generate the following:
l

DashboardCollection of metrics and indicators provide interactive summaries of your


business.
ReportFormatted data values and interactive elements. Reports are displayed in tabular,
grid, or chart formats.
Table 12

Document types, descriptions, where created and file extensions

Type

Description

Created in

File Extension

Production Reporting
document

Reports querying a relational data source

SQR Production Reporting Studio

.spf

Interactive Reporting
document

Formatted, dynamic, document that


generates reports or dashboard typically
querying a relational data source.

Oracle Hyperion Interactive Reporting


Studio, Oracle Hyperion Dashboard
Development Services, and EPM
Workspace

.bqy

Web Analysis
document

Web Analysisdocument typically querying an


OLAP data source.

Web Analysis Studio and EPM Workspace

.ard

Items

45

Type

Description

Created in

File Extension

Collections
Collections contain references to groups of documents, such as books, presentations, or job
output files. Collections are listed and viewed using Explore. Items opened from Explore display
as tabs at the top of EPM Workspace.
Table 13

Collections in the Repository

Type

Description

Created in

File Extension

Job Output

Collection of files resulting from running a job.

EPM Workspace

Files are a variety of


extensions, such as .pdf, .
html, or .txt.

Interactive Reporting job


output

Production Reporting job


output

Generic job output

Books

Collection of Reporting Studio documents.


Dynamically specify dimension sections and
dimension changes for Books.

EPM Workspace

.kbk

Snapshot Books

Generated books containing static data.

EPM Workspace

.kbt

Batches

Collection of executable Reporting Studio


documents and books with special properties and
are executed to generate reports.

EPM Workspace

.bch

Presentation

Collections ofWeb Analysis documents.

Web Analysis Studio

.apt

Supporting Files
The following tables lists EPM Workspace supporting files used when authoring or managing
documents or collections.

46

Exploring and Managing Items

Table 14

Workspace Supported File Types, Descriptions,Studio Created in, and File Extensions

Type

Description

Job

Items with special properties that execute to


generate output. Jobs contain Interactive
Reporting documents.Production Reporting
documents or generic documents.

Studio created in
l

Interactive Reporting
Created with EPM
Workspace by importing
Interactive Reporting
documents.

File Extension
l

l
l

Production Reporting
Created with EPM
Workspace by importing
Production Reporting
program files (*.sqr).

GenericCreated with
EPM Workspace by
importing Oracle reports
or batch files. Generic
reports use a command
line interface.

Interactive
Reporting jobs do
not have file
extensions.
Production
Reporting jobs
have .sqr file
extensions.
Generic jobs can
have a variety of file
extensions, such
as .sh, .bat.

Interactive Reporting database


connection

Portable files defining terms, conditions, and


methods for connecting to data sources.

Interactive Reporting Studio

.oce

SQR Production Reporting


Studio files used by a
Production Reporting
document or Production
Reporting job.

Files that Production Reporting program


references when executed:

SQR Production Reporting


Studio

File extensions include .


cvs, .img, or .inc.

Include files (#include commands)

Input data files (Open for-reading


commands)

Image files (print-image and declareimage commands)

Folder

Containers that contains other folders and


files.

not applicable

none

Shortcut

Pointer to a repository item. Creates shortcuts


when you want an item to display in folder A,
though it is stored in folder B.

not applicable

none

URL

Link to websites or HTML pages.

not applicable

none

Grid

Reporting Studio object containing data from


external sources. Grids contain rows,
columns, and optionally, a page axis.

Reporting Studio

.rog

Chart

Reporting Studio object containing charts.

Reporting Studio

.roc

Image

Reporting Studio image object.

Reporting Studio

.roi

Text

Reporting Studio text object.

Reporting Studio

.rot

Row and Column Template

Templates used to author Financial Reporting


reports.

Oracle Hyperion Financial


Reporting Studio

.ros

Items

47

Type
l

Web Analysis Essbase


database connection
Web Analysis Financial
Management database
connection

Studio created in

File Extension

Portable files that defines the terms,


conditions and methods for connecting to
data sources for Web Analysisdocuments.

Web Analysis Studio

.adc

Web Analysis Relational


database connection
Web Analysis SAP Info
Cube database
connection
Web Analysis SAP
Multiprovider database
connection

Web Analysis SAP InfoSet


database connection

Web Analysis SAP ODS


database connection

Description

Web Analysis SAP Query


Cube database
connection

Other Standard Files


Other standard files include text files, log files, and Microsoft Office files. Administrators set the
types of files that the repository supports. See Registering a File Type on page 55.

Folders
Folders exist with the repository and are arranged in a hierarchical structure. Folders are used
for organization, they can contain subfolders and items such as jobs, documents, and URLs. The
root folder contains all files and folders.

Basics of Explore
Use Explore to list, find or view content. Items opened in Explore display as tabs at the top of
EPM Workspace. The View pane displays folders.
When items have high priority, multiple versions, or are manually flagged as an exception, an
icon is displayed. In order to see these icons the priority, version, or exception column must be
displayed.
Folder contents;
l

Sub-folders in the left pane; click the plus button next to the folder name.

Folders in the left pane and items in the content area; double-click the folder.

48

Exploring and Managing Items

Contents in the content area; click an item.

Note: When entering names for items in the repository such as files and folders, you can use

upper and lowercase letters and numbers. Spaces cannot be used at the beginning or end
of folder names. Invalid Name characters are as follows: \,/,%,?,+,<,>,|,`,*,". Invalid Path
characters are as follows: \,%,?,+,<,>,|,`,*,".
Note: Since importing Financial Reporting objects with invalid characters in their Names/Path

is still allowed, those objects once imported in EPM Workspace, should be renamed.
Scheduled Batches containing object names with invalid characters will fail when PDF
and HTML are selected as output options.

Viewing Priorities, Exceptions, and Versions


When an item is listed in Explore, an icon displays indicating priorities, exceptions, or multiple
versions. You can view and set the following conditions:
l

PriorityHigh or low priority.


Table 15

Priorities

File Type

Description

All items that have versions

Use version properties to set an items priority to Normal or High. Only available if your administrator
activated the priority feature.

Note: Priorities for scheduled jobs differ from an items priority. Set priorities on schedules

you associate with jobs. Priority is a property of schedule. If multiple job are scheduled
to run simultaneously, the high priority job is run first. The priority icon is not
displayed next to the job. See Scheduling Jobs on page 241.
l

ExceptionsIndicator of conditions or results such as a threshold being reached. Notify


subscribing users when an exception has been generated and monitor exceptions on the
Exceptions dashboard on your Personal Pages.
Table 16

Exceptions

File Type

Exceptions

Items with versions

Manually flag an exception on an item. See Version Properties on page 81.

Production Reporting jobs

Programmatically enable jobs to generate exceptions. The exception icon is not displayed next to the
job. See Using Exceptions on page 97.

Interactive Reporting jobs


Generic jobs

VersionsIndicates an item has multiple versions. See Working with Versions on


page 79.
Viewing Priorities, Exceptions, and Versions

49

To display the priority, versions or exceptions column:


1

Select View, and then Show Columns.

Click Priority, Version, or Exception.

Managing Files
Subtopics
l
l
l
l
l
l
l

Opening or Selecting Files or Folders


Creating Folders
Creating Documents or Collections
Moving or Copying Files or Folders
Renaming Files or Folders
Deleting Files or Folders
Searching for Files or Folders

Opening or Selecting Files or Folders


After opening a file or a folder, its contents display in the content area. Items have multiple
versions. Imported files are collections containing a single version. You can later save or import
additional versions. Versions can be revisions of the same file or completely different files.

To open files using the shortcut menu:


1

From the content area of Explore, right-click a file.

From the shortcut menu, select Open In

Select a format:
l

For Financial Reporting items, see Oracle Hyperion Financial Reporting Workspace User's
Guide.
For Interactive Reporting items, see Selecting an Interactive Reporting Data Source
on page 117.
For Web Analysis items, see Hyperion Web Analysis Workspace User's Guide.
For Production Reporting items, see Viewing a Production Reporting Document on
page 235.
For generic files,select an option to open the file in a Web browser.

To open files using default formats:


1

From Explore, double-click the file or folder.

To view or interact with the opened item, see Using Different File Types on page 84.

50

Exploring and Managing Items

To open or select a file or folder:


1

Select File, then Open, and then Document.

Navigate to the file or folder, and perform the following:


l

From the Name column, double-click the file or folder to open.

From Look in, select a folder.

To filter the list of items, from the Type list box, click the arrow, select the file type.
Tip: Click Go Up A Level to move up the folder hierarchy specified in the Look in: text

box.

Click Open.

Optional: To open a file with another application:


l

Click Options.

From Open As: select an application to open the file.


Note: Every file type on your local system maintains information about which

application will launch that type of file, and where the application resides. See
Registering a File Type on page 55.

Optional: To open a version of the item, from Versions list, select the version, click Open.

To view and interact with the opened item, see Using Different File Types on page 84.

Saving Files
Save files to replace them or save files using a new name, which creates a copy of the file. You
can save the following files in EPM Workspace:
l

Interactive Reporting document

Web Analysis document

Snapshot Book

Book

Batch

Workspace Page

To save a file:
1

Open the file.

Select File, and then Save.

To save the file with a new name; File, then Save As, specify a name and location.

Creating Folders
Create folders to organize files and documents.

Managing Files

51

To create folders:
1

From Explore, select File, then New, and then Folder.

Type a name for the folder, select Save.

Note: When entering names for items in the repository such as files and folders, you can use

upper and lowercase letters and numbers. Spaces cannot be used at the beginning or end
of folder names. Invalid Name characters are as follows: \,/,%,?,+,<,>,|,`,*,". Invalid Path
characters are as follows: \,%,?,+,<,>,|,`,*,".

Creating Documents or Collections


You can create the following documents or collections:
l

Interactive Reporting, see Using the Interactive Reporting Toolbars on page 112

Web Analysis, see Hyperion Web Analysis Workspace User's Guide.

Book or Snapshot book, see Oracle Hyperion Financial Reporting Workspace User's Guide

Batch, see Oracle Hyperion Financial Reporting Workspace User's Guide

Job, see Importing Files as Jobs on page 68

Moving or Copying Files or Folders


You can move or copy a file or folder to another location. The following applies to copying:
l

Copying of all document types in the EPM Workspace repository is supported with the
exception of Production Reporting job output files. A user must have a minimum of View
access.

The user that copies the repository object becomes the owner

Multiple documents can be selected for copy and paste

All metadata associated with a document is copied except for Job parameters and Schedules

Folders and its contents can be copied except for objects within a folder that have No Access
permission

Hidden files are copied if a user has View access

Copying of nested folders is not allowed

To move or copy files or folders:


1

Select

Select Edit, and then Cut or Copy.

Select the folder where you want to copy or move the item.

Select Edit, and then Paste.

52

, then the file or folder you want to or move or copy.

Exploring and Managing Items

Tip: To select consecutive files or folders to copy or move, select the first item, press and

hold down SHIFT, and select the last item. To select files or folders that are not
consecutive, hold down CTRL, and select each item.

Renaming Files or Folders


Rename files or folders by changing properties.

To rename files or folders:


1

Select Explore.

Select Edit, and then Rename.


Note: When entering names for items in the repository such as files and folders, you can

use upper and lowercase letters and numbers. Spaces cannot be used at the beginning
or end of folder names. Invalid Name characters are as follows: \,/,%,?,+,<,>,|,`,*,".
Invalid Path characters are as follows: \,%,?,+,<,>,|,`,*,".

Click OK.

Deleting Files or Folders


To delete files or folders:
1

Select Navigate, and then Explore.

Select Edit, and then Delete.


Caution!

Deleted files cannot be restored.

Searching for Files or Folders


Search Services enables users to search for and retrieve documents, reports, and dashboards from
any repository in EPM Workspace. The search operation returns a list of results based on locating
the users keywords in document-specific metadata; for example, document name, date created
or owner (for Financial Reporting Word or PDF documents only), and extracting content-based
information from documents. For more information, see the Oracle Hyperion Reporting and
Analysis Framework Administrator's Guide.

Linking to Web Analysis Studio


You can open Web Analysis Studio from EPM Workspace. Oracle Hyperion Web Analysis Studio
enables you to access and create documents and presentations.

Linking to Web Analysis Studio

53

Link to Web Analysis Studio by selecting Tools, and then Links. For more information, see
the Hyperion Web Analysis Workspace User's Guide.

Creating Email Links to Items


Email links to items in the repository. Link rules:
l

Recipients must be defined as a user with a EPM Workspace user name and password to
open the linked item in a Web browser.
Recipients need proper access privileges to view the item.
Items in the link can be viewed in Web browsers. A link to the item is sent not the item.
When you click on the link, EPM Workspace is opened and the item is displayed.

You cannot send an email link to a folder.

You must select and send email links one item at a time.

You can add text to the email message.

To create email links:


1

From the repository, select the item to email.


Tip: If the email link option does not display for an item, that item cannot be sent as an

email link.

Select File, and then Email Link.

The Email Link dialog box, containing the URL links is displayed.
If your default email address is not specified, you are prompted to request from the
Administrator to update your email address listed through Oracle Hyperion Shared Services.
Your email address is used as the sender for the email link.

Perform one of the following tasks:


l

Enter the recipients email address.

Use the Email Recipient List

Optional: Update the Subject text associated with the email message.

Click Send.
Note: You cannot recall a message after it is sent.

Using the Email Recipient List


Use the email recipient list to organize a list of recipients to which you send email links. By
entering addresses in this list you do not need to retype email address again. Two email recipient
lists are maintained; one to email links, one to email batch notifications.

54

Exploring and Managing Items

To use the email recipient list:


1

Select File, and then Email Links.

Click Select to display Email Link, and select recipients.

Optional: To add a recipient, in New Recipient, type the email address and click

Optional: To remove an email from the selected recipient list, select an email and click

.
.

Using Ambiguous Items


It is possible for different items to have the same name and reside in the same folder. These are
ambiguous items. When an ambiguous item is accessed, a list of items with the same name are
displayed. Select the item you want to use. This may happen when you perform the following:
l

Create email links to an ambiguous item.

Prompted to select related content links that link to an ambiguous item.

To select ambiguous items:


1

From the list, select the item you want.

To determine the differences between the items, do the following:


l

To view the item properties, right-click the item, select Properties.

To open and view the item, see Opening or Selecting Files or Folders on page 50.

Registering a File Type


The server maintains information about Repository items and which application to launch to
open that type of file and where the application resides.
Administrators create file types (technically, new MIME Types) or add file extensions to file
types. You may be informed of the new type by your administrator, or you may discover it while
browsing or trying to open a file. If there is a file type that your browser cannot open, you are
prompted for a program to open it. To avoid that prompt, you need to register the type in your
browser or operating system.
The procedure to register new file extensions or MIME types varies with each operating system,
its version, your browser, and the browsers version. Consult the documentation or on-line help
of the browser or operating system or ask your system administrator.

Exporting Items
From Explore, only Financial Reporting items have an export option. Export items for the
following usages:

Using Ambiguous Items

55

Locations outside of EPM Workspace. You can import items into a Studio or back into EPM
Workspace later. Financial Reporting items can export from testing environments to
production environments.
For use in Smart View, see Exporting to Smart View for Office on page 56.

To export items:
1

Select Navigate, and then Explore.

Select File, and then Export.

Navigate to items:
l

From the Look in: list box, select a folder.

To filter the list of items, from the Type list, select the file type.

Select the items, click OK.

Click Save.

Navigate to the location where you want to save the exported file.

Click Save.

Exporting to Smart View for Office


Subtopics
l
l
l
l

About Hyperion Reporting and Analysis Smart View Export Options


Importing Reporting and Analysis Content
Installing Smart View From EPM Workspace
Exporting Production Reporting Content to Microsoft Excel

This section describes Oracle Hyperion Smart View for Office functionality, concepts and
procedures.Smart View provides a common Microsoft Office interface for the following EPM
Workspace components:
l

Financial Reporting, see Oracle Hyperion Financial Reporting Workspace User's Guide
Production Reporting, Exporting Production Reporting Content to Microsoft Excel on
page 63

Web Analysis, see Hyperion Web Analysis Workspace Users Guide

Interactive Reporting, Interactive Reporting does not enable Smart View export options

It also provides a common Microsoft Office interface for Essbase, Financial Management and
Planning.
The centralized interface enables simultaneous use of multiple Hyperion products and improves
integration with Microsoft Office. The Smart View implementation provides the following EPM
Workspace functionality:

56

Exploring and Managing Items

Note: Review the Oracle Hyperion Enterprise Performance Management System Certification

Matrix for information on system requirements. You can find it at http://


www.oracle.com/technology/software/products/ias/files/fusion_certification.html
(under Business Intelligence).

Exports the current page of the current data object to Excel, Word, or PowerPoint
Exposes Financial Management and Essbase functions in Excel, Word, and PowerPoint
content
Notifies you when you can upgrade to new releases of Smart View

About Hyperion Reporting and Analysis Smart View Export


Options
Smart View enables the following export options:
l

You can export the current page of the current data object to Word, PowerPoint or Excel
as an image. After insertion, you can re-query the corresponding Web application to refresh
the image.

You can export documents to Microsoft Excel as either query-ready HTML or formatted HTML:
l

When you export content as query-ready HTML, the current page of the current data object
is converted to HTML and Hyperion-specific formatting is removed. This enables Smart
View to re-query the data source independent of the Web application.
When you export content as Formatted HTML, the current page of the current data object
is converted to HTML with the Hyperion formatting definitions and calculated members.
This specific formatting content prevents Smart View from directly querying the data source,
but enables Hyperion content to be leveraged by Office applications.

Not all export options are supported by all data sources and Web applications. The following
table indicates export options to Smart View:
Table 17

Smart View Export Options

Web Applications

Export Image to Microsoft Word, and


PowerPoint

Export Formatted HTML to Excel

Export Query-ready HTML to


Excel

Essbase

Yes

Yes

Yes

Financial Management

Yes

Yes

Yes

Planning

Yes

Yes

Yes *

Financial Reporting

Yes

Yes

Yes

Interactive Reporting

N/A

N/A

N/A

Production Reporting

N/A

Yes

N/A

Exporting to Smart View for Office

57

Web Applications

Export Image to Microsoft Word, and


PowerPoint

Export Formatted HTML to Excel

Export Query-ready HTML to


Excel

Web Analysis

Yes

Yes

Yes

Note: To export Hyperion Planning data sources in query ready format, you must use the

Essbase provider.
Note: Exporting charts from Production Reporting is not supported in this release.

Because Excel worksheets prevent users from entering data into read-only cells, some Excel
functions such as AutoSum, F9, and some formatting functions are disabled in Smart View. Also
note that you must have Microsoft Excel, Word, and PowerPoint installed on the computer
running the Hyperion Reporting and Analysis client.

Importing Reporting and Analysis Content


Using Smart View, you can import Financial Reporting through EPM Workspace. You can use
smart tags to import Reporting and Analysis content. For information on importing content
and using smart tags, see the Oracle Hyperion Smart View for Office User's Guide.

Importing Reporting and Analysis Content for Financial Reporting


Based on the type of Financial Reporting report you select for importing, you may be requested
to respond to prompts other than the default or log on to data source. The report may contain
default User POVs, Grid POVs or Page members that you can change or allow for expansion.
For additional information on these topics listed below, see the Oracle Hyperion Financial
Reporting Workspace User's Guide:
l

Responding to prompts

User POV

Grid POV

Page members

Expansion.

Changing a data source

To import Financial Reporting documents, in the Preview screen, select your options:
l

58

Select All Pages to import all pages for members listed in the Page drop-down; deselect All
Pages to import only the current page listed in the Page drop-down.
For Microsoft Excel only, select Split Pages across worksheets to place each member page
you selected in the Page drop-down on separate worksheet tabs; clear Split Pages across

Exploring and Managing Items

worksheets to place all member pages you selected in the Page drop-down on the same
worksheet.
l

Option for Excel only. To revert to the EPM Workspace Point of View, select Refresh Using
Workspace Point of View.
In the Import Document As drop down, select one of the following:
m

Fully-FormattedFor Microsoft Excel only. Select to display a fully formatted report


in HTML.
Query-ReadyFor Microsoft Excel only. Select to run an ad hoc analysis on a report
using Financial Management or Analytical Services data sources. Query-Ready is not
supported for Snapshot reports.
ImageFor Microsoft Word or PowerPoint only. Select to import the report as an
image.

Click Finish to import the report in your Microsoft Office application.

Importing Reporting and Analysis Content for Interactive Reporting


Interactive Reporting document sections can be imported into your Microsoft Office application
easily. Seamless options are available to retrieve and import the latest data from the database, or
to use the displayed data in the section for import. The Import Workspace Document wizard
for aInteractive Reporting document consists of the following dialogs. Depending on how the
document was designed, the database credentials and filter steps of the dialog may not appear.
l

Select a Document

Select an Action

Specify Database Credentials

Specify Filters

Preview

Selecting a Document for Interactive Reporting


This step of the wizard requires that you select the page(s) to import from a section.

To import an Interactive Reporting document section:


1

In Select Document, select Refresh and Preview and click Next. Preview is displayed. Refresh retrieves
the latest data from the database. To import only the displayed data in the section, select Preview.
Paging options are identical in Refresh and Preview.

In Preview, select an option:


l

Select All Pages to import all pages listed in the Page drop-down.
If you are importing all pages listed for use in Microsoft Excel only, you can optionally
select Split Pages across worksheet to assign each page to a worksheet.

Exporting to Smart View for Office

59

To import a specific page, select the page from the Page drop-down, and clear the All
Pages option.

Click Finish.

If the Interactive Reporting document requires a user name and password, or a variable filter
value, click Next.

Specifying Database Credentials for Interactive Reporting


This step of the wizard requires that you enter your database credentials to access a document.

To specify database credentials:


1

Enter your user name in the Username field.

Enter your password in the Password field.

Click Finish.

If the Interactive Reporting document requires a user a variable filter value, click Next.

Specifying Filters for Interactive Reporting


If a variable filter has been set for the query by the designer of the Interactive Reporting
document, the filter selections must be resolved before the query is refreshed and sections can
be imported. At that time, the user is prompted to select or enter filter values and complete the
constraint. Two methods of applying variable filters are available: Show Values and Custom
Values.
The Show Values method retrieves all potential values associated with the items from the
database. This allows you to consider and select from the actual range of values when selecting
a filter. This type of filter is useful when setting filters accurately without being familiar with the
contents of the database. Because Show Values retrieves every unique value available, it is best
not to use this feature when the data item is large, consists mostly of unique values, or does not
change frequently (for example, telephone numbers). In the situation, Custom Values are
recommended when you want to avoid extra calls to the database.
The Custom Values method retrieves a list of potential values saved with the filter or read from
a file. This method enables you to select values from a pre-defined pool. One reason to use
custom lists with a distributed document is that many data items change very rarely. For example,
a Gender item has three consistent values (male, female, and unknown). A Product line item
has many more items, but may only change every year or so. Under these circumstances, it makes
sense for you to select from a custom values list, rather than continuously querying to show
database values. The initial custom values shown in the values pane originate and are saved with
the document

To specify a variable filter using the Show Values method:


1

60

Select Show Values from the Values dropdown.

Exploring and Managing Items

Select Include Nulls to allow null values to pass the filter and appear in the data set.

Expand the (Comparison Operator) dropdown and select a comparison operator for the filter. Values
which meet the comparison test are included in the edit pane.

Check Not to reverse the operator selected in step 3.

Select the values that you want to include in the filter definition by highlighting them in the edit pane.
Use the left mouse button to select the values you wish to include. The value will be highlighted. The
[Ctrl] and [Shift] keys can be used to select multiple values.

Click Apply.

To specify a variable filter using the Custom Values method:


1

Select Custom Values from the Values dropdown. A list of custom values associated with the variable
filter are displayed in the edit pane.

Select Include Nulls to allow null values to pass the filter and appear in the data set.

Expand the (Comparison Operator) dropdown and select a comparison operator for the filter. Values
which meet the comparison test are included in the edit pane.

Check Not to reverse the operator selected in step 3.

Select the values that you want to include in the filter definition by highlighting them in the edit pane.
Use the left mouse button to select the values to include. The value will be highlighted. The [Ctrl] and
[Shift] keys can be used to select multiple values.

Click Apply.

Importing Reporting and Analysis Content for Web Analysis


Using Smart View, you can import Web Analysis documents into Microsoft Excel, Word and
PowerPoint. Web Analysis has five data object display types, but Smart View can import only
three types (spreadsheet, chart, and pinboard). Smart View cannot import Freeform Grid and
SQL spreadsheets.

To import Web Analysis documents:


1. In Specify Database Credentials:
l

Enter a Username and Password for each data source.

Select Skip to omit the credential to any of the data sources


Note: If a report has only one data source and you skip entering credentials, the report

is not imported. If your report has data objects with different data sources and
you only want to import one of the data objects, you can enter the credential for
the data object you want to import and skip credentials for the data objects you
do not wish to import.
l

Select Save Credential to save credentials with a Web Analysis object.

2. Click Next.

Exporting to Smart View for Office

61

3. In Preview Import Document As:.


l

For Excel, select Fully-Formatted to import a fully formatted HTML of the report, or
Query-Ready to run ad hoc analysis on reports when connected to Financial
Management and Essbase data sources.
For Word and PowerPoint, select Image to import the Reporting and Analysis document
as image objects.

4. If the data object has multiple Pages, select a page to import (combo box in top left) or select
All Pages to import all pages of the document. Leave the box cleared to import only the
current page.
5. For Microsoft Excel, Word or PowerPoint, select Split pages across worksheets to display
each page on a separate worksheet. For Query-Ready, when All Pages is selected, the pages
are split across worksheets.
6. In PreviewAll Report Objects for Microsoft Excel, Word and PowerPoint
l

Select Split pages across worksheets to display each page on a separate worksheet instead
of one worksheet.

Select All Objects to import all objects of the report.

Select Split objects across worksheets to display each object on a separate worksheet.

7. In PreviewAll Reports for Microsoft Word and PowerPoint: select Import Screen to
import a screen print of the entire report.
8. Click Finish.

Importing Reporting and Analysis Content for Production Reporting


To import a Production Reporting job:
1

In Select a Document, expand the repository and select the job to import.

In Specify Parameters, define the job parameters.

The parameters displayed depend on the job selected. Possible parameters include:
l

62

Define job parameters starting withSelect the desired starting point from which to
define job parameters. (The values that appear are the values defined in the import job
process.)
Set valuesSelect desired values for job parameters.
Save as my defaultSelect to save the job parameters as public or private, and enter a
job parameter name.Select to save the job parameters as the default parameters for the
job.
Save

In Preview, preview the job output and select display options.


l

PageFor multiple-page jobs, use the browse buttons to select a page to preview.

All PagesSelect to import all pages. Clear to import only the current page.

Exploring and Managing Items

Split pages across worksheetsExcel only: Select to place pages on separate worksheet
tabs. Clear to place all pages on the same worksheet.

Split pages across pagesWord only. Disabled for Production Reporting jobs.

Split pages across slidesPowerPoint only. Disabled for Production Reporting jobs.

Click Finish to import the job into your Microsoft Office application.

Installing Smart View From EPM Workspace


Smart View is installed with Hyperion Reporting and Analysis but to use Smart View you must
also separately install a client component. This Office client component is displayed as a
Hyperion menu and toolbar within the Microsoft Office suite.
Note: Before installing Smart View, exit the Interactive Web Client and Microsoft Office

applications, and enable pop-ups.

To install the Smart View client from EPM Workspace:


1

Select Tools , then Install, and then Smart View.

The Hyperion Smart View installation wizard is launched.

Accept the default installation options.

By default, the installation wizard installs Smart View program files to C:\Hyperion
\SmartView. You can specify an alternative installation directory.

Reopen the Microsoft Office application.


Note: If Word fails to display the Hyperion menu, create a data source connection in Excel

then restart Word.

Exporting Production Reporting Content to Microsoft Excel


To export content to Microsoft Excel as Fully-Formatted HTML:
1

Select Navigate , then Explore and choose File, then Import, and then File as job.

Click Browse and select an SQR job.

Proceed through the pages in the wizard. When you get to the last page, select Excel (.xls) as the output
option.

Look in the Table of Contents for the Excel output.

Exporting to Smart View for Office

63

64

Exploring and Managing Items

Importing Artifacts

4
In This Chapter

Importing....................................................................................................65
Importing Artifacts .........................................................................................67
Setting Permissions........................................................................................70
Creating Shortcuts .........................................................................................75
Working with Properties ...................................................................................75
Working with Versions .....................................................................................79

Importing
Subtopics
l
l

Interactive Reporting Documents and Jobs


HTML Files

Importing artifacts to the repository makes them available to others. You might give users the
ability to modify one artifact, while limiting others. See Setting Permissions on page 70 for
detailed information on permissions.
Note: If you try to import an artifact whose MIME type is not defined, you get an error message.

Contact your administrator to create the MIME type.


Table 18 shows the Reporting and Analysis products and artifacts you can import:

Importing

65

Table 18

Reporting and Analysis Products and Associated Artifacts

Reporting and
Analysis Product
Financial
Reporting

Description
l

Dynamic report (*.des)

Snapshot reports (*.rpt)

Books (*.kbk)

Snapshot Books (*.kbt)

Batch files (*.bch)

Supporting files, see Supporting Files on page 46

Note: To import these files, you must use the Import, then Financial Reports menu item.
Production
Reporting

Interactive
Reporting

Web Analysis

Documents to view (*.spf)

Program files to run as jobs (*.sqr)

Supporting files, see Supporting Files on page 46

Documents to view and modify (*.bqy)

Documents to run as jobs (*.bqy)

Supporting files, see Supporting Files on page 46

Documents for interactive analysis (*.arg)

Presentations (*.apt)

Supporting files are automatically imported with the document or presentation, see Supporting Files on page
46

Note: To import these files, you must use the Web Analysis Studio.
Microsoft Reports

A user can browse the Microsoft Report server repository. The user can then import a link to a Microsoft Report as a
URL object into EPM Workspace repository. SeeImporting Microsoft Reports for more information.

Interactive Reporting Documents and Jobs


Import an Interactive Reporting document as a file to use it with interactive analysis. Import an
Interactive Reporting document as a job for scheduled or on-demand execution and distribution
of output. The import essentially creates the job.
Note: If the Interactive Reporting document you are importing uses row-level security, the row-

level security feature is applied when job queries are processed. When users process queries
to get more detailed information, their row level security restrictions would be applied at
the more detailed levels, such as sales data for their region or department only.
Table 19

When to Import an Interactive Reporting Job

Function

File

Interactive with EPM Workspace

66

Importing Artifacts

Job

Function

File

Job

Schedule automatic execution

Distribute output via Email

Produce multiple-cycle output

Distribute output to network directories

Import current results for analysis with Interactive Reporting Web Client

FTP output

Print output

HTML Files
HTML image links and other HTML files are dependent on their folder locations. Ensure the
links remain functional after you import them:
l

Use relative links in the HTML

Create folders that mirror the folder structure

Importing Artifacts
Subtopics
l
l
l
l
l

Importing Files
Importing Multiple Files
Importing Files as Jobs
Importing a URL
Importing Microsoft Reports

Importing Files
Import files into the repository with the following exceptions:
l

For importing Financial Reporting files, see Oracle Hyperion Financial Reporting Workspace
User's Guide.
For importing files as jobs, see Importing Files as Jobs on page 68.
For Interactive Reporting .oce files, see Setting Processing and Metadata Options on page
263.
For importing URLs, see Importing a URL on page 69.

Importing Artifacts

67

To import files:
1

From Explore, navigate to the folder where you want to import the artifact.

Select File, then Import, and then File.

Browse to the file you want to import.

Enter a description, click Next or select Finish without specifying any Advanced options. If you select
Finish, skip the following steps.

Enter properties, see Advanced Properties on page 77.

Complete permissions, , see Setting Permissions and Pushing Artifacts on page 70.

Click Finish.
Note: To return to a previous pages, click Back.

Importing Multiple Files


l

Files must be imported to the current folder


Import different file types together, for example, import text files, HTML files and image
files.
You cannot import multiple Interactive Reporting files (*.bqy, *.oce) or Production
Reporting files (*.sqr, *.spf)

To import multiple files:


1

From Explore, navigate to the folder in which you want the files to reside.

Select File, then Import, and then File.

Click Multiple Files.

Select the files to import.

Browse for the first file. Click >> (right-facing arrows) to add the file to the list. To delete
files from the list, select the file and click << (left-facing arrows).

Optional: Enter a description, and click Finish to complete the import without specifying any Advanced
options.

Click Next.

Enter properties, See General Properties on page 76 and Advanced Properties on page 77.

Click Finish to import the artifact.

The artifacts are imported into the current folder.

Importing Files as Jobs


Import Production Reporting program files (*.sqr) to create Production Reporting jobs,
Interactive Reporting documents (*.bqy) to create Interactive Reporting jobs or generic files to

68

Importing Artifacts

create generic jobs. Schedule, set options on and execute the job using the Schedule module, see
Scheduling Jobs on page 241.

To import files as jobs:


1

From Explore, navigate to the folder where you want to place the artifact.

Select File, then Import, and then File as Job.

Browse to the artifact you want to import, and click Next.

Do one of the following to complete the Import wizard:


l

For Production Reporting files and generic jobs, see Chapter 10, Using Production
Reporting and Generic Jobs. This chapter guides you through the steps to complete
this wizard.
For Interactive Reporting BQY files, see Chapter 10, Using Production Reporting and
Generic Jobs..

To complete step 2 (Job Input/Output) of the Import dialog do the following, for an Interactive Reporting
job:
l

For Query properties, see Setting Data Source and Query Properties on page 260.
For Job properties, seeSetting Interactive Reporting General Properties and Options
on page 261 and Setting Interactive Reporting Job Properties on page 259.
For Job defaults, see Setting Job Defaults on page 261.

Enter properties, see General Properties on page 76 and Advanced Properties on page 77.
Required properties are marked with a red asterisk.

Click Next.

Complete the final step in the Import wizard Permissions, see Setting Permissions and Pushing
Artifacts on page 70.

Click Finish or Finish and Schedule.

Importing a URL
Perform these steps to import URLs.

To import URLs:
1

From Explore, navigate to the folder where you want to place the artifact.

Select File, then Import, then URL, and enter the URL name.

Optional: Enter a description, and click Finish to complete the import without specifying any Advanced
options or Permissions.

Click Next, then see General Properties on page 76 and Advanced Properties on page 77.

Required properties are marked with a red asterisk.

Complete step 3, Permissions. To specify permissions for the artifact, see step 1.

Importing Artifacts

69

Click Finish.

Importing Microsoft Reports


EPM Workspace users with a Content Publisher role can import Microsoft reports to the EPM
Workspace repository. Browse the Microsoft report server repository and import as a link a
Microsoft report to the EPM Workspace repository. The link is in the form of a URL object and
any user can launch a Microsoft report URL object as a tab in EPM Workspace. For details on
how to setup Microsoft Reports Integration with EPM Workspace, see the Oracle Hyperion
Reporting and Analysis Framework Administrator's Guide.

To import Microsoft reports:


1

Select a folder from the EPM Workspace repository.

Right-click and select Import then Microsoft Reports.

From the Import Microsoft Reports dialog, select a Microsoft Report.

Select Import.

A URL object is created in the EPM Workspace repository.

Setting Permissions
Subtopics
l
l

Setting Permissions and Pushing Artifacts


Setting Permissions on Interactive Reporting Documents

Access permissions define your level of access - view, modify, full control. When you import
artifacts, you:
l

Specify who gets access and to what level


Have full control over the artifacts you import, and can change the permission level for all
roles, groups, and users
Efficiently grant permissions through roles or groups rather than to individual users

Setting Permissions and Pushing Artifacts


Set artifact permissions when you import or select an artifact. Push artifacts to be accessible to
Favorites.
Rules for setting permissions and pushing artifacts:
l

70

To push artifacts, you need proper permissions and a role that enables you to push them.
Push any artifact, except multiple-cycle jobs and folders.
Make artifacts accessible in the repository by changing their permissions

Importing Artifacts

Make artifacts accessible on Favorites by pushing them to Favorites

To apply permissions to artifacts within folders, you need proper permission and role.

To edit permissions for files and folders:


1

From Explore, right-click the file or folder whose permissions you want to modify.

You can select multiple items in Explore and apply Edit Permissions. Permissions can only
be applied to items that a user has Full Control permission.

Select Edit Permissions.

To complete Apply Permissions to Children dialog, see Applying Permissions to Children of the Selected
Folder.

To apply permissions to artifacts in a folder:


1

Right-click on a folder in Explore.

Select Apply Permissions to Children.

To complete Apply Permissions to Children dialog, see Chapter 4, Importing Artifacts.

Set permissions for the children of the folder.

The columns displayed for selected users, groups, and roles in the Apply Permissions to
Children dialog depend on the artifact type within the folder. Use the description for each
of the permissions as a guideline:
l

InheritNot set to anything. Inherit defaults to No Access.

No AccessUsers cannot see the object.

ViewView document but cannot modify.

Job Output OnlyView and produce output in the folder. No additional Modify
capabilities.
ModifyMake changes but not delete.
Full ControlAccess the Apply Permissions to Children dialog (add/edit/delete
permissions to other users/groups/roles).
RunAbility to run a job.
Modify and RunApplicable only to jobs. You can modify the properties of the job
and run the job. If you have modify permission only, you can modify the properties of
the job but not run the job.
View and ProcessView documents and refresh data, cannot modify. These are
adaptive states and are applicable only to Interactive Reporting artifacts
AnalyzeCreate and modify charts, pivots, and reports in the document, but cannot
modify the queries or refresh the data. These are adaptive sSates and are applicable only
to Interactive Reporting artifacts.
Analyze and ProcessCreate and modify charts, pivots and reports in the document
and refresh data. Cannot modify the query.

Setting Permissions

71

Query and AnalyzeCreate and modify charts, pivots and reports in the document and
refresh data. Can build and limit queries before processing.
Data Model and AnalyzeCreate and modify charts, pivots and reports in the
document and refresh data. Can build and limit queries before processing. Can create
and modify data models. These are adaptive states and are applicable only to Interactive
Reporting artifacts.

Once you are done making your selections, select OK.


Note: Permissions are only applied to artifacts within a folder in which a user has Full

Control permission.
Example of Inherit Permission
The following is an example of a BQY file and permissions set in the Permissions dialog.
UserA:
l

Inherit for File Permission

View for Adaptive State

Inherit for Favorite

GroupA:
l

View for File

Process for Adaptive

Inherit for Favorite

RoleA:
l

Modify for File

Datamodel for Adaptive

Pushed for Favorite

Result of above scenario:


l

If UserA belongs to GroupA then UserA is able to View the File

If UserA has RoleA then UserA can Modify the File

If UserA does not belong to GroupA or RoleA then UserA has NoAccess to the file

Inherit basically means inherit from the role's or group's permissions and the same applies for
Favorites.
Applying Permissions to Children of the Selected Folder
In the dialog, Apply Permissions to Children of the Selected Folder, you can choose to overwrite
or merge permissions, thus eliminating the need to redefine permissions from scratch.

72

Importing Artifacts

Note: Permissions change for all files in folder when you click OK. However, permissions are

not saved for future use. If a new artifact is subsequently added to that folder, it does not
get this permission. However, you can go to individual artifacts in that folder and change
the permissions.

To change permissions or push artifacts:


1

Specify selected users, groups, and roles.

a. To populate the list with all users, groups or roles leave the text box blank, select Update
List.
b. To populate the list with specified users, groups or roles:
i.

To filter the list by name, select begin with, contain, or are in group and enter
letters.

ii.

To filter the list by user type, select tabs for Users, Groups, or Roles, then click
Update List.
Available Users, Groups, and Roles display artifacts based upon the selections you
made in the drop-down lists.
Note: If all of the artifacts are not listed, filter the list with criteria or contact your

administrator. Your administrator determines the maximum number of


artifacts to list. Wild cards are not supported and the filter is not case
sensitive.

Select a user, group, or role from Users, Groups, or Roles tab, then click

From Selected Users, Groups and Roles select a name from the Name column. From Access or Access
to file drop-down set permissions:
l

InheritNot set to anything. This permission defaults to No Access.

No AccessCannot access the document.

ViewCan only display the document.

ModifyChange, but not delete.

Full controlDisplay, change, and delete.


See Setting Permissions on Interactive Reporting Documents on page 74.

From the Favorite drop down, select Pushed to push the artifact to the users Favorites or Inherit (not
pushed) to view only if this is the only permission set.

Repeat previous steps to set additional permissions for other users, groups, or roles.
Note: If all of the users/groups/roles in which you have access to are not listed, filter the list

with different criteria or contact your administrator. Your administrator determines


the maximum number of users/groups/roles to list.

Select one of the following:

Setting Permissions

73

a. To remove existing permissions and set new permissions, select Overwrite current
permissions.
b. To redefine some permissions, and add new permissions to the existing ones, select
Merge with the current permission. The changes are applied to folder child elements
recursively.
Note: In a merge, if a user already exists in Apply Permissions to Children for some

artifacts, and this user is granted new permissions, the new permissions are in
force.

To apply these permissions for an artifact, click OK.

Do the following:

a. For files, if you want permissions to apply to other imported content by default, click
Make these the default permissions for all files I import.
b. For folders, if you want permissions to apply to other imported content by default, click
Make these the default permissions for all folders I create.
This automatically sets the same permissions for all files and folders you import. You can
change permissions for each file or reset your default access permissions.

Click OK.
Note: To remove a role, group, or user from the selected list, click

after highlighting the

name to be removed.

Setting Permissions on Interactive Reporting Documents


These permissions apply to Interactive Reporting files and jobs:
l

Adaptive states specify what functionality is available to users when viewing an Interactive
Reporting document.
Only user who ran the job has access to the job output specifies you are the only user who
can access the job output.
Note: When importing an Interactive Reporting job, assign an adaptive state on the job

output to access it.


Table 20

74

Adaptive States and Their Descriptions

Adaptive State

Description

Inherit

Not set to anything. This permission defaults to View Only if this is the only permission set.

View Only

View document, but cannot modify.

View and Process

View documents and refresh data, cannot modify.

Importing Artifacts

Adaptive State

Description

Analyze

Create and modify charts, pivots, and reports in the document, but cannot modify the queries or refresh
the data.

Analyze and Process

Create and modify charts, pivots and reports in the document and refresh data. Cannot modify the query.

Query and Analyze

Create and modify charts, pivots and reports in the document and refresh data. Can build and limit queries
before processing.

Data model and Analyze

Create and modify charts, pivots and reports in the document and refresh data. Can build and limit queries
before processing. Can create and modify data models.

Creating Shortcuts
Create a shortcut to a file or document.

To create shortcuts:
1

From Explore, navigate to an artifact.

Right-click the artifact, and click Create Shortcut.

Enter the name and folder.

See General Properties on page 76 and Advanced Properties on page 77.

Working with Properties


Subtopics
l
l
l
l
l
l
l
l
l
l

General Properties
Changing Ownership of Artifacts
Advanced Properties
Output Properties
Interactive Reporting Properties
Production Reporting Properties and Generic Job Properties
Setting Permissions
HTML File Properties
URL Properties
Interactive Reporting Database Connection Files

This section describes how to modify properties of repository artifacts. You specify properties
when importing and modifying artifacts. See Importing Artifacts on page 67 to learn how to
access properties pages while importing artifacts.

To access properties:
1

From Explore, select an artifact.

Creating Shortcuts

75

Select File, and then Properties.

General Properties
Most artifacts have these general properties:
Table 21

General Properties for Artificats

General Properties

Definitions

File

File name and path.

Name

Name assigned to the file. For example, if the file is c:\Jan03SR set the name to January 2003
Sales Report.Use letters, numbers, a space, and an underscore (_).
Note: For Production Reporting jobs, select Replace to replace this job with another. Replacing this file may
impact existing schedules dependent on this file. Owners of these schedules must be notified of these changes
so that they can modify the job parameters accordingly.

Description

Description used to generate search keywords. Limit the length to 250 characters.

Owner

User Name of the person who imported the artifact. To change owner of an artifact, see Changing Ownership
of Artifacts on page 76.

Original File Name

(Read-only) Name of the file when it is imported or created.

Size

(Read-only) file size

SmartCut

(Read-only)
AURL pointing to a file.

Shortcut To Folder

Folder and subfolders for shortcuts.

Also store file in


compressed (.zip)
format

Set this when you import to store the file in WinZip format. This saves disk space, but slows down viewing.

Changing Ownership of Artifacts


Users can change the owner of repository artifacts. Artifacts you can change ownership for
include, repository objects, folders (including sub-folders), Events, Job Parameters, and
Schedules. A user must have Full Control or Administrator role rights.

To change the owner of an artifact:


1

From Explore, select an artifact.

Select File, and then Properties.

From the Properties dialog, select Change Owner.

Perform the following to complete the Change Owner dialog:

a. Select how you want to sort the name list by, User ID, First name, or Last name from
the first drop down menu.
76

Importing Artifacts

b. To filter by name, select begin with, contain, or are in group and then enter letters.
c. Select Update List.
d. Select OK.

Select OK.

Advanced Properties
Some artifacts have these advanced options:
Table 22

Advanced Properties for Artifacts

Advanced Properties

Definitions

MIME Type

(Read Only) Multipurpose Internet Mail Extensions. Update this for jobs and documents only, MIME types
are MS Word file, HTML file, and Personal Page.

Security Tags Included

(Read only) Indicates whether the Production Reporting job is secure. Secure jobs are Production Reporting
only and always have HTML output.

Character Encoding

The character-encoding method, such as UTF-8. This encoding must be specified for HTML files so that EPM
Workspace can display the file correctly.
If the character encoding is not specified in this property or in the HTML file, EPM Workspace uses the default
encoding of the Application Server's JVM.

Hidden File

Hides files in Explore.


Example: Enable this option for image files needed by an HTML file, so the users select HTML files only.

Auto-delete file on this


date or Auto-delete
shortcut on this date

Enable to automatically delete this artifact .


from the repository when these conditions are met:
l

The expiration date passed.

Auto-delete is selected.

The system performs regular garbage collection (up to an hour after the expiration date).

For folders, set auto-delete to occur after all contents have been deleted from the folder.

If Exceptions are
generated, allow users to
add to their Exceptions
Dashboard

The Exceptions dashboard is displayed on a Personal Page.

Automatically generate
keywords

Generates search keywords based on words contained in the Name and Description. For Interactive Reporting
content, the section names are also used as keywords. The search function uses these keywords to find an
artifact.

Keywords

New keywords used to search for an artifact.

This field is not used for jobs. When a job exception occurs, subscribed users can be notified by Email or
with a Exceptions Dashboard indicator.

Creating keywords for artifacts is highly recommended and used for searching repository artifacts.

Working with Properties

77

Advanced Properties

Definitions

Auto Delete job outputs


after

Used to delete job output after a specified time interval. The job output is deleted when all of these conditions
are met:
l

The expiration date passed.

Auto-delete is checked.

The system performs its regular garbage collection (up to an hour after the expiration date).

Output Properties
Output properties option is displayed for Interactive Reporting and Production Reporting jobs.
A summary of the job outputs with the respective dates and output formats that the job outputs
are available in are displayed when this property is selected for one of these products. You can
also delete a selected output from the Output Summary.

Interactive Reporting Properties


In addition to General Properties and Advanced Properties, Interactive Reporting files and jobs
have unique properties. See Setting Interactive Reporting Job Properties on page 259.

Production Reporting Properties and Generic Job Properties


In addition to General Properties and Advanced Properties, Production Reporting files and
Production Reporting jobs have unique properties. See Job Properties on page 276 and
Generic Job Properties on page 286.

Setting Permissions
Set rights for users to access files. See Setting Permissions and Pushing Artifacts on page 70.

HTML File Properties


In addition to General Properties and Advanced Properties, HTML files contain these unique
properties also:
Table 23

HTML File Properties

HTML File Properties

Descriptions

Character encoding

The method of character encoding.


Note: Use UTF8 for non-Latin-1 languages or when using WebSphere or iPlanet native servlet
engines.

Make displayable as a file


content window

78

Importing Artifacts

Contents of this artifact can be displayed on Personal Pages. (Default is enabled.)

URL Properties
In addition to General Properties and Advanced Properties, URLs have these properties:
Table 24

URL Properties

URL Properties

Descriptions

URL (in the General Properties


group)

The URL starts with http:// or https://.

Make displayable as a file


content window

Contents of this artifact can be displayed on Personal Pages. (Default is enabled.)

Character encoding

The method of character encoding for the Web page.


Note: Use UTF8 for non-Latin-1 languages or when using WebSphere or IPlanet native servlet engine.

Icon

The icon shown for the URL. To change the icon, click Change Icon.

Change Icon

Select to add a graphic file from your PC or from the repository. Set the width and height to smaller
than 24 pixels.

Interactive Reporting Database Connection Files


These files are used by Interactive Reporting jobs and Interactive Reporting documents to
connect to databases. Separate Interactive Reporting Database Connection file must be specified
for each query within a file or job, except for queries that use Local Results. See Selecting
Database-Connection File Options on page 262.

Working with Versions


Subtopics
l
l
l
l
l
l

Opening a Version
Adding a Version
Viewing or Modifying Properties of Versions
Version Properties
Listing Multiple Versions
Deleting Versions

Repository artifacts have multiple versions, except for jobs, job output, Interactive Reporting
database connection files, shortcuts, Web Analysis artifacts and Financial Reporting artifacts.
Typical files are collections of versions, even if you have not imported multiple versions. When
a file is imported, the resulting artifact is a collection containing a single version. You can later
import additional versions.
Versions can be revisions of the same file or completely different files. If the file is considerably
different from the original file, you should import a new file with a unique name.

Working with Versions

79

Note: To change imported versions for Interactive Reporting jobs or Interactive Reporting

database connection files, use Replace in General Properties. It is important to replace


the Interactive Reporting job or Interactive Reporting database connection file with a
similar file. If the Interactive Reporting job is considerably different from the original
Interactive Reporting job, import a new job. The system accepts files as replacements for
Interactive Reporting jobs or Interactive Reporting database connection files.
Click an artifacts name for the latest version. When you move or delete an artifact, versions are
included in the operation.
Versions have their own properties that are distinct from the properties of their collection
artifact.

Opening a Version
Open any artifact version, see Opening a Version on page 80.

Adding a Version
Add another file as a version to an artifact in the repository.
Note: All artifacts in the repository can have multiple versions, except for jobs, job output,

Interactive Reporting database connection files, shortcuts, Web Analysis artifacts and
Financial Reporting artifacts.

To add versions:
1

From Explore select an artifact.

Select File, and then Properties.

The Properties dialog is displayed.

Select Versions, and click Add New Version .

Click Browse and select a file to add as a new version.

Optional: Do one or more of these steps:


l

Enter a Description.
Enable Flag as an exception, then enter a message. If an exception occurs, the message
is displayed on the Exceptions dashboard.
Set the priority to High or Normal.

Click OK.

The version is added to the repository as the latest version.

80

Importing Artifacts

Viewing or Modifying Properties of Versions


Each version has its own properties.

To view or modify properties of versions:


1

From Explore, click the artifact whose version you want to edit.

Select File, and then Properties.

Select Versions.

Select Modify.

The only changeable properties are Description, Flag as an Exception, and Message, see
Version Properties on page 81.

After modifying properties, click OK.

Version Properties
Table 25

Version Properties

Version Properties

Descriptions

Description

A description that identifies this version. Using preliminary figures as of 2/03 or First draft with Marketings
comments. The length is limited to 250 characters.

Creation date

(Read-only) Date the version was created.

Last modified

(Read-only) Date the version was changed. Changing versions includes replacing or modifying its properties.

Modified By

(Read-only) User, who made the last modification to the version.

Priority

Normal or High priority shows in Explore,


priority artifacts.
Note:

indicates high priority. Users can sort on priority, and search for high-

does not display for high-priority scheduled jobs.

This property is available if your administrator activated the priority feature on your system.
Size

(Read-only) The file size which is set automatically.

Flag as an
exception

An exceptions indicates a condition or result, such as a threshold being reached. Flag as an exception can be set
manually by a user.
If you set this option on the latest version of an artifact, put the artifact on your Exception Dashboard, its state is
displayed on the Exceptions Dashboard. See Using Exceptions on page 97.

Message

Text associated with an exception for this version. When an exception is flagged on the version, this message prints,
or it may be visible from a users Exception Dashboard.

Listing Multiple Versions


From Explore, the latest artifact version is displayed in the content area.
Working with Versions

81

To see all versions:


1

Select View , and then Show Columns.

Click Versions, and then click Save.

Deleting Versions
Delete one or more versions together.

To delete versions:
1

From Explore, navigate to the artifact whose version you want to delete.

Select File, and then Properties.

The properties of the artifact are displayed.

Click Versions, and then select a version.

Click Delete Selected.

Click OK.

82

Importing Artifacts

Viewing and Organizing


Information

In This Chapter
Viewing......................................................................................................83
Using Different File Types .................................................................................84
Creating a New Book, Batch, Document, or Workspace Page .........................................84
Selecting a Data Source for a Document................................................................84
Using Favorites .............................................................................................85
Using Subscriptions........................................................................................87
Using Personal Pages......................................................................................90
Workspace Pages ........................................................................................ 104
Workspace Page Content Area ......................................................................... 108
Using Home Page ........................................................................................ 108

Viewing
To view, interact, and modify content within documents use Workspace Pages, Home Page,
Explore, Applications, and Open Items. These can all be accessed from the Navigate menu.
l

Workspace PagesEnable users to create and edit a page aggregating content from various
sources.
Home PageProvides a starting point for users and launching point for EPM Workspace
functionality.
ExploreNavigate through the repository to locate files and folders.
ApplicationsSelect Oracle Hyperion Financial Management, Planning, Oracle Hyperion
Profitability and Cost Management, Oracle Hyperion Financial Data Quality Management
ERP Integration Adapter for Oracle Applications, Oracle Business Intelligence products, or
Performance Scorecard for viewing or launching.
Open ItemsSelect the document name to view in the contents pane. Opened documents
display in this list. Use the View pane to interact and view a document. For example, use the
View pane to navigate through specific information for the active document. If the active
document is a Web Analysis document, the document panel displays options such as filters,
pages, and row sections in a Windows Explorer format.

Viewing

83

Using Different File Types


For information on how to view and use each file type, see:
l

Oracle Hyperion Enterprise Performance Management Workspace User's Guide

Interactive Reporting on page 111

Using Production Reporting Documents on page 235

Hyperion Web Analysis Workspace User's Guide

Creating a New Book, Batch, Document, or Workspace


Page
The new document wizard creates the following items:
l

Web Analysis documents, see Hyperion Web Analysis Workspace User's Guide
Interactive Reporting documents, see Interacting with Interactive Reporting Documents
on page 115

Books, see Oracle Hyperion Financial Reporting Workspace User's Guide

Batches, see Oracle Hyperion Financial Reporting Workspace User's Guide

Workspace Pages, see Workspace Pages on page 104

Note: All of these items may not be available from the New Document wizard. These items are

only displayed and available if the product relating to the item has been installed.

Selecting a Data Source for a Document


When creating documents you need to specify the data source. This determines the document
type.
l

84

To create a Web Analysis document, specify a Web Analysis database connection. See
Hyperion Web Analysis Workspace User's Guide.
To create an Interactive Reporting document, based on an existing document, specify a
Interactive Reporting document. See Interacting with Interactive Reporting Documents
on page 115.

Viewing and Organizing Information

Using Favorites
Subtopics
l
l
l

Adding Items to Your Favorites


Pushing Items to Favorites
Managing Favorites

Users can set up their own Favorites and track items you access frequently to view them in the
future. Administrators and users can push items to a users Favorites.
You need the proper role to push items to Favorites. See the corresponding appendix in the
Oracle Enterprise Performance Management System Security Administration Guide. If you do not
have the proper role to access Explore, you can also see your Favorites list by selecting the
Favorites menu.

To access Favorites
1

Select Favorites.

Select an item from the list of Favorites.


Tip: You can also access your personal pages.

Adding Items to Your Favorites


Add items to your Favorites or push items to another users Favorite using the following:
l

You need view access permissions or higher.

Add any item to Favorites.

Add folders then use Favorites to access that folder; you cannot access items within the folder
directly.

Add items to Favorites:


1

Select Explore, and navigate to the item.

Right-click and select Add to Favorites.

Add folders to Favorites:


1

Select Explore, and navigate to the folder.

Right-click and select Add to Favorites.

Pushing Items to Favorites


Push items to another users Favorites by specifying the user name, group, or role.

Using Favorites

85

Push item to Favorites:


1

Select Explore, and select an item.

Select File, and then Properties.

From Properties, select Permissions in left pane.


Note: You can also use your mouse and select Edit Permissions by right-clicking on the

artifact.

Populate Users, Groups, and Roles tab with the following:

a. To filter by name, select begin with, contain, or are in group and then enter letters.
You cannot use the are in group filter for roles.
b. To filter by user type, select roles, groups, or users, click Update List.
The Users, Groups, and Roles tab display items based upon the selections you made in
the drop-down lists.
Note: If all of the users/groups/roles are not listed, filter the list with different criteria

or contact your administrator. Your administrator determines the maximum


number of users/groups/roles to list. Wild cards are not supported and the filter
is not case sensitive.

Select users from the Users, Groups and Roles tab, click,

From Selected Users, Groups and Roles, select Pushed from the Favorite drop-down menu to push the
item to the users Favorites.

Select Push this item to selected Users, Groups, and Roles.

If the Access to File option is set to No Access and there are no higher access rights for this
item to inherit, then the item is not pushed.

Repeat step 1 through step 7 to push other items to Favorites.

Click OK.

10 Optional: If you want permissions to apply to other content you import, make them your default
permissions by selecting:

a. For files, Make these the default permissions for all files I import.
b. For folders, Make these the default permissions for all folders I import.
Selecting this enables the system to automatically set the same permissions for files you
import. You can change the permissions for each file or reset your default permissions at
any time.

Note: To remove a role, group, or user from the selected list, click

the name to be removed.

86

Viewing and Organizing Information

after highlighting

Managing Favorites
Manage items in Favorites:
1

From EPM Workspace, select Favorites, and then Manage Favorites.

To remove an item from your Favorites, click Remove next to the item you want to remove.

To display an item on your list of Favorites, click Show next to the item you want to show.
Note: Pushed items can be hidden in Favorites but not removed by the recipient. Pushed

items can only be completely removed by the user that performed the push.

Optional: To resize column widths, drag the mouse over a column border, when the pointer changes to
a double headed arrow, drag the borders to the right or left.

Click OK.

Using Subscriptions
Subtopics
l
l
l
l

Creating a Subscription
Modifying or Removing Subscriptions
Subscribing to Folders
Receiving and Viewing Subscriptions

Subscriptions enable you to perform the following:


l

Receive email notifications and links to items every time the particular item is modified, a
specific job runs, an exception is generated or anything in a folder changes. Subscribe to any
item in the repository and you send it to one or more email addresses. See Creating a
Subscription on page 87.
If you subscribe to a folder you are notified of any new items imported or created in that
folder or any modifications to items within its subfolders. See Subscribing to Folders on
page 89.
Note: You cannot subscribe to Personal Pages.

Creating a Subscription
Subscribe to items to be notified when it changes. Receive email notifications that the item
changed or with the changed item attached.
Subscribe to be notified when exceptions occur as opposed to receiving notification when an
item changes. The items owner must enable the item or job to generate exceptions for you to
subscribe. Items and jobs generate exceptions when the following steps are setup:

Using Subscriptions

87

Production Reporting jobs and generic jobs can be programmatically set up to generate
exceptions. See Supporting Exceptions in Production Reporting or Generic Programs on
page 292.
Interactive Reporting jobs can be programmatically set up to generate exceptions. See .
Supporting Exceptions in Interactive Reporting Programs on page 258
Manually set exceptions on items by setting the version property Flag as Exception;
indicating that the item generated an exception. See Version Properties on page 81. The
latest version of the item is used to determine if an exception is set.

To create subscriptions:
1

Select Explore, and navigate to the item you want to subscribe to.

Right-click the item, and select Subscribe.

On the Subscribe page, perform the following steps:


l

Select Subscribe and send email notifications to.

In the text box, type one or more email addresses for the recipient of the notification.

If you want to send the item as an attachment, select Attach file for report name to
email message (if possible).
Tip: Your administrator determines the maximum size of attachments.

Optional: To subscribe to an item only when a programmatic exception occurs, select Exception Only.
This option is applicable to jobs only.

If this option is not displayed, this item or job does not use exceptions.

To add subscriptions to your default personal page:


1

Select Explore, and navigate to the item you want to subscribe to.

Right-click the item, and select Subscribe.

Click the Personal Pages tab, and perform the following:

This option is not available for multiple-cycle Interactive Reporting jobs.


l

To add links to the subscription, click Add to My Bookmarks.

To add an image that links to the subscription, click Add as Image Bookmark.
You can use a preconfigured image or browse to an image in the repository.
m

88

To use a preconfigured icon, click Use pre-configured icon file.


To use a custom icon, click Use custom icon file and enter the path and file name
or use the Browse button.
To specify the image size, enter pixel values in the width and height text boxes. If
you do not enter values the entire image is used.

Click OK.

Viewing and Organizing Information

To add Interactive Reporting document sections to your default personal page:


1

Select Explore, and navigate to the item you want to subscribe to.

The Interactive Reporting document must contain sections.

Right-click the item, and click Subscribe.

From Personal Pages tab, click Add Sections of Interactive Reporting document.

From Embed Section, select a section, and click Add.

Repeat step 4 to add all desired sections.

Click OK.

Modifying or Removing Subscriptions


You can modify or remove subscriptions by managing a list of subscribed items.

To modify or remove subscriptions:


1

From EPM Workspace, select Favorites, and then Show Subscribed Items.

Click a subscription, and then click Open Subscriptions.

To remove the subscription, clear Subscribe and send email notifications to.

To modify the subscription, use the steps described in Subscribing to Folders on page 89.

Click OK.

Note: If you remove a subscription, it is also removed from all of your Personal Page Bookmark

sections.

Subscribing to Folders
When you subscribe to folders, you are notified of items imported to that folder or updates to
items within the folder or its subfolders.
If you are interested in the entire contents of a folder or sub folder, you can subscribe to the
folder or sub folder.

To subscribe to folders:
1

Select Explore, and navigate to the folder to which you want to subscribe.

Right-click the item, and from the shortcut menu select Subscribe.

On Subscribe Settings, select Subscribe and send email notifications to: to receive notification for this
folder and to change or enter your email address.

Enter an email address for one or more recipients of the subscription.

You must enter the email address, you cannot select from a list of recipients.

Using Subscriptions

89

To receive notification when there are changes to the subfolders, select Notify on changes to sub-folders
of Users.

To receive notification only when items in the folder generate exceptions, select exception items.

To receive notification only when items in the folder are high priority items, select High Priority Items.

This option is only available if the administrator has enabled priority ratings.

Click OK.

Receiving and Viewing Subscriptions


Using a subscription email notification you can access items directly without browsing the
repository. Email notification comes in two formats:
l

Email with a link to the item or folderClick the link; if you have access to that item, you
can open the document.
Email with the item attachedFollow the directions to either view the file where it is or
download the attachment to a file.

Using Personal Pages


Subtopics
l
l

Customizing Personal Page Content


Working With Personal Pages

Personal Pages are customizable pages enabling you to organize, view, and access EPM
Workspace items and other Web content on Web pages. Items on personal pages do not interact
with each other. If items change, it cannot propagate changes to items on the Personal Page. To
build interactive dashboards, see Oracle Hyperion Interactive Reporting Object Model and
Dashboard Development Services Developer's Guide, Volume I: Dashboard Design Guide.
You can modify the content and layout of Personal Pages, create additional Personal Pages, copy
and customize Personal Pages, add links to repository items or to a website.
Content windows and file content windows are the components that make up a Personal
Page.. Personal Pages open in the maximize mode, automatically hiding the view pane. When
publishing personal pages, you can set access permissions during the personal page publish
phase. Bookmarks for Web Analysis, Production Reporting, Financial Reporting, and Interactive
Reporting jobs open as new tabs in EPM Workspace.
l

90

Content windows are collections of links to repository items or external sources, image
bookmarks, and Broadcast Messages.
File content windows display the contents of an item opposed to a link to the item. You can
display the contents of the following items:
m

Embedded Interactive Reporting document sections

HTML files

Viewing and Organizing Information

HTML job output

Add or remove content windows or file content windows. Content windows and file content
windows are optional except Broadcast Messages. You cannot remove Broadcast Messages, nor
delete a Personal Page that displays them, unless you have another Personal Page that displays
the Broadcast Messages.
Content on Personal Pages include:
l

Broadcast MessagesLink to special folders that the administrator populates. The contents
of this folder are displayed as one or more content windows and set up and managed by the
administrator.
Broadcast messages contains two sub-folders:
m

Personal Page ContentPublished personal pages.


Sample Personal PageContent on personal pages set up by the administrator and
content that you add to personal pages by subscribing to items.

My BookmarksCollection of links to Web pages or repository items.

Image bookmarksGraphic links to web pages or repository items.

HTML file or job output displayed as a file content windowContents of EPM Workspace
HTML items displayed on a Personal Page. URLs are also displayable.
Exceptions DashboardAdd traffic light indicators for jobs enabled for exceptions, or items
flagged as exceptions. If the traffic light is red, the item was flagged as an exception or the
job generated an exception. If the traffic light is green, the job did not yet generate an
exception.
Displayable Interactive Reporting sectionsSections from Interactive Reporting
documents and Interactive Reporting job output to which you have access.

Using Personal Pages

91

Figure 1

Sample Content Window and File Content Windows

Note: If your administrator configured the use of heading bars, each content windows title is

displayed in a colored heading on Personal Pages as shown.


A Personal Page includes:
l

Broadcast Messages Heading BarFormat the Heading bar for each content window.

LinksLinks to HTML pages or websites.

Content WindowMy Bookmarks that are set up using Subscriptions.

Exceptions DashboardLists job exceptions and notification messages or items that are
flagged for exceptions.
File Content WindowDisplays the contents of an HTML file.

Customizing Personal Page Content


You can specify information included and the appearance of your Personal Pages. Use the
following steps to customize your Personal Pages:
l

Adding or Removing Personal Page Contents on page 93

Displaying HTML Content on Personal Pages on page 93

92

Viewing and Organizing Information

Embedding Interactive Reporting Document Sections in Personal Pages on page 94

Creating Bookmarks on page 96

Using Exceptions on page 97

Modifying the Layout of a Personal Page on page 100

Changing the Colors on a Personal Page on page 101

Adding or Removing Personal Page Contents


To add or remove content (content windows) to a Personal Page:
1

Select Favorites, and then Manage Personal Pages.

Select a personal page.

Select

The content of the selected personal page is displayed in the My Personal Page Content area.

Select the content you want to add from Select Content, select

The items listed in the select content area are controlled by your administrator. You can also
add content through the subscribe feature. See Using Subscriptions on page 87.

To remove items, select the content you want to remove from My Personal Page Content and select
Remove.

Select Save Settings or close the window to Cancel. Changes are automatically displayed in the personal
page you updated.

Displaying HTML Content on Personal Pages


Add HTML items as a file content window on a Personal Page, which displays the content of the
item as opposed to a link to the item.
Note: HTML job output from Production Reporting jobs and generic jobs must be enabled in

order to display the HTML job output as a file content window.

Displaying an HTML File on a Personal Page


Display HTML files on Personal Pages:
1

From Explore, navigate the folders until you find the document to add to your Personal Page.

Right-click the item, and select Subscribe.

From the Subscribe window, select the Personal Pages tab.

Select Display file/output as a File Content Window.

If this option is not available, this file/output cannot be displayed as a file content window.

Using Personal Pages

93

Optional: To add the file content window to a personal page, click the desired personal page.

The HTML displays the embeddable content windows list.

Adding a File Content Window to Personal Pages


To add file content windows to Personal Pages:
1

Select Favorites, and then Manage Personal Pages.

To define the location of the Broadcast Messages and content windows on your page, select
the personal page and right-click. Select Personalize Layout.

Select the Personal Page to add the file content window to and click Personalize Content.

From Select Content Window, click the desired file content window(s) and add it to the Content list for
your Personal Page.

Click Save Settings.

Removing a File Content Window from All Personal Pages


To remove file content windows from Personal Pages:
1

Select Explore and navigate to the original HTML document/output file.

Right-click the item, and select Subscribe.

On Subscribe, clear Display file/output as a File Content Window.

Select OK.

Embedding Interactive Reporting Document Sections in Personal Pages


Embed sections of Interactive Reporting documents or Interactive Reporting job output into
Personal Pages.
l

If the item is an Interactive Reporting job output, it must be HTML from a single-cycle job.
The most recent job output is displayed in the embedded section and it is not interactive.
Embedded Interactive Reporting sections are fully interactive, with options available from
the pop-up menu.

Specify whether to include the Interactive Reporting Main Menu bar or the Navigation bar as
part of the embedded section. Interactive Reporting document sections you can embed are:
l

94

ResultsReduced vertically to fit in the container, with horizontal scroll bars. To view more
vertical regions, use the page navigation options available on the Main Menu bar.
TablesReduced vertically to fit in the container, with horizontal scroll bars. To view more
vertical regions, use the page navigation options available on the Main Menu bar.
PivotReduced vertically to fit in the container, with horizontal scroll bars. To view more
vertical regions, use the page navigation options available on the Main Menu bar.

Viewing and Organizing Information

ChartScaled proportionally to fit in the container.

ReportsClipped to fit in the container.

DashboardClipped to fit in the container.

Embedding an Interactive Reporting Section on a Personal Page


To embed Interactive Reporting sections on a Personal Page:
1

Select Explore, and navigate to the Interactive Reporting document or job output file.

Right-click the item, and click Subscribe.

Click Personal Pages tab.

Select Add sections of Interactive Reporting Document.

Select the section to add from Embed Section.

Select the Personal Page to update.

A list is displayed if you have more than one Personal Page.

Click Add.

The section is displayed in the Embedded BQY Sections list box.

Specify the size you want each section to be on the Personal Page.

Select the desired section from Embedded BQY Sections and specify its height and width in
pixels in the respective field.

Click OK.

Editing Embedded Interactive Reporting Sections on a Personal Page


After embedding an Interactive Reporting section, you can edit its properties.

To edit the appearance of embedded sections:


1

Select Favorites, and then My Personal Page.

From the personal page, select

Change the settings from the Edit Results Section window:


l

Replace embedded section(Read only) Displays the section currently embedded.


With sectionSelect a section to replace the currently embedded section. The name of
currently embedded section is displayed by default.
Specify section sizeEnter the size of the section in pixels.
Toolbar displaySelect the Interactive Reporting Server toolbar to embed with the
section (the default is none).
m

Select Navigation Only, to have the first page, previous page, next page, and last
page toolbar buttons only.

Using Personal Pages

95

Select Standard, to have all toolbar buttons except for the Interactive Reporting
Server help button.
Select None, to have no toolbar displayed.

Click Save Settings.

The edited embedded section is displayed on your Personal Page.

Removing Embedded Interactive Reporting Sections from a Personal Page


You can remove any embedded Interactive Reporting section from your Personal Page.

To remove embedded Interactive Reporting sections from Personal Pages, click X in the title
of the file content window containing the Interactive Reporting section you want to remove.

To remove an embedded Interactive Reporting section from all Personal Pages:


1

Select Explore, and navigate the folders until you find the item containing the embedded sections you
want to remove from your Personal Page.

Right-click the item, and click Subscribe.

On the Subscribe page, navigate to Add Sections of Interactive Reporting Document.

Select the section you want to remove from the list box and click Remove.

Click OK.

Creating Bookmarks
Include bookmarks on a Personal Page. A bookmark is a text link or image link to an item or to
a URL.

Adding Bookmarks for an artifact in Explore


To add Bookmarks for items:
1

Select Explore, and navigate to the artifact.

Right-click the artifact, and select Subscribe.

On Personal Pages tab, select Add to My Bookmarks.

The new bookmark is displayed on every Personal Page that includes the My Bookmarks
item.

Select OK.

Go to your Personal Page.

The Bookmark is displayed in the My Bookmarks list.

96

Viewing and Organizing Information

When selecting a Web Analysis, Production Reporting, Financial Reporting, or Interactive


Reporting jobs bookmark from the My Bookmarks list of a personal page, it opens as a new
tab in EPM Workspace.

Adding Image Bookmarks for an Artifact


Bookmarks are added for artifacts you subscribe to, except folders.

To add image bookmarks for artifacts:


1

Select Explore, and navigate to the artifact.

Right-click the artifact, and select Subscribe.

On Subscribe Settings, select Add As Image Bookmark, and specify the following information:

a. Graphic files to use. Select either:


l

A pre-configured icon file from the drop-down list


A custom icon file (your administrator needs to add your custom graphic to the
EPM Workspace file system and give you the path to it). Using a graphic file from
your local file system does not work.

b. Dimensions for displaying the image (in pixels).

Select OK.

Adding URL Bookmarks from Personal Pages


Bookmarks can be added from within Personal Pages.

To add bookmarks from Personal Pages:


1

Select Favorites, and then My Personal Page.

Select a personal page from the list. Right-click and select Add bookmark URL.

From the Add URL Bookmark to My Bookmarks dialog, enter a bookmark name and URL for bookmark.

The URL must begin with either http:// or https://.

Select Save.

Using Exceptions
Exceptions are conditions or results (such as a threshold being reached) requiring intervention.
Exceptions cause corresponding indicators on a subscribing users Exceptions Dashboard to
change, or a notification to be sent to users who have subscribed.
The exceptions dashboard is an optional content window used to monitor exceptions, it displays
on Personal Pages. Each indicator represents one exception-capable job or items manually
flagged as an exception.
Use exceptions with jobs or items:

Using Personal Pages

97

Using monitored exceptions with jobs:


m

Programmatically enable monitored exceptions on jobs. The exception is set when


certain conditions or thresholds are met. Job exceptions are generated by Production
Reporting jobs, Interactive Reporting jobs, or generic jobs. See Configuring
Exceptions on page 98.
Subscribe to jobs and choose to be notified by email when the exception occurs.
Place jobs on the Exceptions Dashboard and view its exception status. For each job you
add to the Exceptions Dashboard, a green traffic light icon is displayed. If the job
generates an exception, the traffic light changes to red. Using the Exceptions
Dashboard on page 99.

Using exceptions with items:


Note: An item must have version properties in order to use exceptions.

Manually set exception status for items. See Configuring Exceptions on page 98.

Subscribe to items and choose to be notified by email when the exception occurs.

You can place items on the Exceptions Dashboard and view its exception status. For
each item you add to the Exceptions Dashboard, a red traffic light icon is displayed.
Items cannot be added to the exception dashboard unless the exception status is set. See
Using the Exceptions Dashboard on page 99.

You have only one Exceptions Dashboard, even if you put it on multiple Personal Pages. If you
modify the Exceptions Dashboard on one Personal Page, it changes on all of your Personal Pages
that include it.

Configuring Exceptions
Configure exceptions for jobs and items with version properties. There are two ways to configure
exceptions:
l

Programmatically set-up a job to generate exceptions if certain conditions are met. When
you run the job if an exception occurs, the exception status of the job is set.
Manually set exceptions on an item by setting the property to Flag as an Exception.

To programmatically enable a job with monitored exceptions capability:


l

98

Design the Production Reporting job (*.sqr) or generic jobs to write exceptions to the
output.properties file. See Supporting Exceptions in Production Reporting or
Generic Programs on page 292.
Design the generic job, to write exceptions to the output.properties file. Supporting
Exceptions in Production Reporting or Generic Programs on page 292.
Design the Interactive Reporting job to write exceptions. See Supporting Exceptions in
Interactive Reporting Programs on page 258.

Viewing and Organizing Information

To set exception status for items manually, from Explore, set the property Flag as an
Exception for the latest version of the item. See Version Properties on page 81.

Using the Exceptions Dashboard


The exceptions dashboard shows a traffic light indicator for each job or item you place on it.
The traffic light indicator changes to indicate if an exception occurred (red) or did not occur
(green).
Note: Items have version properties to use exceptions and the exceptions dashboard.

To use the Exceptions Dashboard with jobs:


1

Select Explore, navigate to the job whose exception you want to monitor, right-click the job, and click
Properties.

From Advanced, select If exceptions are generated, allow users to add to their Exceptions
Dashboard, and click OK.

Select Explore, navigate to the job, right-click the job, and click Subscribe.

On Personal Pages tab, select Add to Exceptions Dashboard.

If this option is not on the Subscribe Settings page, the file cannot be monitored for
exceptions.

Click OK.

A traffic light is added to the exceptions dashboard. The traffic light indicator is green. If the job
is run and generates an exception, then the traffic light indicator changes to red.

To use Exceptions Dashboard with items:


1

Select Explore, and navigate to the item that has an exception you want to monitor.

Right-click the item, and click Properties.

From Advanced, select If exceptions are generated, allow users to add to their Exceptions
Dashboard.

From Versions, set the property Flag as an Exception for the latest version of the item and click OK.

Select Explore, navigate to the item.

Right-click the item, and from the shortcut menu, select Subscribe.

On Subscribe Settings, select Add to Exceptions Dashboard.

If this option is not on the Subscribe Settings page, this file cannot be monitored for
exceptions.

Click OK.

A red traffic light is added to the exceptions dashboard, to indicate that an exception is set for
this item.

Using Personal Pages

99

Adding the Exceptions Dashboard to a Personal Page


To add the Exceptions Dashboard to a Personal Page:
1

Select a Personal Page and click

Click Exceptions Dashboard and click

Click Save Settings.

Customizing the Exceptions Dashboard


To customize Exceptions Dashboard:
1

Select Favorites, and select a Personal Page.

On Exceptions Dashboard, select

To not show green lights, and have red lights displayed when an exception occurs, enable the Only
display links to artifacts that have exceptions.
Note: This option is applicable for monitored exceptions used with jobs. Traffic lights

display when the exception status is set. You cannot show a green traffic light for
items.

When exceptions occur and you want to see its exception text explanatory message next to its red light,
select Display exception messages next to graphic indicators.
Note: There is a smartcut tag called getException() that displays exception messages on

a Interactive Reporting dashboard. For more information, see the Oracle Hyperion
Interactive Reporting User's Guide

Click Change Properties.

Modifying the Layout of a Personal Page


Use the Layout button to select different layout styles for Personal Pages or to rearrange content
windows.

Specifying a Layout Style


The layout style of a Personal Page includes how many columns or sections the page has and
where they are displayed on the page.

To specify layout styles:


1

Select Favorites, and then Manage Personal Pages.

Select a Personal Page, then select

100 Viewing and Organizing Information

Click Select Layout Style and select a layout style.

To put content windows in a section across the top or bottom of the Personal Page, click Show Header
Section or Show Footer Section.

Click Save Settings.

Rearranging Content Windows


To move content windows:
1

Select Favorites, and then Manage Personal Pages.

Select a Personal Page, and then click Layout.

Select a content window to move.

To move the selected content window up or down within the section (column, header or
footer) it is currently in, click a vertical arrow. If you want to move the selected content
window to another section, click a horizontal arrow.

Continue selecting and moving content windows as desired..

Optional: To move the Broadcast Messages content windows, select Above all Content Windows or
Below all Content Windows in the Broadcast Messages section of the Content Layout page.

Click Save Settings.

Changing the Colors on a Personal Page


Select color schemes for Personal Pages, or individually set colors for page elements.

To change colors on Personal Pages:


1

Select Favorites, and then Manage Personal Pages.

Select

Select a color scheme.

To set colors individually, click Customize Colors for Custom.


Each colorable Personal Page element displays an array of color samples above a My Own
__ Color option. Select any color in the array by selecting its radio button. Colors shown
next to the My Own __ Color entry box is the current color of the element.

For each element whose color you want to change, select the new color you want or enter a hexadecimal
color code (for example, #000000 is the hexadecimal color code for black) in the My Own __ Color
entry box.

Select Save Settings.

Select a color scheme option:


l

Change all my Personal Pages to use this Color SchemeApplies the specified color
scheme to all your existing Personal Pages.

Using Personal Pages 101

Use this as my default Color Scheme for all new Personal PagesApplies the specified
color scheme to the current Personal Page and any future ones.

Select Save Settings.

Working With Personal Pages


Create multiple Personal Pages for different purposes, specify a default Personal Page if you have
more than one, and publish a Personal Page so that others can use it as their own.
l

Creating a Personal Page on page 102

Copying a Personal Page on page 103

Deleting Personal Pages on page 103

Publishing and Replacing Personal Pages on page 104

Creating a Personal Page


You can create multiple Personal Pages.

To create a Personal Page:


1

Select File, then New, and then Personal Page.

to add the content windows you want (listed on the left side) to the Personal Page Content
Use
list for your new Personal Page (on the right), click Next.

Select a layout style and click Next.

Layout styles only show the Personal Page portion of the browser window; the View pane
also is displayed on the left. A Header section is a wide area that contains one or more content
windows. A Footer section is the same, but located at the bottom of the page.

For Layout, arrange the various content windows where you want them on your Personal Page. Select a

content window and

then

to move the content window between sections. Select a content window and

to change a content windows position in a section. When you are done, click Next.

On Edit Personal Page, enter a name and description for your Personal Page, select a color scheme,
click Finish or Finish & Publish.

Selecting Finish opens the personal page just created for viewing. Finish & Publish enables
you to assign permissions during the publishing process of Personal Pages prior to viewing.
You can further customize the colors at a later time, see Changing the Colors on a Personal
Page on page 101. On the My Personal Pages page, the new Personal Page is listed.
102 Viewing and Organizing Information

Fom Favorites, select your Personal Page to view.

Copying a Personal Page


In addition to publishing new Personal Pages, you can also copy a published Personal Page to a
new Personal Page.
Note: You must have a published Personal Page prior to performing the following steps.

To copy published Personal Pages:


1

Select Favorites, and then Manage Personal Pages.

Select

is not displayed if you exceeded the number of Personal Pages allowed by your
administrator. You must remove a Personal Page to enable

Select Copy Published Personal Page, select Next.

The Add Existing Personal Pages page is displayed.

Select the personal page(s) you want to copy from the list, select Finish.

Select

. The page(s) are displayed in Manage Personal Pages.

Deleting Personal Pages


To delete Personal Pages:
1

Select Favorites, then Manage Personal Pages.

Select the Personal Page you want to delete from My Personal Pages.

Right-click and select Remove Page.

Select Restore Settings to restore the deleted Personal Page to the list.

Select Save Settings.

Setting Defaults
The first personal page in the list is the default personal page.

To set default Personal Pages:


1

Select Favorites, and then Manage Personal Pages.

On My Personal Pages, select the Personal Page to use as the default.

Use the up arrow to move this page to the top of the list.

Using Personal Pages 103

Select Save Settings.

Publishing and Replacing Personal Pages


Publish new Personal Pages or replace published Personal Pages using the content of your
Personal Page. Publishing a Personal Page enables other users to copy it.
Note: To publish Personal Pages, you need access permissions to the Personal Page folder.

To publish or replace Personal Pages:


1

Select Favorites, and then Manage Personal Pages.

On My Personal Pages, select the Personal Page you want to publish, right-click and select Publish.

To publish, enter a name and a description in the Publish New Personal Page section, select Publish.

The name and description defaults to what you have already assigned to this Personal Page.
The name and description should communicate what is distinctive about this page.
When you Publish and run an Interactive Reporting or Production Reporting
job to generate the job output, the default naming convention for the job output changes
to list the job and job output together.

To replace: In Replace Personal Page, select the page to replace, click Replace.

You can replace a published Personal Page with one that has a different name. The contents
of the published page are replaced and the published page name remains the same.

To set access permissions on the Personal Page you just published: select Edit Permissions.

The default access permissions when publishing Personal Pages are the same as basic
documents. To set access permissions, see Setting Permissions on page 70.

Workspace Pages
Workspace Pages enable users to create, edit, and aggregate content from Oracle and non-Oracle
sources from EPM Workspace repository, into a single environment.
Oracle sources include:
l

Interactive Reporting Sections within the document, Sections within the job, Sections
within the snapshot

Web Analysis Document

Production Reporting or SQR Document or Snapshot

Financial Reporting Document, Snapshot

Performance Scorecard Templates

Favorites

Alerts or Exceptions

104 Viewing and Organizing Information

Applications

Folder listing (no subfolder items)

Non-Oracle source files include:


l

URL

Text files

Image files

HTML files

Microsoft Office documents (Word, Excel, PowerPoint, Project)

XML files

RTF files

PDF files

Image files.jpg, .gif, .png

Shortcuts

There are two types of Workspace Pages, My Workspace Pages and Shared Workspace Pages.
My Workspace pages are customizable workspace pages created by a user that are marked
specially so that they can be easily accessed from one single place without having to navigate the
repository. You can create shortcuts to My Workspace Pages that may be stored in any folder.
Shared Workspace pages are stored in a system folder that authorized users can access from
Explore. Users that have access to this folder can move My Workspace pages manually within
Explore to promote them to the rest of the organization. A user needs Content Publisher role
to be able to save anything to the repository, including Workspace pages. There is also a Home
page Workspace page that is installed with EPM Workspace that you can point to using
Preferences as a default start page, for more information see Oracle Hyperion Enterprise
Performance Management Workspace User's Guide.
Additional Workspace page features include:
l

Provide content aggregation

Provide interactivity directly within a workspace page

Easy self service creation with supplied templates

Ability to build a dashboard in very little time

For advanced users, free form layout mechanism

Navigate through EPM Workspace repository

Creating Workspace Pages


Templates are used as a starting point to create Workspace pages. Templates allow the user to
specify in advance the layout of the workspace page before adding content. A user can then drag
and drop content from the Content browser (left pane) to a layout area. The Content browser
contains the following sources to select from: EPM Workspace repository, Favorites, and

Workspace Pages 105

Applications repository. The Applications repository contains Oracle Hyperion Performance


Scorecard and non-Reporting and Analysis artifacts. Users can only select one item at a time
from the Content browser.
The Find at the bottom of the Content browser allows users to perform a search in the chosen
source. Find searches EPM Workspace repository items based on matches to the name of the
object, it does not perform finds based on other attributes of the object. Find performs a search
of the entered string without having to force the user to enter wildcard characters. Results are
displayed in alphabetical ascending order within the Content browser. The results are also
displayed in the source drop down allowing users to switch between find results and repository
navigation.

To create a Workspace page:


1

Do one of the following:


l

Select File, then New, and then Workspace Page.


a. Select a template from the Templates dialog. Selected template is highlighted.
b. Select OK. Workspace page is created with chosen template.

Select File, then New, and then Document.


a. Select Create a Workspace Page and click Next.
b. Select one of the templates. Selected template is highlighted.
c. Click Finish. Workspace page is created with chosen template.

From the Content Browser, select a source for the location of the file you want to add to the layout area.

Select the file and drag and drop from Content Browser to a layout area. The title bar displays the title
of the document by default.

Optional: To resize a layout area, select the lower right corner with your mouse and drag to resize.

Optional: To move a layout area, select the title area with your mouse and drag to new position.

Optional: To add a URL, Favorites, Alerts Exceptions, or Applications in the content area of a Workspace
page, select Edit, then Add Content, then URL, Favorites, Alerts Exceptions, or Applications.

Optional: To add a folder listing, select the folder and drag and drop from Content Browser to the content
area of Workspace page.

To edit a layout area, select


107.

from the layout area toolbar. See Editing Layout Area on page

The layout area toolbar must be enabled to use the icons in the toolbar. Select Edit, then
Show Content Toolbars to enable and disable.

Optional: Select

in the layout area toolbar to open the content as another tab within EPM Workspace.

10 Optional: Select

to delete the layout area.

11 Optional: Select

to maximize the content to consume the entire content area. Once maximized, you

can restore to it's original size and location by selecting

106 Viewing and Organizing Information

12 By default, a Workspage page is saved as My Workspace Page. This allows the Workspace page to be
available from the Navigate, then Workspace Pages, then My Workspace Pages menu and from the
File, then Open, then Workspace pages, then My Workspace Pages menu.

To save the Workspace page without having it available in the above menu locations, deselect
Save as My Workspace Page from the Save As dialog.

13 Optional: To save a Workspace page as a Shared Workspace page, from the Explore module, click and
drag the Workspace page file to the system folder where Shared Workspace pages are stored.
Note: You must be an authorized user that has access to the folder where Shared Workspace

pages are stored.

Layout Area
Layout area is used to designate an area on a Workspace page where content can be placed. Each
layout area is independent, and can be resized and overlap. Layout areas also have properties
that can be modified, see Editing Layout Area on page 107. Each layout area can be positioned
anywhere within the content area. Toolbars are used to perform functions such as editing the
properties, maximizing and restoring, deleting, and launching the layout area as another tab
within EPM Workspace.
You can add layout areas to an existing Workspace page by dragging and dropping repository
content from the Content Browser into the Content area. Additional content includes: URL,
Favorites, Alerts/Exceptions and Applications. URL is used to specify any URL as the source
location for the content. Users should not add URLs to untrusted sites for security purposes.
Favorites displays the user's favorites within EPM Workspace. This provides quick access to a
user's Favorite repository. Alerts content displays the alerts or exceptions that are generated by
Interactive Reporting and Production Reporting. Applications display the list of applications
provisioned for the user. Users can also add a folder to the content area by dragging and dropping
a folder from the Content Browser. Links to files contained within the folder are displayed which
when selected launches the file as a tab in EPM Workspace. Subfolders are not listed.

Editing Layout Area


To edit layout area properties:
1

To rename a layout area, enter a name in the Title text box.

Source displays the path to the file in the layout area. Select the Select button to select another file or
folder to replace the existing content.

You cannot change the source for Favorites, Alerts/Exceptions or Applications content.

Optional: Complete the following if you selected the Select button in the previous step.

a. From the Browse dialog, select a source for the file you are searching for.
b. Enter the filename in the Find textbox and select Find.
c. Select OK.

Workspace Pages 107

Enter values for size and position.

For Oracle Hyperion Financial Reporting, Oracle Hyperion Web Analysis, and Interactive Reporting
products, you can select the Show Layout Area Toolbar option from Properties to display the content
toolbar.

Optional: Deselect Show Scrollbars if you do not want to display scrollbars for layout area.

Documents in a layout area that have their own scroll bars cannot be hidden for example,
a .PDF document.

Workspace Page Content Area


Content displayed here depends on content added to a portlet in a Workspace Page. You may
have added a URL, Favorites, Alerts/Exceptions, or Application to the content area of a portlet.
For example, if you added Applications and you select Launch, it opens the content as another
tab within EPM Workspace. From here, you can select a link to one of the applications, for
example, Planning, and it launches Oracle Hyperion Planning. For more information on how
to Launch, see Workspace Pages on page 104.

Using Home Page


Subtopics
l
l

Home Page Features


Setting Start Page back to Home Page

If Reporting and Analysis Framework has been installed and configured, Home page provides
a starting point for users and launching point for EPM Workspace functionality. Home page
can be used as follows:
l

Home Page is the default startup document for users with a BI+ role and it is installed with
Reporting and Analysis Framework. This file is located in the Shared Workspace Pages
folder.
When you select the Home button, it opens the Home page that was selected from the
Preferences dialog, Default Startup Options. For example, if you created a Workspace Page
you can point to this file as your home page.

This home page file displays recently opened documents, Workspace Pages, and Quick Links to
Favorites and Applications that a user has access to.

Home Page Features


The default home page consists of recently opened items, Workspace pages, and Quick links.

108 Viewing and Organizing Information

Recently Opened
l

Stores recently opened items for each user provisioned in EPM Workspace

Items listed have an icon followed by item name

Clicking on an item opens it in the module content area

Items supported include EPM Workspace repository items and applications

If documents currently displayed are deleted from repository or user is deprovisioned from
application, items are removed
Selecting the Open link displays the Open dialog from which you can open a document

Workspace Pages
l

Files can be listed for each My Workspace Pages and Shared Workspace Pages.If user has
access to more than four My Workspace Pages and more than four Shared Workspace Pages,
a More link is displayed which when selected displays a context menu to display all the
remaining items.
Clicking on an item opens the item in the module content area

Quick Links
l

Favorite items are displayed followed by Application items


If there are more than four items, then links are displayed for a context menu listing the
remaining items. If there are no Applications to list, then more number of Favorites can be
displayed.
Clicking on an item in a section opens the item in module content area

Setting Start Page back to Home Page


If you change the Default Startup Options preferences to an application or document other than
Home page you can set it back to the default Home page shipped with Reporting and Analysis
Framework.

To set the EPM Workspace start page back to Home page installed in the Shared Workspace
Pages folder:

Select File, and then Preferences.

Select Home Page from the Content drop-down menu.

Select OK in Preferences dialog.

The Next time you login, the Home Page is displayed.

Using Home Page 109

110 Viewing and Organizing Information

Interactive Reporting

In This Chapter
Using Interactive Reporting Documents in EPM Workspace ......................................... 111
Using the Interactive Reporting Toolbars............................................................... 112
Interacting with Interactive Reporting Documents .................................................... 115
Working with Interactive Reporting Document File Sections ......................................... 120
Exporting Data............................................................................................ 124
Query Section ............................................................................................ 127
Results and Tables....................................................................................... 144
Chart Section ............................................................................................. 155
Pivot Section ............................................................................................. 178
Common Chart/Pivot Features ......................................................................... 185
OLAPQuery Section ...................................................................................... 187
CubeQuery Section ...................................................................................... 191
Dashboards............................................................................................... 230
Report Section ........................................................................................... 233

Using Interactive Reporting Documents in EPM


Workspace
EPM Workspace enables users to query relational databases and heterogeneous sources (for
example, users of SQL Server, Oracle, flat files, Production Reporting/Web Analysis module
content) and perform quick ad-hoc analysis by drilling down and pivoting on the data to see
patterns or exceptions. Many features help users to analyze their data to conduct sales and key
performance, financial, and forecasting analyses.
Three types of users can relational data source. Developers who have the database connectivity
software may use a full 32-bit application. Power users without this connectivity or when there
are more security concerns may be given access to query using a client connected to the database
through a server. Users can further given permission to create content completely from scratch,
using add-on software installed on their local machine and hosted by the web browser.
Information consumer users typically use a thin client approach; no software is loaded for
these users, who instead interact with a DHTML-based series of pages.
The topics in this section explain how use to an Interactive Reporting document (BQY) in EPM
Workspace for Information consumer users.

Using Interactive Reporting Documents in EPM Workspace 111

Using the Interactive Reporting Toolbars


Subtopics
l
l
l
l
l

Standard Interactive Reporting Toolbar


Navigation Toolbar
Paging Toolbar
Shortcut Menus
Alert Dialog

Use the Standard and Interactive Reporting toolbars to navigate through theEPM Workspace
and work with common commands.

Standard Interactive Reporting Toolbar


The Standard Interactive Reporting toolbar is specific to those features used exclusively for
Interactive Reporting documents:
Interactive Reporting toolbar commands include (from left to right):

1. Data Layout enables the data layout panes in the Content area.
2. Navigate Back displays the previous section.
3. Navigate Front displays the next section.
4. Dashboard Home displays the Dashboard Home section.
5. Page # displays the current page for the table reports. For all charts with the exception of
pie, scatter and bubble, the current view of data points on the x and y axes is shown.
6. Page Left moves one page in the left direction in the report sections. To move to the first
page in the left direction, select [Shift] + Click + left arrow. In the Chart section, this icon
enables you to move one view in the left direction.
7. Page Up moves one page in the up direction in the report sections. To move to the top view,
select [Shift] + Click + Up arrow. In the Chart section, this icon enables you to move one
view up.
8. Page Down moves one page in the down direction in the report sections. To move to the
bottom page, select [Shift] + Click + Down arrow. In the Chart section, this icon enables
you to move one view down.
9. Page Right moves one page in the right direction in the report sections. To move to the first
view in the right direction, select [Shift] + Click + right arrow. In the Chart section, this icon
enables you to move one view right.
10. Refresh processes only the current section against the database server to dynamically retrieve
the most current data set, with the exception of the Dashboard and Report sections. When
the Refresh command is selected in the Dashboard and Report sections, all queries in the
Interactive Reporting document (BQY) are refreshed. Queries are refreshed in the order in
112 Interactive Reporting

which they are displayed in the section catalog of the full client. For example, in a Interactive
Reporting document (BQY) with three queries, Query1, Query2, and Query3, the queries
are executed in that order when Refresh All is selected.
11. Export to PDF exports a section to Portable Document Format (PDF) and launches it inside
your browser if the PDF MIME type is set in your browser. The PDF format is created by
Adobe and can be viewed outside of your browser if you have Adobe Acrobat Reader
installed. Adobe Acrobat Reader can be downloaded from Adobes website at http://
www.adobe.com/products/acrobat/readstep.html. If the PDF MIME type is not set in the
browser, the browser Save As dialog box is invoked.
12. Export to Excel (*.xls) exports a section to MS Excel and launches it inside your browser if
the mime type has been set to recognize the XLS file extension Thereafter, saving the file
locally or manipulating the file is all done by way of the MS Excel application. If the mime
type is not set to recognize the XLS file extension, you are prompted with a Save As Dialog
and you must specify a local destination to save the XLS file for future viewing of the data
with the MS Excel.
13. Export to Excek(*.mhtml) exports a section to Microsoft Office 2000 Web Archive (.mhtml
or mhtml). Also known as MS HTML, this archive type format is a standard for including
objects in the same file as the HTML code (for example .gif or.jpeg files). Objects are encoded
using the MIME HTML Internet standard. You might use this file format if you plan to
email the HTML as a single file.
14. Save preserves the file locally and launches theInteractive Reporting document (BQY) in the
Interactive Reporting Web Client so that you can view and save the Interactive Reporting
document (BQY) to your desktop for offline viewing. The Interactive Reporting document
(BQY) can only be viewed by the full desktop or web client. If Interactive Reporting Web
Client has not been installed, the browser is launched automatically.

Navigation Toolbar
Section navigation controls on the toolbar are available to end users by using the Navigate Back,
Navigate Forward, and Dashboard Home.
If the standard Interactive Reporting toolbar has been enabled, the Navigation toolbar is
automatically disabled because it is a subset of the standard toolbar. However, the Navigation
and Paging toolbars may be visible and enabled at the same time if the standard toolbar is
disabled.

Paging Toolbar
Depending on how a report was designed, you may see an abbreviated version of the <product
Interactive Reporting toolbar referred to as the Paging toolbar. This version of Interactive
Reporting toolbar contains the paging controls: Page Left, Page Up, Page Down and Page Right.
If the standard Interactive Reporting toolbar has been enabled, the Paging toolbar is
automatically disabled because it is a subset of the standard toolbar. However, the Navigation

Using the Interactive Reporting Toolbars 113

and Paging toolbars may be visible and enabled at the same time if the standard toolbar is
disabled.

Shortcut Menus
Use shortcut menus to perform operations on objects that you need to update and maintain.
Shortcut menus are context-sensitive menus that pop up.
For Windows users, shortcut menus are enabled by selecting an item and pressing [Shift] + [F10]
on the keyboard, or by right clicking the mouse. If the shortcut menu is enabled on the keyboard,
the menu opens at the upper, left most of the HTML frame.
If the shortcut menu is enabled by right clicking the mouse, the shortcut menu opens next to
the cursor pointer where you right-clicked the mouse button within the selected area or on the
item. Submenus derived from a shortcut menu are also available which group multiple and
related commands. Once you make a selection from a shortcut or submenu, the menu is closed.
Keyboard Shortcut

Description

Arrow Keys

Moves the cursor up, down, left and right on the shortcut menu.

[Enter]

Confirms and accepts an action associated with a shortcut menu item.

[Esc]

Closes a shortcut menu that is opening. You can also perform this action by selecting or deselecting an item or
pressing the [Tab] key.

Alert Dialog
An Alert dialog shows informational messages explaining why the alert opens. You are required
to acknowledge the alert before continuing since no other window can be active while it opens.
To dismiss the alert, click OK.

114 Interactive Reporting

Interacting with Interactive Reporting Documents


Subtopics
l
l
l
l
l
l
l
l

Understanding Interactive Reporting Document Files


Creating An Interactive Reporting Document File (BQY) From Another Interactive Reporting Document File (BQY)
Database Connection File (OCE) Selection For Interactive Reporting Document (BQYs)
Selecting an Interactive Reporting Data Source
Accessing Interactive Reporting Document Files
Saving Interactive Reporting Document Files
Using the Save Command
Using the Save As Command

Understanding Interactive Reporting Document Files


An Interactive Reporting document file (BQY) is centered on data from queries (either relational
or OLAP) or from imported data. Any number of queries and Data Models can supply the data
in an Interactive Reporting document file (BQY) . An Interactive Reporting document file (BQY)
can contain multiple queries with each query retrieving its data from a different database
including: relational databases, imported data files, local files and OLAP servers. The Data Model
aspects of the Interactive Reporting document file (BQY) are not visible to the end-user, but the
ability to refresh data that come from these sources is. An end-user can duplicate an existing
query or create a query based on an existing Data Model.
Once a Interactive Reporting document file (BQY) has been created, it is saved toEPM
Workspace Repository located on the server.
When the user selects and retrieves a Interactive Reporting document file (BQY) from the Section
pane, the emphasis becomes one of viewing, refreshing, and analyzing of the Interactive
Reporting document file (BQY) instead of the query, Data Model, data layout, and report
building of the Interactive Reporting document file (BQY) .

Creating An Interactive Reporting Document File (BQY) From


Another Interactive Reporting Document File (BQY)
You can create an Interactive Reporting document file (BQY) based on an existing Interactive
Reporting document file. In this case, the new Interactive Reporting document file inherits the
Interactive Reporting connection file (.oce) and sections associated with the original Interactive
Reporting document file.
Note: To create a Interactive Reporting document file that uses another Interactive Reporting

database connection file, or a new Interactive Reporting document file not associated with
an existing one, see Database Connection File (OCE) Selection For Interactive Reporting
Document (BQYs)

Interacting with Interactive Reporting Documents 115

To create an Interactive Reporting document file (BQY) based on an existing Interactive


Reporting document file (BQY):

Select File, and then New Document.

Select a Task opens.

Select Create an Interactive Reporting Document.

Select Data Source opens.

In the Data Source field, enter the name and path of the data source (Interactive Reporting document
file (BQY), or click Browse to locate the file.

For more information about the Browse feature, see Selecting an Interactive Reporting Data
Source

In the Create As field, select either Web Client or HTML.


l

Web ClientCreates the Interactive Reporting document file in Interactive Reporting


Web Client using a connection file using a relational, CubeQuery, or OLAP Query data
source.
HTMLCreates the Interactive Reporting document file in EPM Workspace.

Click Finish.

A new Interactive Reporting document file (BQY) is created based on the selected Interactive
Reporting document.

Database Connection File (OCE) Selection For Interactive


Reporting Document (BQYs)
An Interactive Reporting document files (BQY) can be created using an Interactive Reporting
database connection file (.oce) selected by the user. See table below for Interactive Reporting
database connection file (.oce) eligibility:

Interactive Reporting Database Connection File Type

Interactive Reporting Web Client

EPM Workspace

Relational

Yes

No

CubeQuery

Yes

Yes

OLAPQuery

Yes

No

To create an Interactive Reporting document file (BQY) with an Interactive Reporting


database connection file (.oce):

Select File, and then New Document.

Select a Task opens.

Select Create an Interactive Reporting Document, and then click Next.

Select Data Source opens.

116 Interactive Reporting

In the Data Source field, enter the name and path of the Interactive Reporting database connection
file (.oce), or click Browse to locate the file.

For more information about using the Browse feature, see Selecting an Interactive Reporting
Data Source.

In the Create As field, select either Web Client or HTML.


l

Web ClientCreates the Interactive Reporting document in Interactive Reporting Web


Client using a connection file using a relational, CubeQuery, or OLAP Query data
source.
HTMLCreates the Interactive Reporting document file in EPM Workspace. If you
select an Interactive Reporting database connection field .oce from a relational, or OLAP
Query data source, this option is not available.

Click Finish.

A new Interactive Reporting document file (BQY) is created based on the selected Interactive
Reporting database connection file.

Selecting an Interactive Reporting Data Source


Use the Select dialog box to choose an Interactive Reporting document file (BQY) or Interactive
Reporting database connection file (.oce) on which to base a new Interactive Reporting
document file (BQY).

To select an Interactive Reporting data source:


1

In the Look in field, select the Interactive Reporting document file (BQY) or Interactive Reporting
database connection (.oce) from which to build a new Interactive Reporting document file (BQY)

The folders and files shown on this dialog have been published to the EPM Workspace
Repository.
The Name and Type fields display the file name and type (Interactive Reporting document
file or Interactive Reporting database connection file).

To specify additional parameters, select

The Open As and Version fields are displayed.

To create the Interactive Reporting document file in Interactive Reporting Web Client, select Interactive
Reporting Web Client. To create a new Interactive Reporting document file in EPM Workspace , enter
HTML.

The option(s) available in the Open As field depend on the Interactive Reporting database
connection file. Interactive Reporting document files (BQYs) can be created by selecting an
Interactive Reporting database connection file (.oce). in Interactive Reporting Studio and
Interactive Reporting Web Client. In EPM Workspace, only an Interactive Reporting
database connection file (.oce) for an Essbase query can be used to create a new Interactive
Reporting document file. NoInteractive Reporting database connection file (.oce) associated
with a relational query can be used to create an Interactive Reporting document file in EPM
Workspace.

Interacting with Interactive Reporting Documents 117

In the Version field, verify the version information.

Click OK.

Accessing Interactive Reporting Document Files


Use the following procedure to open and close an Interactive Reporting document file.

To open an Interactive Reporting document file


1

Specify the URL of the EPM Workspace in your web browser.

The login dialog box opens.

Enter your user name and password and select Login.

Open an Interactive Reporting document file (BQY) .

An Interactive Reporting document can be opened in the following ways


l

From Explore, navigate to an Interactive Reporting document file and double click it

Select the Interactive Reporting document file and click Open on the shortcut menu

Select File, and then Open.

Select Favorites and choose the Interactive Reporting document (if it has been added to
Favorites)
The Interactive Reporting document file opens in EPM Workspace. If a Dashboard
section has been included in the Interactive Reporting document file, it opens in creation
date order. Typically, a Dashboard section is shown first. If no Dashboard section has
been included, the Interactive Reporting document file opens on the last saved section.
If the last saved section is a Query or Data Model, or fails for some other reason, the
Interactive Reporting document file attempts to open the next section from the Sections
pane, working from the top to the bottom of the Sections pane until a section can be
displayed.

To close an Interactive Reporting document file (BQY) , select File, and then Close.
If you have modified an Interactive Reporting document file, you are prompted to save any
changes.

Saving Interactive Reporting Document Files


To ensure that changes made to a Interactive Reporting document file are preserved after you
have performed an analysis on it, use the Save features. The Save features in EPM Workspace
enable you to save an Interactive Reporting document file to the EPM Workspace Repository
(importing). To save an Interactive Reporting document file locally (offline analysis), see
Exporting an Interactive Reporting Document File in Native File Format.
When you modify an Interactive Reporting document (BQY) or an Interactive Reporting
document job, you can save the changed Interactive Reporting document to the EPM Workspace

118 Interactive Reporting

Repository. The EPM Workspace Repository is an efficient way to manage Interactive Reporting
document file, and distribute Interactive Reporting document files over a wide network for enduser query and reporting.
Saving the Interactive Reporting document file to the EPM Workspace Repository can be made
either by saving it with changes to the original document (Save option), or by saving the
Interactive Reporting document file, as a new document (Save As). If you do not have permission
to overwrite an Interactive Reporting document file, use the Save As feature.

Using the Save Command


Use the Save command to save the changes to the Interactive Reporting document file that you
have permission to write to.

To save an Interactive Reporting document file to the EPM Workspace Repository, select
File, and then Save.
Optional: You can also click

Using the Save As Command


Use the Save As command to save the changes you have made to the Interactive Reporting
document file when you do not have permission to overwrite the Interactive Reporting
document file, or you simply want to save and rename it with your changes.

To save as to the EPM Workspace Repository:


1

Select File, and then Save As.

Type the name of the Interactive Reporting document file in the Name field.

Type a description of the Interactive Reporting document file in the Description field.

Click

Interacting with Interactive Reporting Documents 119

Working with Interactive Reporting Document File


Sections
Subtopics
l
l
l
l
l
l
l
l
l
l

Sections Pane
Selecting Interactive Reporting Document File Sections
Adding Sections
Moving Between Sections
Duplicating Sections
Renaming Sections
Deleting Sections
Dashboard Home
Refreshing Interactive Reporting Document File Sections
Printing Sections

Interactive Reporting documents are files created and used to retrieve information from a
database, analyze the information, and build reports. Since <product Interactive Reporting
document files are integrated query, analysis, and reporting tools, these documents have multiple
sections, each of which governs one part of the query and reporting refresh. You create sections
progressively as you query a database, retrieve results, and then generate reports.
Interactive Reporting document files are divided into multiple sections, each of which governs
one step of the reporting procedure. Interactive Reporting document file sections are created
progressively when a database is queried, results are retrieved, and reports are generated.
Each section occupies an independent window and performs distinct operations. You can move
back and forth between sections at any time to rebuild your query or alter your result data. You
can also position sections side-by-side in a Dashboard section.
The end-user does not need to have a strong technical understanding of databases. Data Model
sections are not available, and these sections are not visible in the Sections pane. Each section
occupies an independent window in the browser and shows discrete views of data. For example,
the Pivot section resembles a spreadsheet or crosstab report that lets you perform drill down
analysis of different data relationships. The Chart section graphically depicts summaries, trends,
and relationships in your data.
When an Interactive Reporting document file is opened, the default home page is the Dashboard
section. If the Dashboard Home section cannot be displayed, then the Interactive Reporting
document file opens on the last saved section. If the last saved section is a Query or Data Model
(which are not listed in the Section Navigation drop-down menu), or fails for some other reason,
then the Interactive Reporting document file attempts to open the next section from the Sections
pane, working from the top to the bottom of the Sections pane until a section can be displayed.

Sections Pane
The Sections pane shows the sections available in the current Interactive Reporting document
file:

120 Interactive Reporting

DashboardUpon opening an Interactive Reporting document file, a customized


Dashboard section can appear as the Interactive Reporting document file front-end. Each
button selection, item selection, or navigation sequence can invoke a script. Behind the
scenes, Interactive Reporting refreshes the Dashboard script commands that can perform
actions such as retrieve data, populate controls, hide objects, navigate to different sections,
and specify report parameters
ReportDisplays high-quality and professionally designed reports. These reports can span
anywhere from a complex critical operational report to a results set, a Chart, and a Pivot
table. Use the reports to help you evaluate your business, expand communications, and assist
in the decision-making process
QueryFoundation of the Interactive Reporting document, the Query section enables you
to connect to a relational database, OLAPQuery (query section specifically designed for
connecting to multidimensional databases), and CubeQuery (query section exclusively
designed for connecting to and querying Essbase 9.x or greater databases).
ResultsRetrieves data to your document and displays it in the Results sections as columns
in a table
PivotInteractive table that quickly summarizes, or cross-tabulates, large amounts of data.
You can rotate its rows and columns to see different summaries of the source data, or display
the details for areas of interest.
ChartFully interactive, two- or three-dimensional view of your data that provides
powerful ways to visually analyze your data
TableSingle-dimension report that displays your data in columns. Tables are often used
as building blocks in other sections

By default, an Interactive Reporting document file has at least one Query section and one Results
section. Each section occupies an independent window and performs distinct operations.
You can move back and forth between sections at any time to rebuild your query or alter your
result data.

Selecting Interactive Reporting Document File Sections


Sections associated with the Interactive Reporting document file are shown in the Sections pane.

To select a section, click the desired section from the Sections pane.
To scroll up and down through a section, use the scroll bar on the right side of the browser.

Adding Sections
A new section is added based on an existing query and results set.

Working with Interactive Reporting Document File Sections 121

To insert a new section in an Interactive Reporting document file, select Actions, then
Insert, and then (New Section).
For example, to insert a new Chart, select Actions, then Insert, then Chart.
Interactive Reporting inserts the new section and adds a new section label to the Sections pane.
The section label is based on the type of section added. A sequence number is added to the section
label if a section with the same name already exists.

Moving Between Sections


Although each section occupies an independent window and performs distinct operations, you
can move back and forth between sections at any time to rebuild your query or alter your results
data. You can also position sections side-by-side in multiple windows.
You can easily navigate between sections to work on queries, results, and reports.

To move between sections, select the desired section from the Sections pane.
If necessary, use the up and down scrollbar to vertically through the Sections pane.

Duplicating Sections
A section that has been duplicated retains all of the content and formatting of the original section.
In addition a new section is added to the Sections pane. The new section label is based on the
original section label, but a sequence number is appended to the label. For example, if you
duplicate a section named SalesChart three times, the Sections pane shows: SalesChart,
SalesChart2, SalesChart3, and SalesChart4.

To duplicate a section, select the section to duplicate in the Sections pane and select
Duplicate on the shortcut menu.
You can also duplicate a section by selecting a section from the Sections pane and choosing Edit,
then Section, then Duplicate.

Renaming Sections
The first section that you create is given the default section name, for example, Query or Results.
When you insert new sections of the same type as those that already exist, they are numbered
sequentially, for example, Query2, Results2, and so on. To assign sections different or unique
names based on your application, use the Rename command.

To rename a section:
1

In the Sections pane, select the section name to rename.

On the shortcut menu, select Rename.

You can also select the section to be renamed and choose Edit, then Edit, and then Rename.

122 Interactive Reporting

The Input Section Name dialog box opens.

Type the new name for the section and click OK.

Deleting Sections
You can delete a section, but do so with care. Some sections are dependent on other sections.
Deleting one section could also delete one or more sections that you did not want to delete. Note
that you cannot restore a deleted section.

To delete a section:
1

In the Sections pane, select the section to be deleted.

On the shortcut menu, select Delete.

You can also select the section and choose Edit, then Section, and then Delete.
The Confirm Deletion dialog box opens.

Click OK.

Dashboard Home
Upon opening a document, a customized Dashboard section can be displayed as the Interactive
Reporting document file front-end. Each button selection, item selection, or navigation
sequence can invoke a script. Behind the scenes, Interactive Reporting refreshes the Dashboard
script commands that can perform actions such as retrieve data, populate controls, hide objects,
navigate to different sections, and specify report parameters.

To display Dashboard Home, click

Refreshing Interactive Reporting Document File Sections


You refresh a section to retrieve the most current data set from the database to Interactive
Reporting document file. The Refresh command can be used in any of the query reporting
sections. Once the data set has been refreshed in one section, all sections attached to the
Interactive Reporting document file are refreshed as well.
By default, the Refresh Current command (refreshes the current object) in all sections except
the Dashboard and the Report sections. In some cases more than one query may be refreshed,
if for example, a report references results sets from multiple queries.
In the Dashboard and Report sections, the Refresh All command to refresh all queries in the
Interactive Reporting document file is used. Although queries are not visible in to the end-user,
they are executed in the order in which they display in the section catalog in the full client version.
For example, in an Interactive Reporting document file with three queries, Query1, Query2, and
Query3, the queries are executed in that order when the Refresh All command is selected.

Working with Interactive Reporting Document File Sections 123

If a variable filter has been set for the query by the designer of the <product Interactive Reporting
document file, the filter selections must be resolved before the query is refreshed. At that time
the user is prompted to select or enter filter values and complete the constraint.

To refresh a section, click

Printing Sections
When you print a section, it is printed to a PDF file and launched inside your browser if the PDF
MIME type is set in your browser. The PDF file can be viewed online, or printed if you need a
hard copy of a report.
The PDF format is created by Adobe and can be viewed outside of your browser if you have
Adobe Acrobat Reader installed. Adobe Acrobat Reader can be downloaded from Adobes
website at http://www.adobe.com/products/acrobat/readstep.html. If the PDF MIME type is not
set in the browser, the browser Save As dialog box is invoked.
Note: A Query section cannot be printed.

To export an Interactive Reporting document file to PDF, select File, then Print, and then
PDF.
Optional: You can also print a section by clicking

Tip: Printing a section and Exporting a Section as a PDF are equivalent features.

Exporting Data
Subtopics
l
l
l

Exporting a Section as a .PDF


Exporting a Section to MS Excel (.XLS)
Exporting an Interactive Reporting Document File in Native File Format

Exporting a Section as a .PDF


Exporting a section to Portable Document Format (.PDF) allows you to preserve the layout and
format of the original section and transfer it across multiple platforms (such as Windows, UNIX
and the Macintosh). It also enables you to save, print and distribute the file easily and effectively.
To display and print a PDF file you must have Adobe Acrobat Reader installed. Acrobat
Reader is a self-contained application that can behave as an Internet Browser plug-in or as a
stand-alone application.

124 Interactive Reporting

Acrobat Reader enables you to view, print and share a PDF file, but does not enable you to create
or modify it. The Acrobat Reader is free and can be downloaded from Adobes website.
When the Acrobat Reader has been installed, you might have to configure your browser to use
it. For example you may need to associate Acrobat Reader as the application to read PDF files,
or have the PDF display in a separate window instead of the same window. You open a PDF file
by double clicking the PDF in the Explore module.
To save a PDF to your desktop for offline viewing, click the Acrobat Reader Save as Copy icon
on the Acrobat Reader toolbar. You are prompted to specify the directory in which to save the
file.
To print a PDF, click the Acrobat Reader Print icon. You are prompted to specify print
parameters and to print the report.
If the Acrobat Reader has not been installed, the File download dialog opens. You can save the
file to disk and open it from a location that you specify.

To export an Interactive Reporting document file to PDF, click the

Optional: You can also print an Interactive Reporting document file to PDF by selecting File,
then Print via PDF.

Exporting a Section to MS Excel (.XLS)


You can export a section to Microsoft Excel and launch it inside your browser if the mime type
has been set to recognize the XLS file extension. From this point, you can save the file locally
and work with the data directly in the Microsoft Excel application. If the mime type is not set to
recognize the XLS file extension, you are prompted with a Save As Dialog and must specify a
local destination to save the XLS file for future viewing of the data with the Microsoft Excel.
Note: If you need to export a section to MS Excel in Web Archive format, you much use EXCEL

2002( Office XP) or EXCEL 2003.

To export an Interactive Reporting document file to Excel (XLS):


1

Click Export to XLS.

If the mime type has been set to recognize the section, it is launched automatically in
Microsoft Excel.
If the XLS file extension in not recognized, the Save As dialog box opens. Complete Step 2.

If desired, enter a new name for the section in the File Name field.

Select Microsoft Excel Workbook (.XLS) in the Save as Type field.

Select Save.

Exporting Data 125

Exporting an Interactive Reporting Document File in Native


File Format
When an Interactive Reporting document file is exported in native file format, the EPM
Workspace checks if the Interactive Reporting Web Client has been installed and if so, launches
the Interactive Reporting document file in a browser. The Interactive Reporting Web Client is
a special application file placed in a web browsers plug-in directory. Plug-ins add seamless
functionality to a web browser, enabling the browser to open a plug-ins particular file type as
if it were an HTML file.
Any changes made to the Interactive Reporting document file are not replicated to the original
Interactive Reporting document file selected from the document list in the EPM Workspace
Repository (which resides on the server and can only be changed by importing the Interactive
Reporting document file again).

To export a file in native file format, select File, then Export, and then Native File Format.
If the Interactive Reporting Web Client has been installed, make any desired changes and save
the document to the EPM Workspace Repository. If you do not have permission to overwrite
the Interactive Reporting document file, use the Save To Repository As command to rename
the Interactive Reporting document file and save it to the repository.
If the Oracle Hyperion Interactive Reporting Web Client has not been installed, the File
Download dialog box opens. You can either open the Interactive Reporting document file from
its current location, or you can export the file to disk and open it from an alternate location.

126 Interactive Reporting

Query Section
Subtopics
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l

Interactive Reporting Database Connection Files (OCEs)


Data Model
Topics and Topic Items
Query Restrictions
Inserting a New Query
Working with Queries
Working with Items on the Request Pane
Picture (BLOB Image) Support
Adding a Computed Item in Query
Computed Items and Data Functions
Data Functions
Applying A Query Filter
Variable Filters
Applying Query Sorts
Refreshing a Query

The Query section is the foundation of any Interactive Reporting document file. An Interactive
Reporting document file can contain multiple Query sections that can access a wide range of
data sources (relational databases, OLAP servers, imported data sets, and local joins). Each Query
section has its own Results section and can be associated with the same database or different
databases (that is, the connection file or data model used is defined independently in each query).

Interactive Reporting Database Connection Files (OCEs)


Whenever you use Interactive Reporting to query a relational database and retrieve information,
the Interactive Reporting database connection file and data model are used to interact
transparently with the database. The Interactive Reporting database connection file and data
models are not visible to the end user in the EPM Workspace.
The Interactive Reporting connection file encapsulates and stores connection information used
to connect Hyperion applications to a database. Interactive Reporting database connection files
specify the database API(ODBC, SQL*Net, etc.,), database software, the network address of the
database server, and your database user name. An end-user can specify the Interactive Reporting
database connection file and database password and logon. It is required for an Interactive
Reporting document file (BQY) to reference live information from the database.

Selecting an Interactive Reporting Database Connection File (.OCE)


To select an existing Interactive Reporting database connection file (.oce)
1

Navigate to the folder in which to place the file.

Select File, then Import, and then File.

Query Section 127

Click Browse, navigate to the folder where the desired Interactive Reporting connection file is located,
select the file and click Open.

The name of the selected Interactive Reporting connection file populates the File field on
the Import dialog box.

Click Next.

The second Import dialog box opens.

Specify any user name, password, and metadata information and click Finish.

For more information on these settings, see Setting Processing and Metadata Options.

Data Model
You use a data model to interact with a database to create queries that specify which data to fetch
from the database.
Data models make the database more accessible because they display database tables graphically
as topics. They also:
l

Substitute descriptive names for arcane database table and column names. Create custom
views of the data.
Add computed fields for performing calculations on the retrieved data.

Data Models are not visible in EPM Workspace. If a master copy of a data model has been
associated with a query, you can link a query to it. See Inserting a New Query.

Topics and Topic Items


Topics are a visual representation of tables in a database. They are logical groupings of related
information about a particular facet of your business, such as Customer or Sales. A list of topics
is shown in the Catalog list
A topic item is an individual items in a topic or metatopic.
You build queries by adding topics from the Catalog list to the Request pane. You can also drag
and drop any topic item to the Request pane. When you refresh a query, data for all the topic
items present on the Request pane are returned.

Query Restrictions
These Query features are either unavailable or restricted in scope in EPM Workspace
l

The Query Log and Custom SQL options are not available.
A subquery is indented in the Section pane, but it is displayed as a regular query in EPM
Workspace. A subquery cannot be added in EPM Workspace.
If an Interactive Reporting document file contains a union query, the first query is displayed.
The Request and Filter panes in the Data Layout for the union query are read-only. In

128 Interactive Reporting

addition, there is no Union Controller line. A new Union Query section cannot be created
in EPM Workspace.
l

Local Results can be displayed, but a new local result table cannot be created in tEPM
Workspace.
Derived queries can be displayed, but a new derivable query cannot be created in EPM
Workspace.

Inserting a New Query


Use the Insert New Query dialog box to select the master data model for a relational query.
Additionally if the Interactive Reporting document file (BQY) contains a query associated with
an Essbase data source, you can select the Interactive Reporting database connection file (.oce) .
Note: If the Interactive Reporting document file (BQY) contains only a relational query and no

master data model, the Insert New Query dialog box is not available. In the case where a
Interactive Reporting document file (BQY) contains a relational query linked to a master
data model, and an Interactive Reporting database connection file (oce) associated with
a CubeQuery, all options on the Insert New Query dialog box are available. Note that
master data models are not available for a multidimensional Interactive Reporting
database connection file (.oce).

To insert a new query with a master data model:


1

Select Actions, then Insert, and then Query.

The Insert New Query dialog box is displayed.

Check Master Datamodel and select the master data model to link to the query.

The master data model is a prebuilt, custom view of a database. The benefit of data models
is that any changes to the master data model gets propagated to all dependent queries that
are based on the master data model.

Click OK.

To select the Interactive Reporting database connection file (oce) associated with Essbase:
1

Check Existing Essbase Connection and select the database connection file (.oce).

Click OK.

Working with Queries


All Query sections in the Interactive Reporting document file are displayed in the Section pane.
For each Query section, you can build a query by adding topics to the Request pane. You can
also apply filters to the data, or specify columns by which to sort the data that is returned from
the database.

Query Section 129

Building Queries
You build queries by selecting the data you want to retrieve from a visual representation of the
database. Once you have selected the items to include in the query and refresh it, a results set is
generated.
EPM Workspace offers three query methods for building queries:
l

Duplicate and modify an existing Query section, which has been provided to you in the
Section pane
Link to a predefined data model, known as a Master Data Model (if the appropriate adaptive
states have been granted)
Select an Interactive Reporting database connection file (.oce) used to query an Essbase
database

To build a query by linking to a Master Data Model:


1

Select Actions, then Insert, and then Query.

Select a master data model and click OK.

The Request, Filter and Sort panes are displayed.

In the Catalog list, expand the Tables by clicking +.

A list of topics is displayed.

Expand a topic to view topic items by clicking +.

Drag a topic item to the Request pane.

Optional: You can also select the topic item in the Catalog list and click Add to Request on
the shortcut menu.
Tip: You can also select a topic item and select Add Selected Items in the Catalog list or select

Actions then Add to Request.


Optional: To add an entire a topic to the Request pane, select the topic and drag it to the
Request pane.

To apply a sort, drag a topic item from the Request pane to the Sort pane.

For more information, seeApplying Query Sorts.

To apply a filter (limit), drag a topic item to the Filters pane.

For more information, see Applying A Query Filter.

Select

If you add more items than the Request pane can display, resize the browser.

130 Interactive Reporting

To duplicate a Query section, select the query to duplicate in the Sections list, and choose
Duplicate on the shortcut menu.
EPM Workspace duplicates the section and adds a new section label to the Sections pane. The
new section label is based on the original section label, but a sequence number is appended to
the label. For example, if you duplicate a section named SalesChart three times, the Sections
pane shows: SalesChart, SalesChart2, SalesChart3, and SalesChart4.

Working with Items on the Request Pane


As you build your query, you can add and remove item to and from the Request pane. This
allows you to change the way in which the query refreshes and displays.
l

Adding Request Items

Removing Request Items

Adding Request Items


Queries are built by adding topic items from the Catalog list to the Request pane.

To add a topic item to the Request pane, select the topic item in the Catalog list and choose
Add to Request on the shortcut menu.

Removing Request Items


You can remove items in the Request pane to exclude the data from your query or results set.

To remove an item from the Request pane, choose the desired item and select Delete on the
shortcut menu.
Dependent sections that use the item are not affected by the removal of an item until the query
is refreshed.
Note: Remove items with caution as a computed item or report may draw data from the item

that you delete.

Picture (BLOB Image) Support


Pictures can be queried from a relational database if they are image data collected as a BLOB
data type and stored as a binary unit in the database management system with ODBC
connections. BLOB image files available to include: .JPEG, .BMP, .GIF, and .PNG image formats.
Pictures can be dragged and dropped from a query table to the request line, displayed as strings
in columns in the Results and Table sections, or shown graphically in the bands of the Report
section. Dashboard developers can select images from results sets, not just static images from
the file system.
The following restrictions apply to BLOB images in Interactive Reporting:
Query Section 131

The ODBC connection must use a server-defined join

It is not possible to determine the data type of an image in advance

See also:
l

Adding Pictures in Query on page 132

Working with Pictures in Results and Tables on page 132

Working with Pictures in Reports on page 132

Adding Pictures in Query


In the Query section, once BLOB images are retrieved as pictures, they are treated like any other
table topic item. They can be dragged and dropped from the table directly to the request line.
Only pictures in tables that have a primary key defined are included in a query. Pictures cannot
be sorted in the Query section. If you add a non-BLOB image to the request line, a broken link
to the image is displayed in the report section.

Working with Pictures in Results and Tables


A column is displayed in the Results and Table sections for every picture with a BLOB data type
on the request line. Descriptive text is displayed instead of the image in each cell in the format
<<Picture:unique id>>. The unique id is tooltip text if any has been specified, otherwise, the
unique id is the primary key value.

Adding Pictures in Computed Items


A picture function is available in Computed Items so that you can associate an image with a
computed column. In the Results and Table section, the picture is shown as descriptive text
instead of the image in each cell in the format <<Picture:unique id>>. The unique id is tooltip
text if any has been specified, otherwise the unique id is the Resource name. In the Reports
section, the computed item containing the picture can be shown graphically, For example you
could use an if else statement to show an image if a certain set of conditions are met, and
another criteria if the condition is not met:
:if (Amount_Sales >= 10000) {Picture ("C:\\graphics\\smile.gif" )}
else{Picture("C:\
\graphics\\crying.gif" )}

Working with Pictures in Reports


The Report section can include pictures obtained from the database (BLOB data types) by using
an embedded object (Results and Tables) or it can use static images from the Resource Manager.
Pictures can be dragged from the Catalog and dropped into the report layout components: report
table report body report group header report page header of footer. You cannot drag a picture
into a Table Facts column. Once a picture has been added to the report, all images are sized to
fit the bounding rectangle defined in the report, and pictures can be resized as needed. Pictures
are sorted by the their underlying textual unique id (i.e. the text displayed in a table/result
132 Interactive Reporting

section), which is particularly useful when they are added to the report group headers (via
outliner).

Adding a Computed Item in Query


In the Query section, a computed item is a set of instructions to the database server. EPM
Workspace uses the computing power of the database server to perform calculations as it
retrieves data from the database.
For this reason, the Query section allows you to use computed items in a way that is not possible
in the other sections. Instead of creating a new data item, the new values simply replace the
original values in the data item as they are retrieved from the database.
Additionally, you can compute items using any topic item in the data model and any scalar
functions provided by your RDBMS.
Note: You are unable to add computed items through shortcut menu in EPM Workspace. At

least one Results or Table column must be present to enable the right-click (shortcut)
menu which contains the option to add or modify a computed item. When no columns
are present, select the menu option Actions, and then Add Computed Item to create a
computed item.

To create a computed item in the Query section:


1

Select an item in the Request pane and choose Actions, and then Computed Item.

The Computed Item dialog box is displayed.


Optional: You can also select a request item and choose Add Computed Item on the shortcut
menu. At least one Results or Table column must be present to enable the shortcut menu
which contains the option to add or modify a computed item. When no columns are present,
you must select the Add Computed Item from the Actions menu.

Enter a name for the computed item in the Name field.

The default name is Computed, which is numbered sequentially if there is more than one
computed item. If you assign a name to a computed item that is identical to an existing scalar
function name, EPM Workspace numbers the name starting with the number 2.

Select the data type of the computed item to build from the Data Type list box.

See also Adjusting Data Types on page 134.

Enter the definition of the computed item in the Definition text box.
l

See Operators on page 135.


Click Reference to display the Reference dialog box, and select items to place in the
equation. See also Reference on page 138.
You can also type any portion of the equation or the entire equation directly into the
Definition text box using JavaScript. The names are case sensitive, and you must replace
spaces in item names with underscores (_).

Query Section 133

When the equation is complete, click OK.

In the Query section, the computed item is displayed on the Request pane with its new name.
When the query is refreshed, the computed item is listed in the Results Data Layout pane,
and it is displayed as a column in the results set.

Adjusting Data Types


Since computed items are new data items, confirm or change the data type of the item to preserve
the precision of a mixed-data type computations, or to change the way a data item is handled
(for example, interpreting number as strings). This ensures the correct handling of data in server
computations.
Attention to data types is most important when computing items in the Query section. Here the
computation is performed on the database server, and the computed item may be handled with
an unanticipated data type.
Local calculations (Results or Pivot) are handled internally, and adjustment between 16- and
32-bit integers can be handled safely using the automatic or number data type specification.
Since computed items are new data items, confirm or change the data type of the item to preserve
the precision of a mixed-data type computations, or to change the way a data item is handled
(for example, interpreting number as strings). This ensures the correct handling of data in server
computations.
Local calculations (Results or Pivot) are handled internally, and adjustment between 16- and
32-bit integers can be handled safely using the automatic or number data type specification.
Table 26

Data Type Specifications

Data Type

Specification

Automatic

A data type is determined automatically given the data type of the reference items and the computations performed

BLOB

Binary large object which is truncated at 64,000 bytes. Blob data types can include image formats such as: jpeg, bmp,
gif, and png.

Byte

Variable data type of length determined by a single byte of computer storage. Bytes can store numeric values from 0
to 255, or a single text character

Date

Calendar date in server default format (typically mm/dd/yy)

Integer (16bit)

Retains a 16-bit value (2 bytes). A 16-bit integer stores integer values from 0 to 16,777,216, and signed integers
between +8,388,608 and 8,388,608

Integer (32bit)

Retains a 32-bit value (4 bytes). A 32-bit integer has a range of 0 to 4,294,967,296 if unsigned. If signed, -2,147,
483,648 to 2,147,483,647.

Long Text

Character data (long text) exceeding 255 bytes (use the string data type for text strings up to 255 characters). The
maximum long text retrieved is 4000; characters anything greater than that is silently truncated

Packed Real

Real numbers packed for use with EDA middleware. The results in Interactive Reporting are the same as real numbers

Real

Decimal numbers up to 5 positions right of the decimal

134 Interactive Reporting

Data Type

Specification

String

Text strings to a maximum length of 256 characters

Time

Time in format set by user preference

TimeStamp

Date/time combination in format set by user preference

Operators
You can add operators in the Computed Item dialog box to add arithmetic or logical operators
to a computation in the Definition text box. Operators are added at the insertion point. You can
use any of the following types of operators:
l

Arithmetic Operators

Comparison Operators

Statements

Logical Operators

The following guidelines are applicable when using operators:


Type the word null (no quotes) into the Expression text box to represent null values.

Enclose all text string constant values and date constant values entered in expressions in
single quotes. (Numbers can be entered without quotes.)

To join items with a space or other character, reference or type items and strings into the
Expression text box and join them with the + operator (for example, City + , +
State). To join without additional characters, use the Concat function.

In division operations, the divisor may not be null or equal to zero. If a data item serves as
the divisor in an expression (for example, 5000/Units_Sold) and includes null or zero values,
first create a computed item using if/else logic to remove null and zero values, and then
compute the item containing the division operation.

Two date items can be subtracted, but not added. The Add Month function adds an integer
value to a date.

You cannot nest functions inside the Sum, Cume, Chr, and Breaksum functions.

Arithmetic Operators
Arithmetic operators take numerical values (either logical or variables) as their operands and
return a single numerical value.
Table 27

Arithmetic Operators

Operator

Name

Used at the:

Add

Server level and the local metatopic level for all sections

Subtract

Server level and the local metatopic level for all sections

Query Section 135

Operator

Name

Used at the:

Multiply

Server level and the local metatopic level for all sections

Divide

Server level and the local metatopic level for all sections

Begin suboperations

Server level and the local metatopic level for all sections

End suboperations

Server level and the local metatopic level for all sections

++

Increment

Server level and the local metatopic level for all sections except the Query section

--

Decrement

Server level and the local metatopic level for all sections except the Query section

Mod (%)

Modulus

Local metatopic level only

The modulus operator returns the


remainder of dividing var1 by var2.
For example, 5% 4 returns 1.

Tip: If a computed item is displayed on a Request pane, and the definition of item uses

subtraction, such as "Mytable.Column1-5", a SQL error can occur. The exact error depends
on the database, but the most common error indicates an undefined name was used.
Because databases allow hyphenated names, Interactive Reporting attempts to deal with
such names intuitively. Thus, an item definition like "Mytable.Column1-5" is interpreted
as a name. In order to ensure it is treated as subtraction, include a space on either side of
the hyphen/subtraction operator. For example, entering the computed item definition as
Mytable.Column1 - 5" ensures that the correct SQL is generated.

Comparison Operators
A comparison operator compares its operands and returns a logical value based on whether the
comparison is true. The operands can be numerical or string values. When used on string values,
the comparisons are based on the standard lexicographical ordering.
Note: The comparison operators in the following table are only available at the local metatopic

level. For the examples in the table var1 has been assigned the value 3, and var2 has been
assigned the value 4.
Table 28

Comparison Operators (Local Metatopic Level)

Operator

Return true if the:

==

Operands are equal


For example, 3 == var1

!=

Operands are not equal


For example, var1!= 4

136 Interactive Reporting

Operator

Return true if the:

<

Left operand is less than the right operand


For example, var1 < var2

<=

Left operand is less than or equal to the right operand


For example, var <= var2, var2 <= 5

>

Left operand is greater than the right operand


For example, var2 > var1

>=

Left operand is greater than or equal to the right operand


For example, var2 >= var1, var1 >= 3

Statements
Executes a set of statements if a specified condition is true. If the condition is false, another set
of statements can be executed.
Table 29

If...else statement

Statement

Description

ifelse

if executes a set of statements if a specified condition is true. The specified condition may be another statement and can
include other nested if statements. Braces, {}, must enclose multiple statements. If the condition is false, another set of
statements can be executed if the optional else statement has been included in the script.
A sample if else statement looks likes this:
if (condition) {
statements1
}
else {
statements2
}

Logical Operators
Logical operators take Boolean (logical) values as operands and return a Boolean value.
Table 30

Logical Operators

Operator

Description

AND (&&)

Connects two conditional expressions and retrieves records only if each expression is true.
Computed items are not retrieved if any condition belonging to a conditional expression is false. The AND logical operator is
usually nested within another conditional expression, for example, expressions which use if and else statements. For example:
if ((OS == Windows) && (Item type == Modem)) {Windows} else {other}

Query Section 137

Operator

Description

OR (||)

Specifies a combination of expressions and retrieves records that include at least one of the expressions. For example, if one
of the words is Washington or Oregon, every record with the expression Washington and every record with the word Oregon
is included.
Typically the OR (||) is nested within other conditional expressions, for example, expressions which use if and else logical
operators. For example if you want to assign Washington and Oregon to the "Northwestern Region" and all other states to
"Other Regions", enter:
if ((State = = Washington)|| (State == Oregon)) {Northwestern Region} else {Other Regions}

NOT (!)

Computes and shows items more accurately stated in a negative way. In effect, all records are retrieved except those that
fulfill the conditional expression.
You enter the conditional expression with the NOT (!) logical operator preceding the conditional expression. The conditional
expression can be a simple value or nested within other conditional expressions, for example, expressions using AND and
OR.
A combined condition expression that uses NOT is true if the conditional expression following NOT is false. A combined
conditional expression is false if the conditional expression following NOT is true.
For example, suppose you are looking to list all states that are not in the Northwestern region. In this case, enter the conditional
expression:
if ( ! (State = = 'Northwestern Region')) {Other Regions}

Reference
Use the Reference dialog box to select the topics and topic item from which to build the computed
item definition.
The Reference dialog box is split between topics in the left pane and topic items in the right pane.
The topics displayed in the left pane are derived from the topics in the Request pane. The items
displayed in the right pane are the values which make up each topic. Before you can select a topic
to use in a computed item expression, you must select it and a topic item.

Computed Items and Data Functions


Computed items and data functions are fundamentally different, and the functions available in
the Computed Item dialog box do not calculate data in the same way as data functions.
l

Computed items calculate a fresh value for each original value, based on the computation
(for example, Revenue calculated from Price and Units Sold). The new values are part of a
new data item or replace the original values. Computed items never reduce the original
number of records.
Data functions, by contrast, summarize groups of database records and replace the original
values with new summary data. Because data functions summarize values, the number of
records are frequently reduced.

138 Interactive Reporting

Data Functions
Data functions compute aggregate values, including averages, maximums, counts and other
statistics. These functions summarize groupings of data. You can use data functions to aggregate
and compute data from the server before it reaches the Results section, or compute different
statistics for aggregated Results totals and report items.
The effects of data functions are most dramatic in the Query section. For example, Dollars is an
item of sales transaction records for your stores in London and Madrid. You can apply a data
function to this item, consolidate the data, and calculate sum totals, average sale values, number
counts of individual sales records, or minimum sale values with respect to each city, once the
data is retrieved to Results.

To apply a data function, select the item or column, and chooseData Function on the shortcut
menu.
Optional: You can also select the item or column and choose Actions , then Data Function, and
select the (function).
Table 31

Data Functions

Function

Returns

Availability

None

Unaggregated values as stored in the database. This is the default in Query.

Query

Sum

Sum of underlying values. This is the default in Results and report sections.

All

Average

Average of underlying values

All

Non-Null Average

Average of underlying values; null values excluded

Pivot, Chart, Report

Minimum

Lowest of underlying values

All

Maximum

Highest of underlying values

All

Count

Number of underlying values

All

CountDistinct

Number of distinct values in a column. This function is not supported by all database servers

Query

Null Count

Number of nulls among underlying values

Pivot, Chart, Report

Non-Null Count

Number of underlying values; null values excluded

Pivot Chart, Report

Standard Deviation

Standard deviation of values. This function is not supported by all database servers.

Query

Variance

Variance of values. This function is available through Oracle servers only.

Query

Weight

Use for computing weighted items in Pivot reports.

Query

% of Column

Sum of all underlying values as a percentage of their respective surface column

Pivot

% of Row

Sum of underlying values as a percentage of their respective surface row

Pivot

% of Grand

Sum of underlying values as a percentage of all surface values in the report

Pivot, Chart

Query Section 139

Function

Returns

Availability

% of Category

Group total percentage of the selected value

Report

Increase

Calculates the increase between the previous two rows or columns

Pivot

%Increase

Calculates the percentage increase between the previous two rows or columns

Pivot

Title

Column names

Report

Null values are empty values for which no data has been specified; null values are not equal to
zero.

Applying A Query Filter


When building a query, you usually do not want to see information associated with every
product. Instead you want to see information that relates only to a specific product or product
line. Similarly, you may not want to see this information for every year the product has been
available, but only for recent periods.
When you set a filter in the Query section, data is returned from the database only if it meets
the specified conditions. For example, suppose you only want to see your most important
customers who spend more than $400,000 per year, or who buy gardening products in the
Midwest. By applying a filter you are instructing the database to give me only the data which
satisfies the following conditions (sales > $400,000; or, state is in Midwest Region and Product
Line = Garden).
In another example, a filter placed on Item Type (which includes an = (equal) operator and
value Keyboard) returns only records associated with keyboard sales. Records associated with
all other products are excluded from the results set. The data set could be expanded to include
modem sales records by adding the value Modem to the filter expression.
Similarly, the filter > 5000 applied to the Amount Sold item filters out all sales transactions
less than or equal to $5,000. Alternately, the expression between 5000, 10000 exclude
transactions above $10,000 and eliminates any below or equal to 5,000.
Another advantage of Query filters is that you can apply a filter to any Topic item, even if the
item is not on the Request pane. For example, if you request State, Year, and Units Sold, you
can filter any of these items.
You can also place a filter on the Operating System if it appears in one of the topics in the Contents
pane. For example, if you filter the Operating System to the UNIX only, the server retrieves only
sales information related to the UNIX operating system. You do not need to place the Operating
System on the Request pane.
Note: If a query contains an aggregate filter, it is added to the Data Layout. However, this

aggregate filter line is read only and a new aggregate filter cannot be created.

140 Interactive Reporting

To set a query filter:


1

Select a topic item in the Catalog list and select Add to Filter on the shortcut menu.

Optional: You can also drag one or more topics from the Catalog list and drop them into
the Filter pane.
The Filter dialog box is displayed.

Define a pool of the potential filter values by selecting one of the following options:
l

Show Values on page 148 Supplies database values associated with the item.

Custom Values on page 150 Supplies an empty text box for entering custom values.

Custom SQL on page 150 Supplies an empty text box for entering a Structured
Query Language (SQL) clause to be included in the query statement.

If you are working with the Show Values or Custom Values options, select Include Null to include data
where the data item has no value.

Retrieves records where the filtered item has no value; for example a field in which no data
has been entered. A null value is not equal to zero.
If you are working with the Custom SQL option, skip the remaining steps, enter your Custom
SQL and click Set.

Select the NOT check box to negate the operator it precedes.

If you select NOT, the results of the equation are reversed.

Select a comparison operator to use for filtering values.

For example, if you specify the > Greater Than and specify a value of 10,000, values greater
than 10,000 are returned.
For a list of valid comparison operators, see Comparison Operators on page 136.

Select the values to apply as a filter.

Select Set.

To suspend a filter temporarily without deleting it, click Ignore.

Variable Filters
A variable filter is a preset filter that is associated with the Interactive Reporting document file
by the designer and resolved only when the query is refreshed. At that time, you are prompted
to select or enter filter values and complete the constraint. A variable filter prompt is displayed
only if one has been set in the underlying Interactive Reporting document file.
Variable filters work particularly well with custom lists. If a custom list has been created, you
can respond to the prompt by simply selecting a value from the custom list. For example, you
may have an Interactive Reporting document file you use monthly to monitor inventory levels.
Each time you use the Interactive Reporting document file, you run it separately for each product
line you carry. You can accelerate the process by making the filter variable on the product line
item, and create a custom values list. Each time you refresh theInteractive Reporting document
file, you can select a new product line without redefining filters.

Query Section 141

You can select from three types of filters from which to apply a variable constraint, including:
l

Show Values on page 148 Supplies database values associated with the item.

Custom Values on page 150 Supplies an empty text box for entering custom values.

Custom SQL on page 150 Supplies an empty text box for entering a Structured Query
Language (SQL) clause to be included in the query statement.

If you do not need to select specific variable filters for the query, choose Set to accept the
predefined filters and refresh the query. If you want to modify or add other values, complete
steps 2 and 3 below.

To specify a variable filter.


1

Click Refresh on the Interactive Reporting toolbar.

The Filter dialog box is displayed.

If you are working with the Show Values or Custom Values options, select Include Nulls to include data
where the data item has no value.

Retrieves records where the filtered item has no value; for example, a field in which no data
has been entered. A null value is not equal to zero.
If you are working with the Custom SQL option, skip the remaining steps, enter your Custom
SQL and click Set.

Select the NOT check box to negates the operator it precedes.

Selecting NOT reverses the results of the equation.

Select a comparison operator to use for filtering value.

For example, if you specify the > Greater Than and then specify a value of 10,000, then values
greater than 10,000 are returned.
For a list of valid comparison operators, see Comparison Operators on page 136.

Select the values to apply as a filter.

Select Set.

The filter is applied in the results set.


To suspend a filter temporarily without deleting it, click Ignore.
To see the result of setting the variable filer, select the Refresh command after the variable
has been set.

Applying Query Sorts


Sorting simplifies the process of data analysis. After data is sorted, the answers to questions are
often readily at your fingertips because sorting ranks data to reveal trends and margins. If you
apply simple sort conditions in the Query section, the database server sorts the data while
refreshing the query before it is retrieved to your document file.

142 Interactive Reporting

Typically, you can place an ascending or descending order on a sort condition that you place on
a column.

To apply a sort to the query, drag one or more items in the Request pane and drop them
into the Sort pane.
Optional: A sort can also be applied by selecting an item and choosing Actions then Add to
Sort.
When the query is refreshed, the request item is sorted in the results set.

To sort in ascending order:


1

Drag one or more items in the Request pane and drop them into the Sort Pane.

Select Sort Ascending on the shortcut menu.

To sort in descending order:


1

Drag one or more items in the Request pane and drop them into the Sort pane.

Select Sort Descending on the shortcut menu.

To delete a sort, select the sort value to remove from Sort pane and choose Delete on the
shortcut menu.
Deleting a sort returns the data to its original display.

Refreshing a Query
After you build your query and apply filters computations, sorts, and any other adjustments to
further refine your request, refresh it to get the results of your query. Refreshing your query may
take a few moments if your query is complex or if the data in linked report sections needs to be
refreshed.
When you refresh your query, the data is retrieved to the Results section in tabular form. You
can refresh your query at any time and in any section to refresh the data. You can also return to
the Query section from any other section at any time to alter the query and refresh it.

To refresh a query, click

Optional: You can also select View, and then Refresh.

Query Section 143

Results and Tables


Subtopics
l
l
l
l
l
l
l
l

Adding a Table
Working with Columns and Rows
Sorting Results/Table Items
Number Formatting
Applying a Results and Table Filter
Results and Table Totals
Adding Computed Items in Results and Tables
Paging Through Results Data

When you refresh a query or import data, the Interactive Reporting retrieves data to your browser
and displays it in the Results section. Although the query may have accessed several different
database tables, the results set is displayed as a single table. Each requested item is displayed as
a column in the table and each database record is a row.
Use the Results section to:
l

Verify that your query returned the correct information.


Refine and extend the data set by applying filter conditions or create new computed or
grouped items.

Sort or use text and column formatting features to enhance the appearance of data results.

Add summary totals or subtotals and compute them with data functions.

Print or export the retrieved data to other applications.

All reports, including tables, pivots, charts, are based on the data that is retrieved to the Results
section.

Adding a Table
To create a table based on data in the Results section:
1

Select Action, then Insert, and then Table.

Drag Results items from the Catalog list to the Table Data Layout.

The table columns are populated automatically.

Working with Columns and Rows


Columns and rows can formatted to your specific needs:
l

Adding a Column

Deleting a Column

144 Interactive Reporting

AutoSizing Columns

Deleting a Row

Adding a Column
If you have removed a column from the results set, you can easily add it back. However, any
data values derived from the re-added column are not automatically update an existing column
either in the results/table section or another section, which draws from the results set.

To add a column:
1

Select any column.

Select Add Column on the shortcut menu.

Deleting a Column
You may need to delete a column in order to view the data set in a new way or maybe you want
to concentrate on selected columns of interest. This option is available for all columns. Note
that column deletion should be approached with caution since other sections draw data values
from the results set.

To remove a column, choose the column and select Delete Column on the shortcut menu.
The column is deleted. If you need to add the column back to the Results section, select Add
Column on the shortcut menu.

AutoSizing Columns
By default,Interactive Reporting truncates columns evenly and without regard to the length of
data values. With the auto-size column width feature, you can automatically size any column to
fit the text of the largest value in the column.

To autosize a column:
1

Select a column.

Select Auto-Size Column Width on the shortcut menu.

Deleting a Row
You can delete a row if it is a grand total or break. Note that the grand total is shown in the last
row on the last page of the table.

To delete a row:
1

Select a row.

Select Delete Row on the shortcut menu.

Results and Tables 145

Sorting Results/Table Items


Data in the Results section is sorted in the order returned by the database. You can change the
order in which a column is sorted either in ascending or descending order.

To sort a column:
1

Select the column you want to sort on.

Selecting multiple columns invokes a nested sort.

Select Sort on the shortcut menu.

The Sort submenu is displayed.

Select either the Ascending or Descending sort item.

To delete the current sort order:


1

Select any column in the Results or Table section.

Select Sort on the shortcut menu.

The Sort submenu is displayed.

Select Delete All.

Number Formatting
You can change the way numbers, currency values, and dates are displayed throughout or create
new custom formats.

To apply number formatting, select the format from the Format drop down list box.
Table 32

Formatting Categories

Option

Description

Category

Select a category for which you want to display number formats. When you select a category, the formats for that category are
displayed in the Format field. To create a custom format, select Custom and enter the desired format in the Format field. Enter
symbols, decimals, commas, and so on to indicate how to display the format. For example, enter 'MM/DD/YY' to display the
date as `01/01/99', or enter $$#.###.00 to show two dollar signs before the number and a decimal to mark the thousands'
place. When you create a custom format, it appears as a category on the machine on which it was created. If an item already
has a custom format applied to it, the custom format is in read-only mode.

Format

Displays the format for the selected category. If you are creating a custom category, you can enter the desired format directly
in the edit field.

Table 33

Numeric Categories

Option

Description

Number

Sets the default format for real or integer values.

Currency

Applies currency formatting to the selected number object(s).

146 Interactive Reporting

Option

Description

Percentage

Applied percentage formatting to the selected numeric object.

Table 34

Formatting Options and Descriptions

Option

Description

Example

Integer placeholder or zero value. If a number has an integer value in this


position relative to the decimal point, the inter is displayed. Otherwise a zero
is displayed.

Apply 0 to show 123.

Integer placeholder. If a number has an integer value in this position relative


to the decimal point, the integer is displayed. Otherwise, nothing is displayed.

Apply #,##0 to show 1,234.

()

Formats with parenthesis options display negative values in parentheses.


Otherwise, negative values are displayed with a minus sign.

Apply (#,###0) to show (1,234).

A semicolon operates as a separator between two number formats. The


semicolon separates a positive integer and a negative integer.

Apply #, ##0;(#,##0) to show 1, 234 or apply


(1, 234) for a negative number.

$%

Adds the respective character to numeric values in the same position relative
to the decimal point.

Apply $#,##0.00 to show $1,234.56.

m d yy

Displays month, day, and year in respective positions for date-coded


information.

Apply mm dd yy to show 05 07 99

-/

Adds the respective character to date-coded values in the same position


relative to variables.

Apply mm/dd/yy to show 06/23/99

Apply 0.00 to show 123.45.

Apply 0% to show 3%.

Applying a Results and Table Filter


Because local filters only hide data from the display, they are a good way to filter the data set to
reflect temporary and hypothetical situations. You can always remove the filter to return data
to the display and make it available for reporting.
Applying filters to your results/table sets allows you to narrow your request. That way you can
work with relevant data, saving time and conserving database and server resources.
You can add, modify and remove filters to columns in the Tables/Results section. The column
to which the filter is applied must exist in the table, and a filter cannot be placed on a hidden
column.
See also:
l

Show Values

Custom Values

Custom SQL

Modifying Filters

Deleting Filters

Results and Tables 147

To add a results/table filter:


1

Select a column on which to apply the filter.

Select Filter on the shortcut menu.

The Filter submenu is displayed.

Select Apply/Modify on the Filter submenu.

The Filter dialog box is displayed.

Define a pool of the potential filter values by selecting one of the following options:
l

Show Values on page 148 Supplies database values associated with the item.

Custom Values on page 150 Supplies an empty text box for entering custom values.

If you are working with the Show Values or Custom Values options, select Include Nulls to include data
where the data item has no value.

Retrieves records where the filtered item has no value; for example, a field in which no data
has been entered. A null value is not equal to zero.
If you are working with the Custom SQL option, skip the remaining steps, enter your Custom
SQL and click Set.

Select the NOT check box to negate the operator it precedes.

Selecting NOT reverses the results of the equation.

Select a comparison operator to use for filtering values.

For example, if you specify the > Greater Than and then specify a value of 10,000, then values
greater than 10,000 are returned.
For a list of valid comparison operators, see Comparison Operators on page 136.

Select the values to apply as a filter.

Select Set.

The filter is applied in the results set.


To suspend a filter temporarily without deleting it, click Ignore.

Show Values
The Show Values feature provides a list of values derived from the content of the Results or Table
section. Because Show Values retrieve every unique value available, it is best not to use this feature
when the data item is large, consists mostly of unique values, or does not change frequently (for
example, telephone numbers). In this situation, custom values are recommended when you want
to avoid extra calls to the database.
The value list that initially displays was saved with the imported Interactive Reporting document
file, and it is not the latest value list from the database.
To show the latest value list, select View, then Refresh.

148 Interactive Reporting

To specify a database filter value:


1

Select the Show Values tab.

Select Include Nulls to allow nulls to pass the filter and display in the data set.

Expand the Operator drop down and select a comparison operator for the filter expression.

Check Not to reverse an operator condition.


For example, if you specify the > Greater Than and then specify a value of 10,000, then values
greater than 10,000 are returned. Values which pass the comparison test are included. Valid
operators include:
Table 35

List of Comparison Operators

Operator

Retrieves Records Where the Filtered Item:

Equal (=)

Equals the specified value(s).

Not Equal (<>)

Does not equal the specified value(s).

Less Than (<)

Less than the specified value(s).

Less or Equal (<=)

Equal to or less than the specified value(s)

Greater Than (>);

Is greater than the specified value(s).

Greater or Equal (>=);

Is equal to or greater than the specified value(s)

Begins With

Begins with the specified value(s) up to and including the end value.

Contains

Contains the specified value(s) regardless of location.

Ends With

Ends with the specified value(s).

Like (with wildcards)

Retrieves records where a text string is displayed and reflects the placement of the specified value(s).
For example, a Name Like %ZE_ retrieves records for all employees whose names have the letters Ze
followed by a single character at the end

Is Null

Has no value; for example a field in which no data has been entered.

Between

Retrieves records where the value of the filtered item lies between (and does not equal) the specified
values.

Not (with operator)

Negates the operator it precedes, reversing the results of the equation

Highlight the values to include as filters from the Values list.

To select an individual value, highlight it in the Values pane.


To select multiple and contiguous values in the Values pane, hold the [Shift] and scroll down
to or up to the items.
To select multiple, but non-contiguous values in the Values pane, hold the [Ctrl] key and
highlight the items.

Click Set.

To suspend a filter temporarily without deleting it, click Ignore.


Results and Tables 149

Custom Values
A Custom Values list can be used to set a filter and are created by or supplied to you. One reason
to use custom lists with a distributed Interactive Reporting document file is that many data items
change very rarely. For example, a Gender item has three consistent values (male, female, and
unknown). A Product line item has many more items, but may only change every year or so.
Under these circumstances, it makes sense for you to select from a custom values list.
The initial custom values shown in the values pane originate and are saved with the Interactive
Reporting document file.

To apply a custom value as a filter:


1

Select Include Nulls to include data where the data item has no value.

Retrieves records where the filtered item has no value; for example a field in which no data
has been entered. A null value is not equal to zero.

Select a comparison operator to use for filtering value.

Select the NOT check box to negate the operator it precedes.


For example, if you select the > Greater Than operator and specify a value of 10,000, values
greater than 10,000 are returned.
For a list of valid comparison operators, see Comparison Operators on page 136.

In the Values field, enter the values to which you want to set as a filter.

To add the value, select +(the addition sign).

To remove a value from the Values panel, highlight the item in the Values pane and click
the - (subtraction sign).

Click Set.

To suspend a filter temporarily without deleting it, click Ignore.

Custom SQL
If you are familiar SQL, select the Custom SQL feature and type a SQL where clause to be included
in the query statement.

To add a custom SQL statement:


1

Select the Custom SQL tab.

Type your SQL where clause containing the expression to use for the filter in the Values pane.

Click Set.

To suspend a filter temporarily without deleting it, click Ignore.

Modifying Filters
Once a filter exists for data in your query or results, you can later add or modify filter conditions.

150 Interactive Reporting

To modify a filter:
1

Select the column to which the filter has been applied.

Select Filter on the shortcut menu.

The Filter submenu is displayed.

Select Apply/Modify on the Filter submenu.

The Filter window is displayed.

Select the filter value and click Set.

The following table provides a quick reference to the Modify Filter option:
Command

Description

Set

Applies the filter value.

Ignore Filter

Ignores a filter without deleting it.

Cancel

Cancels any filter applied in the current sessions.

Deleting Filters
Deleting filters adds the original values that were filtered back into the data set.

To delete a filter, select the columns that has the filter value to be deleted and select Actions,
then Filter, then Delete on the shortcut menu.

Results and Table Totals


Totals and subtotals can help to consolidate a large results set. If you need individual data records
and plan to print the Results and Table section as a quick report, add totals and subtotals to
break your report into manageable sections.

See also:
l

Calculating a Grand Total for a Column

Calculating a Break Total for a Column


Results and Tables 151

Calculating a Grand Total for a Column


You can calculate a grand total for any numeric data column and specify the original total value
with a new type of function. For example, by default the totals for a column are sums of the
values in those columns. But you can change the totals to averages instead of sums. These Results/
Table section functions include:
Data Function

Returns the:

Sum

Sum of all underlying values.

Average

Average of all underlying values.

Maximum

Highest of underlying values.

Minimum

Lowest of underlying values

Count

Number of underlying values.

To apply a grand total to a column:


1

Select the column and choose Grand Total on the shortcut menu.

A submenu showing all available total functions is displayed.

Select a total function.

The grand total is displayed in a new row at the bottom of the last page in the selected column.

To remove all grand totals:


1

Select a column to which a grand total was applied and choose Grand Total on the shortcut menu.

A submenu showing all available total functions is displayed.

Select Delete All.

To remove a selected grand total:


1

Select the row to which a grand total was applied and choose Grand Total on the shortcut menu.

A submenu showing all available total functions is displayed.

Select Delete.

Calculating a Break Total for a Column


You can add subtotals to the same column by choosing another column of non-numeric data
to serve as a break column. The break column is used as a reference point to determine where
to break the data in the target column. The data in the subtotal column is subtotaled for each
distinct range of identical values in the break column.
Once a break total is placed on one column, the break total is applied to all numeric columns.
Like the total functions you can use when adding a grand total, a break total can also consist of
different functions. These functions include:
152 Interactive Reporting

Data Function

Description

Sum

Sum of all underlying values

Average

Average of all underlying values

Maximum

Highest of underlying values

Minimum

Lowest of underlying values

Count

Number of underlying values

To apply a break total:


1

Select the column and choose Break Total on the shortcut menu.

A submenu showing all available break total functions is displayed.

Select a total function.

The default total function is Sum.


Break totals are displayed in the target column along with the break total function name.

To delete all break totals:


1

Select the column to which the break total was applied.

Select Break Total on the shortcut menu.

Select Delete All.

To remove a selected break total:


1

Select the row to which a break total was applied and choose Break Total on the shortcut menu.

A submenu showing all available total functions is displayed.

Select Delete.

Adding Computed Items in Results and Tables


In the Results and reporting sections, computations are performed in the Interactive Reporting
document file. The computations involve only the data in your results set or on the surface of a
reporting section.
In these sections you can only create new computed items: you cannot modify original data
items retrieved directly from the database.
Computed items in the Results and reporting sections differ in two respects:
l

In the Results and Table sections, reference items are limited to the items that is displayed
on the Request line.
In the remaining reporting sections (excluding the Report Designer section), items in any
data layout are available in the Reference dialog box. Computations in these sections work

Results and Tables 153

on the aggregated cell values that make up the core of the report. To perform computations
on data before it is aggregated, compute the new item in the Results section.
l

In the Report Designer section, the break totals of a table can be calculated.

To add a computed item in the Results and Table sections:


1

Select an item in the Request pane and choose Actions, and then Add Computed Item(s).

The Computed Item dialog box is displayed.


At least one Results or Table column must be present to enable the shortcut menu which
contains the option to add or modify a computed item. When no columns are present, you
must select the Add Computed Item from the Actions menu.

Enter a name for the computed item in the Name field.

The default name is Computed, which is numbered sequentially if there is more than one.
If you assign a name to a computed item that is identical to an existing scalar function name,
Interactive Reporting numbers the name starting with the number 2.

Select the data type of the computed item from the Data Type list box.

For information about data types, see Adjusting Data Types on page 134.

Enter the definition of the computed item in the Definition text box.
l

You can type operators to insert arithmetic and logical operators at the insertion point.
See also Operators on page 135.
Click Reference to display the Reference dialog box, and select items to place in the
equation. See also Reference on page 138.
You can also type any portion of the equation or the entire equation directly into the
Definition text box using JavaScript. The names are case sensitive, and you must replace
spaces in item names with underscores (_).

When the equation is complete, click OK.

Adjusting Data Types


Since computed items are new data items, confirm or change the data type of the item to preserve
the precision of a mixed-data type computations, or to change the way a data item is handled
(for example, interpreting number as strings). This ensures the correct handling of data in server
computations.
Attention to data types is most important when computing items in the Query section. Here the
computation is performed on the database server, and the computed item may be handled with
an unanticipated data type.
Local calculations (Results or Pivot) are handled internally, and adjustment between 16- and
32-bit integers can be handled safely using the automatic or number data type specification.

154 Interactive Reporting

Table 36

Data Types in Results and Tables

Data Type

Specification

Automatic

A data type is determined automatically given the data type of the reference items and the computations performed

Number

Numeric data type.

String

Text strings to a maximum length of 256 characters

Date

Calendar date in server default format (typically mm/dd/yy)

Picture

Picture (Blob) data types for image formats such as: jpeg, bmp, gif, and png.

Paging Through Results Data


By default Interactive Reporting shows a fixed number of rows in a table when a user views a
page in a browser. For paging behavior when data extends beyond the vertical and horizontal
rows shown on the page, see below.
Table 37

Results and Table Paging Options

Paging Option

Description

Current Page

The tooltip shows the current page in the report.

Page Up

Moves one page up. To move to the top page, select [Shift] + Click + Up arrow.

Page Down

Moves one page down. To move to the first page in the down direction, select [Shift] + Click + Down arrow.

Chart Section
Subtopics
l
l
l
l
l
l
l

Understanding Chart Dimensions


Chart Data Layout Categories
Legends
Changing Chart Properties
Working with Charted Data
Working with Chart Facts
Paging Through the Chart

Charts are fully interactive, three-dimensional views of data. A chart is a graphical representation
of a Pivot section. With a varied selection of chart types, and an arsenal of tools like grouping,
drill-down and drill to detail, the Chart section is built to support simultaneous graphic reporting
and ad-hoc analysis. You can add, move, cluster, focus and drill down into chart objects to gain
customized views of the data.

Chart Section 155

Understanding Chart Dimensions


A Chart can be referenced at three points: height, width and depth (x, y and z in Cartesian space).
To understand the differences among charts, you have to distinguish between dimensions in
space and dimensions of data. The two dimensions are distinct.
Data can either be represented in two or in three dimensional space. In two dimensions, data is
represented along the x and y axis. In three dimensions, data is projected back along the z axis.
Two dimensions of data must be represented in two dimensional space. At least three dimensions
of data are necessary to use the third spatial dimension.
But three or more dimensions of data can be represented in two dimensional space. For example,
cluster and stack represent data categories in the bar chart of two spatial dimensions (x and y
axes only).

Chart Data Layout Categories


The Chart Section opens with an initial plot area for the chart. Because you manage chart
construction and manipulation is with the Chart data layout plotting, viewing and reviewing
are easy and intuitive.
You construct a chart by dragging items from the Catalog pane to a data layout pane. At least
one items must populate the data layout to plot a usable chart.
The data layout consists of the following items:
Table 38

Chart Data Layout

Data Layout
Pane
X Axis
Slice

Description
Used for items placed on the x axis, which is a straight line on the chart. Used as a qualitative data label for categorizing
information. To place items on the x axis, use the X-Axis pane.

156 Interactive Reporting

Data Layout
Pane
Stack
Cluster
Depth

Description
Represents the third dimension of data, that is, the z axis that projects out toward you or a location in space. This axis
can either be qualitative or quantitative.
For a Stack pane, each dimension of data of the charts is represented by only one bar. This bar consists of as many
components as the data file has data rows, with the data from each row stacked onto the previous row. For example, a
single bar can represent the amount of sales for CD-ROM drives in one year on top of a bar representing sales for other
years. You can stack the bar charts vertically or horizontally. By stacking items and assigning a different color to each item,
you can display trends among comparable or related items, or emphasize visually a sum of several indicators.
For a Cluster pane, data extended in the third dimension is shown as clusters displayed in the foreground. This category
creates a vertical column (and only a vertical column) for each data value. If the chart is showing multiple data series, the
values are grouped based upon the category value. For example, use clustered bars to compare stores of different types.
Alternatively, cluster bars can be used to compare two different values items, such as Amount of Sales and Units Sold.
For the Depth, data extends the length of the chart along the z axis.

Fact
Fact (Stack)
Fact (Depth)

The Facts pane indicates height in the coordinate system. It is used as a quantitative label as a way of categorizing
information on the y axis.
For the Fact (Stack) pane, each dimension of numeric data is represented by only one bar. and shows the grouping along
the y axis. This bar consists of as many components as the data file has numeric rows, with the numeric data from each
row stacked onto the previous row. For example, a single bar can represent the amount of sales for CD-ROM drives in one
year on top of a bar representing sales for other years. You can stack the bar charts vertically or horizontally. By stacking
items and assigning a different color to each item, you can display trends among comparable or related items, or emphasize
visually a sum of several indicators.
For the Fact (Depth) pane, numeric data extends the length of the chart along the z-axis.

Legends
A chart legend can be set on the x, y or z axis enabling you to shift your focus to data listed on
a particular axis. This is a great way to view values on the selected axis without having to view
another chart report.
The following three examples shows how to set the legend on different axes to alter the
appearance and data shown by the same chart.
In the first example, the legend has been set on the x axis:

In the second example, the legend has been set on the y axis:

Chart Section 157

In the third example, the legend has been set on the z axis:

To set the chart legend:


1

Select the axis on which to set the legend.

Select Set Legend on from the shortcut menu.

The Axes drop-down list box is displayed.

Select either the x, y or z axis.

Changing Chart Properties


You can change the properties of a chart to view it in different perspectives:
l

Chart Types

Two-dimensional Chart Types

Chart Types
Chart types are defined by how they represent data graphically and how they plot values and
labels along the x, y or z axes. There are thirteen chart types, each of which may be switched from
a two-dimensional to a three-dimensional view (with the exception of the pie chart). Chart types
include:
l

Pie Charts

158 Interactive Reporting

Stacked Bar Charts

Clustered Bar Charts

Pie Charts

Bar Charts

Scatter Charts

Bubble Charts

Area Charts

Line Charts

Time Aware Axis

Ribbon Charts

Bar-Line (Combination) Charts

To change a chart type:


1

Select an item on the chart.

Select Change Chart Type on the shortcut menu.

Select another chart type from the submenu.

Two-dimensional Chart Types


Pie and bar charts (of the non-stacked variety) lend themselves to representing two dimensions
of data. For example, imagine charting the amount of sales by product type. In pie charts, the
two dimensions are represented by slices of a pie. In bar charts, the data is represented by bars
along the x and y axes. Two-dimensional chart types include pie and bar charts.
l

Pie Charts

Scatter Charts

Bubble Charts

Bar Charts

Pie Charts
Pieces (slices) of the pie are drawn to depict the relative value of a measurable item category to
the whole. Pie charts represent additional dimensions of data by further subdividing the pie.

Chart Section 159

Showing Negative and Positive Values


Pie slices can show both positive values and negative values.

To toggle the display of negative values, select a slice of the pie and select Show Negative
Values on the shortcut menu.

Showing Pie Percent


Pie slice values can be expressed as a percentage.

To toggle the display of each pie slice value as a percentage, select a slice of the pie and choose
Show Pie Percentages on the shortcut menu.

Bar Charts
Bar charts are the most common type of business chart and are especially useful for comparative
analysis when you want to focus on comparing values and place less emphasis on time. Use a
bar chart to illustrate comparisons among individual items.
In a vertical bar chart, items in the y axis form the chart bars. Items in the x axis and z axis itemize
the bars.

In a horizontal bar chart, items in the y axis form the chart bars, and items in the x and z axes
itemize the bars.

160 Interactive Reporting

Showing Bar Values


To toggle the display of values, select a bar and choose Show Bar Values on the shortcut
menu.

Scatter Charts
A scatter chart is useful for emphasizing scientific or statistical similarities rather than differences
in your analysis. Scatter charts illustrate the relationship between pairs of numerical or
quantitative values, which are combined into individual data points along the horizontal (y axis)
and a vertical (x axis) axis. Data points are plotted in uneven intervals.
A scatter chart represents non-aggregated sources, that is, it retrieves data from the underlying
Table/Reports section and does not reflect rolled up values (all other chart types retrieve their
data from an aggregated source, and there is a one-to one correspondence between Charts and
Pivots). For this reason, the Pivot This Chart feature is not available for a scatter chart.
Scatter charts can only contain a pair of fact or numeric values which are placed in the Y Axis
and X Axis in the data layout. If you add only one fact item to the data layout, no scatter chart
is rendered. In addition, label values cannot be added to the Y Axis or X Axis of the data layout.
The following feature limitations apply to scatter charts:
l

Data functions are not available to scatter charts because this type of chart relies on nonaggregated data.

The sort feature cannot be used for scatter chart items.

The Pivot To Chart feature is not available.

Drilling cannot be performed on a scatter chart.

The focus feature cannot be used on scatter chart items.

The Hide feature hides the whole data series in a scatter chart, and an individual item cannot
be hidden.

Chart Section 161

Bubble Charts
Bubble charts are typically used to show three dimensions of data in a two dimensional chart.
This type of chart often lends itself to the display of financial data because specific values can be
visually represented in your chart by different bubble sizes. It is similar to scatter chart allowing
you to plot data as a collection of bubbles. Bubble charts plot three values:
l

Value set on the x-axis

Value set on the y-axis

Value that defines the size or width dimension of a bubble in proportion to the amount of
data

Multiple data values can be plotted in the bubble chart.


Bubbles with zero size can rendered using some small bubble size to prevent them from
disappearing. Also there is an option can be provided to hide zero-size values if necessary.
Bubbles with negative values can also be displayed. These type of values are derived from their
real absolute value, and the real negative value is depicted in the data label (although based on
the positive value). You can optionally select not to show negative values.
Bubble charts have the following limitations:
l

Data functions are not available (this type of chart relies on non-aggregated data)

Sort is not available

Pivot To Chart is not available.

Drilling cannot be performed

Focus cannot be used

Hide hides the whole data series in a bubble chart; an individual item cannot be hidden.

To create a bubble chart:


1

In the Section pane, select the chart in which to generate the bubble chart.

Drag a fact value from the Catalog pane to the Y Axis of the data layout.

Drag a fact value from the Catalog pane to the X Axis of the data layout.

Drag a fact value from the Catalog pane to the Size pane of the data layout.

To show the real value of a data point, use the tool tip and hover over the data point.
To show grid lines on the scatter chart, click the plot area of the chart and select Show X Axis
Grid Lines or Show Y Axis Grid lines.

Multidimensional Chart Types


Frequently you may want to view data represented in more than two dimensions. For example,
you may want to see how the sales of product types break down by years or quarter. There are

162 Interactive Reporting

numerous ways to chart three or more dimensions of data. You can project data into the third
dimension of space. You can also represent the data in two spatial dimensions.
l

Viewing Three-dimensional Bar Charts

Clustered Bar Charts

Stacked Bar Charts

Area Charts

Stacked Area Charts

Line Charts

Time Aware Axis

Ribbon Charts

Bar-Line (Combination) Charts

Viewing Three-dimensional Bar Charts


You can add more information to your bar chart by adding an additional item or items to the z
axis of the chart. Using multidimensional charts, you can show various relationships between
three or more items in easy-to-understand bar chart formats.

Clustered Bar Charts


Cluster bar charts can be used to juxtapose categories in one label item category. For example,
use clustered bars to compare stores of different types. Clustered bars can also be used to compare
two different value items, such as Amount of Sales and Unit sold.
You can change your chart perspective so that the z axis data extended in the third dimension
is shown as clusters displayed in the foreground. This charting type is useful when z axis bars
are hard to distinguish in standard bar formats.
Cluster charts can be used to juxtapose categories in one label item. For example, use clustered
bars to compare stores of different types. Alternatively, cluster bars can also be used to compare
two different value items, such as Amount of Sales and Unit Sold.
Clustered bar charts are only displayed in a vertical format.

Chart Section 163

Stacked Bar Charts


One way to represent the third dimension of data is through stacking. In this way, a single bar
on the chart can show data for more than one category of data. For example, a single bar can
represent amount of sales for CD-ROM drives in one year on top of a bar representing sales for
other years. Stacked bar charts can stack vertically or horizontally.
The following is an example of a vertical stacked bar chart.

The following is an example of a horizontal stacked bar chart.

Area Charts
Area charts are essentially bar charts with discontinuous breaks removed along the horizontal
axis. Data is not broken into discrete bars, but is displayed in a continuous ebb and flow as
defined against the y axis. Consequently, area charts are particularly useful for emphasizing the
magnitude of change over time. In addition, area charts can be used for the same purpose as bar
charts.

164 Interactive Reporting

Because area charts do not break data along the horizontal axis, they are most useful for charting
three dimensions of data. The z axis should be used to either project data into a third-spatial
dimension, or to track two categories of data in a stacked area chart.
In the area chart, items on the y axis determine the height of the line, and items on the x axis
itemize the line sections. You can create multiple lines by adding items to the z pane.

Stacked Area Charts


Stacked area charts are essentially bar charts with the discontinuous breaks removed along the
horizontal axis, and categories of data are stacked on top of each other. Data therefore is not
broken into discrete bars, but is displayed in continuous ebb and flow as defined against the y
axis. A stacked area chart is an excellent way to display data that shows the relationship of parts
to the whole. Consequently, stacked area charts can be particularly useful for illustrating changes
that are plotted over a period of time.

Line Charts
Line charts show trends in data at equal intervals and are effective for comparing highs and lows
in a continuum. Items on the y axis determine the height of the line, and items in the X-Categories
itemize the line sections. You can create multiple lines by adding items to the Z-Category.

Chart Section 165

Line charts have one advantage over bar charts. They do not enable one set of data to obstruct
the representation of another. Since lines are thin compared to bars, the data displayed in the
front does not block out the data behind.
As a result, data that is not easily represented in bar or area charts work well in line charts. Many
more dimensions of data can be superimposed without impairing the effectiveness of the chart.

Time Aware Axis


The Time Aware Axis feature allows you to show dates in chronological order plotted at specific
intervals within minimum and maximum bounds. To do this, the Time Aware Axis feature turns
a discrete X-Axis into a continuous time interval. The distance between adjacent axis items is
proportional to their time value difference (a non Time Aware Axis shows all items using the
same difference between them). The Time Aware feature only implements an alternative
visualization of source data and does not affect the way how the data is aggregated and computed
items are calculated. That is, the data processing in chart section which includes dividing data
into categories and calculating fact data does not depend on whether the Time Aware feature is
activated. In particular, the behavior of the Chart This Pivot, Pivot This Chart and Add
Computed Item actions do not change.
The Line Charts is the main application area of this feature; however it is available in almost all
existing chart types. Scatter/Bubble charts do not include this option because they are already
time aware (essentially, value aware) by nature. Both have two fact axes which are continuous
by definition.
The Time Aware axis can only be used under specific conditions:
l

The X axis should have a date/time category to display, which becomes a dedicated Time
Scale category.
Only one category should be on the X-Axis. If you add multiple categories, even if they are
ate/time categories, the feature is rendered inactive.
The Time Aware axis is not available for pie, scatter and bubble charts.

166 Interactive Reporting

The Time Aware Axis is considered active if the conditions in the list above are met, and the
Time Aware option on the Label Axis dialog is not explicitly disabled. You can turn on or off
the feature. If you turn off the feature, the X axis remains discrete as in previous versions. By
default the feature is turned off for Interactive Reporting document files older than Release 9.3.
Charts created in Release 9.3 and later have the feature enabled.
Note: Since the Time Aware Axis assumes that all axis labels are in ascending order, the sort

order option is disabled.

To create a Time Aware axis:


1

Check the Time Aware option on the Label Axis tab of General properties.

Drag a date/time item from the Catalog pane to the X pane in the data layout.

Drag a value item from the Catalog pane to the Facts pane in the data layout.

Ribbon Charts
A ribbon chart is very similar to a line chart, but with a few visual differences. In ribbon chart,
values in the y axis determine the height of the line, and values in the x axis itemize the line
sections. You can create multiple lines by adding items to the z axis.

Bar-Line (Combination) Charts


Bar-Line charts (also known as Combination charts) combine some of the strengths of bar charts
with the advantages of line charts. Solid bars can be used for the most important data against
which other dimensions are represented in lines. In this way, emphasis is give to a portion of
data based on its importance. A combination chart is especially useful for comparing two
numeric values, such as amount and units of sales.

Chart Section 167

Note: A combination chart is most effective when the y axis contains only two value items. It

represents one value as bars and the other value as a line. When more than two values are
present, the chart alternates between bars and lines in depicting the values (1st, 3rd, 5th
items are bars; 2nd, 4th, 6th items are lines).

Working with Charted Data


Interactive Reporting provides several ways for you to dynamically manage your chart data for
better analysis. Review the following topics for information on:
l

Adding Chart Items

Removing Chart Items

Focusing and Hiding Charted Data

Grouping and Ungrouping Chart Labels

Reference and Trend Lines

Adding a Chart
To create a Chart based on the Results section data:
1

Select Actions, then Insert, and then Chart.

Drag Results items from the Catalog List to the Chart data layout.

The table columns are populated automatically.

Select a Chart type on the shortcut menu.

Adding Chart Items


Interactive charts consist of two layout elements: graphical elements (for example, Chart bars
or pie slices) and axis labels. When you add items to a chart, they become values or dimensions
in your report.

168 Interactive Reporting

To add a chart item:


1

Select a Chart item and choose Add item on the shortcut menu.

The x axis, y axis and z axis submenus are displayed. The z axis submenu does not display
for a pie chart.

Select a data label from the x axis submenu.

Select a fact item from the y axis submenu.

Select a data label item from the x axis (or Z-Cluster for a clustered chart, or Z-Stack for a stacked chart)
submenu to add a third dimension to the chart.

Removing Chart Items


Removing a plotted items in the Chart sometimes helps to simplify a chart display. However,
you do need at least one fact item in order to display a chart accurately.

To remove a chart item:


1

Select the item to be removed in the Chart from the data layout.

Select Delete on the shortcut menu.

The chart is redrawn to reflect the new configuration of items in the chart.

Refreshing Chart Values Manually


If a Chart section has been designed so that chart values can be refreshed manually, you can
request an immediate refresh to the current section.

To refresh chart values manually, click anywhere on the chart and select Refresh Chart on
the shortcut menu.

Focusing and Hiding Charted Data


A straightforward way to refresh your view of a chart is to single out items for closer focus or to
hide some of the charted elements. This allows you to concentrate on particular items of interest.
Focusing redraws the chart report to show only the item you have chosen. This feature is only
available for items on the x axis or z axis.
The Show All command updates the chart to include all items removed by focusing. Note that
this command is available only when a Chart item has been focused.
Generally, you should only hide items on the x or z axis. Hiding the y axis causes the entire fact
to be hidden.
The Show Hidden Items command restores any hidden item.

To focus on a chart item:


1

Select one or more item on which to focus.

Chart Section 169

The selected items are displayed with a dotted outline.

Select Focus on the shortcut menu.

The chart is redrawn to display only the chart item selected.

To show all items in a chart, select a chart item and choose Show Hidden on the shortcut
menu.

To hide charted data:


1

In the Chart, select the objects to hide.

The selected item(s) are displayed with a dotted outline.

Select Hide Item on the shortcut menu.

The chart is redrawn to hide the item.

To show hidden items, select a chart item and choose Show Hidden on the shortcut menu.

Grouping and Ungrouping Chart Labels


You can merge Chart axis labels using the Group feature. When combined, the data associated
with labels is aggregated, creating a new summary label category. With grouping, only your view
of the data is changed. You can easily ungroup grouped categories and return to your original
label values.
For example, your chart report is structured with data item Units (sold) dimensioned by Year
and Quarter. You can group the first and second quarters together to summarize activity for the
first half of the year. The data is aggregated in a new label.
This feature is available only for items on the x axis or z axis.

To toggle the group axis labels feature:


1

Select the individual labels to be grouped.

(You can group contiguous or discontiguous labels, but the labels must be part of the same
dimension item or axis.)

Select (Un)Group Items on the shortcut menu.

The selected labels, and their associated data values or chart objects, are combined. The
resulting label is displayed with an asterisk (*) to indicate a grouping.
To ungroup items, reselect the grouped items and choose (Un)Group Items on the shortcut
menu.

Reference and Trend Lines


Use the Reference, and Trend line tools to visually reveal trends in your data set, and to make
reasonable predictions about future values. These tools include:

170 Interactive Reporting

Reference LineA horizontal or vertical line drawn in the diagram to indicate a user defined
computed value.
Trend lineA line connecting two or more data points representing a linear regression
model of data. Generally, the trend line slants because it reflects the movement of a value's
increase or decrease over time.

Reference Lines
A Reference Line is a horizontal or vertical line drawn in the chart diagram to indicate a computed
value. It is typically used to illustrate or compare a fixed value within a category of values. It can
include an assigned statistical function (average, minimum or maximum). There can be several
reference lines created for the same fact column having different statistical functions associated
with each one. When the statistical function of a reference line is calculated, not only the data
from current page, but also the data from all pages of a multi-page chart (or zoomed chart) are
included. The category items that are hidden as a result of applying Hide Items or Focus on
Item or Drill Anywhere are not included.
Reference lines can be drawn on the top of visible graphic elements of a diagram (for example,
bars or lines). By default the lines are drawn on the top. Reference lines can be shown wit ha text
label, and reference line information in the legend. By default a reference line has a text label
associated with it showing auto-generated text. This line. is set automatically and cannot be
adjusted by a user.
This example shows a fact based reference line associated with an Amount Sales fact column
assigned to the Average function.

2D and 3D Reference Lines


The Stacked Bar, Stacked Area charts both allow axis-based and fact-based Reference lines. A
single fact-bound Reference Line is drawn for summed stacked items.
A Pie chart cannot have any type of reference line.
The fact based reference line is always associated with a fact column. When the column is
removed from the Chart data layout, the corresponding reference line is also removed. When
the fact column is hidden or focused, the reference line is also hidden, or focused.

Chart Section 171

If the chart type is switched to another chart type, the Reference Lines is hidden. Switching back
to the original chart type restores the lines.
Reference Lines and Chart Types
The Stacked Bar, Stacked Area charts both allow axis-based and fact-based Reference lines. A
single fact-bound Reference Line is drawn for summed stacked items. A Pie chart cannot have
any type of reference line. The fact based reference line is always associated with a fact column.
When the column is removed from the Chart data layout, the corresponding reference line is
also removed. When the fact column is hidden or focused, the reference line is also hidden, or
focused. If the chart type is switched to another chart type, the Reference Lines is hidden.
Switching back to the original chart type restores the lines.
Adding and Modifying Reference Lines

To add a reference line, select a chart item that represents a data fact and on the shortcut
menu, select Add Reference Line.

To modify a reference line:


1

Double-click the reference line.

The Reference Properties dialog box is displayed.

Select the Reference Line tab.

Select Fixed to assign an axis based reference line, or a fact item from the Fact drop-down.

To assign a statistical function to a fact based reference line, select a function from the Function dropdown list.

Enable Show in legend to show the reference line in the legend.

Enable Show label to show the reference line label.

For more information about general reference lines, see Reference Line General
Properties .

Select the Label Format tab to select any label properties.

For more information about reference line label formats, see Reference Line Label Format
Properties .

Select OK.

Trend Lines
Trend lines are used to track trends in a data series graphically. Interactive Reporting supports
trend lines modeled after linear regression analysis. Generally the trend line is represented as a
slanted line that crosses the diagram. For example, the trend line can demonstrate an increase
or decrease of values over time. It may be accompanied with the calculated goodness of fit (Rsquared) value.

172 Interactive Reporting

Trend lines can be layered on top of the chart graphics (or Z axis for 3 D charts), or positioned
to the background. When data is processed to create the trend line, facts from all pages of the
chart are included. Chart items hidden or focused explicitly by the user are not included.
Trend lines are always fact based, and only one trend line can be associated with a single fact
column. In Scatter and Bubble charts, the trend line is bound to the data series.

2D and 3D Trend Lines


Trend lines should be used primarily with two dimensional perspective, but are supported with
a three dimensional (3D) perspective. If they are used with a 3D perspective, several parallel
lines are drawn along the Z-axis together with graphical data.
Trend Lines and Chart Types
Trend lines can be added to most chart type including stacked charts (Bar and Area). The value
of each stack is included when the trend equation is calculated. When the separate stackables of
a full bar belong to different facts, then a single trend for all facts is drawn. The sum of separate
facts (either positive or negative) is included when calculating the trend line equation.
Trend lines are most effect in Scatter, Bubble and Time Aware charts.
A trend line with a single category on the X axis is preferable. In cases where there are multiple
categories on the X axis, it might be difficult to analyze the trend if the categories are unrelated.
Pie charts cannot have trend lines.
Adding a Trend Line

To add a trend line, select a chart item that represents a data fact and on the shortcut menu,
select Add Trend Line.

Trend Line General Properties


Use the Trend Line Properties dialog box to select general trend line properties.

Chart Section 173

Table 39

Trend Line General Properties

Property

Description

Fact

Select the fact item on which to assign the trend line. Multiple trend lines cannot be assigned to a single fact item.

Show in legend

Enable to show assigned text of the trend line and short line segment representing the actual color of the line in the
legend.

Show label

Enable to show the label text on the diagram.

Bring to front

Positions the reference line in front of the chart item.

Send to back

Positions the reference line in back of the chart item.

Trend Line Label Format Properties


Use the Trend Line Label Format dialog box to set up the line label and legend text.
Table 40

Trend Line Label Format Properties

Property

Description

(Text Format for


Plot Area or
Legend)

Format text for the plot area (line label) or legend text from the drop-down. If the Use the same format in plot area
and legend field is enabled, this option is disabled.

(Custom Format)

Specify a custom format for the plot area or legend. A custom format can combine constant text and generated strings
to show the trend line name, the equation type, or a coefficient of determination (R-squared).
Trend line formats default formats that can be customized include:
l

Trend{([FC])}Trend(<Fact name>)

[ET]Equation Type (Linear only)

{R squared=[RS]}Coefficient of determination (how good the fitness is), for example, R-squared=0.7349

.
Use the same
format in plot
area and legend.

Enable to use same format for the plot area and legend. When this option is enabled, you cannot select separate
formats for the plot area and legend.

Auto format

The following Default, Equation type and R-squared fields can be enabled to reset the label text to auto-generated
text on the line. Each field adds predefined tags to the text format. If no auto-format is enabled you can enter a
custom format in the edit box.

Default

Shows the default text: Trend(<Fact name>)

Equation Type

Shows the equation name in auto-generated text, for example: linear.


Note: As of Release 11.1.1 only the linear equation type is available.

R-squared

Shows coefficient of determination (how good the fitness is, or how good the trend line conforms to the data) in a
value range from 01, for example R-squared=0.7349.

174 Interactive Reporting

Reference Line General Properties


Table 41

Reference Line Properties

Property

Description

Fixed

Enable to assign a fixed value to the reference line (axis based).

(edit box)

Specify the fixed value amount to use for the reference line. The amount must be numeric. It remains constant on the
reference line, and does not depend on another item in the Fact pane of the data layout.

Fact

Select the fact based column for the reference line from the drop-down. Available columns are based on the columns
in the data set.

Function

Select the function to apply to the fact based column. Available functions are:
l

Average

Maximum

Minimum

Show in legend

Enable to show assigned text of the reference line and short line segment representing the actual color of the line in
the legend.

Show label

Enable to show the label text on the diagram.

Bring to front

Positions the reference line in front of the chart item.

Send to back

Positions the reference line in back of the chart item.

Reference Line Label Format Properties


Use the Reference Line Label Format dialog box to define line label (plot area) and legend text
properties.
Table 42

Reference Line Label Format Properties

Property

Description

(Text Format
for Plot Area
or Legend)

Formats text for the plot area or legend from the drop-down.
If the Use the same format in plot area and legend field is enabled, this option is disabled.

Chart Section 175

Property

Description

(Custom
Format)

Specify a custom format for the plot area or legend.


A custom format can combine constant text and generated strings for a statistical function or the value of the reference
line.
Constant text accepts the following tags:
l

[FC]fact name

[VL]value of reference line.

For example, the custom format: Expected sales = [VL] could return the results in the label or legend: Expected sales
= $26300000. If the text for a tag cannot be generated (for example, the format is for an [FN] tag on an axis based
reference line), the tag resolves in an empty string, and it is removed.
A custom format can include complex tags combining arbitrary text with one or more simple (and even complex) tags. A
complex tag is bounded by curly braces ({}), for example, {Sales [FN] = }[VL]. If at least one of the tags inside the
complex tag cannot be resolved, all complex tags result in an empty string.
A fact based reference line using the format above might be resolved in aSales Average = $126000 string, and for an
axis based reference line it could be resolved in a $126000 string.
The special delimiter tag, [DL] is available. This tag inserts a space in the resulting string if both the left and right tags are
successfully resolved.
The complex tag, {; [DL] }inserts custom text as a delimiter. For example, the format {[FN]([FC])}{ = [DL]}[VL] may result
in one of the following strings depending on conditions:
l

Average(Sales)

Average(sales) = $126000

Auto format

The following Default, Function and Value fields can be enabled to reset the label text to auto-generated text on the line.
Each field adds predefined tags to the text format. If no auto-format is enabled you can enter a custom format in the edit
box.

Default

Show the default text: <Function name>(<Fact name>) = <Value>

Function

Shows the statistical function in auto-generated text, for example: Average.

Value

Shows the value of the reference line, for example: Value = 0.7348.

Working with Chart Facts


Data functions in the Chart section are particularly useful if you want your report to display
different types of values. Data functions summarize groups of database records and replace the
original values with new summary data.
For example, in the Pivot section, you can show either the total sale, average sale, or the maximum
sale of each product by quarter. Each of these dimensions is based on the same underlying values.
They differ only in the data function that is applied.
The following table shows the Chart Functions:

176 Interactive Reporting

Table 43

Chart Data Functions

Data Function

Returns the:

Sum

Sum of all underlying values.

Average

Average of all underlying values.

Count

Number of underlying values.

Count Distinct

Number of distinct values in a column.

Maximum

Highest of underlying values.

Minimum

Lowest of underlying values

Perc of Grand

Sum of underlying values as a percentage of all surface values in the report.

NonNullCount

Number of underlying values; null values are excluded.

To apply a data function:


1

Select a bar or row of facts (such as Amount).

Select Data Function on the shortcut menu.

A shortcut menu of available data functions is displayed.


Optional: You can also select the item or column and choose Actions, then Data
Function, and select the (function).

Select the function.

Each column is recalculated according to the data function applied to the underlying value.

Paging Through the Chart


By defaultInteractive Reporting shows a fixed number of rows in a table when a user views a
page in a browser. Often data extends beyond the vertical and horizontal rows shown on the
page. To view your paging options, see the table below.
Table 44

Chart Paging Options

Paging Option

Description

Current Page

Tooltip shows the current page.

Page Left

Moves one view in the left direction. To move to the first view in the left direction, select [Shift] + Click + left arrow.

Page Up

Moves one view up in the Chart sections. To move to the top view, select [Shift] + Click + Up.

Page Down

Moves one view in the down direction. To move to the first view in the down direction, select [Shift] + Click + Down arrow.

Page Right

Moves one view in the left direction. To move to the first view in the right direction, select [Shift] + Click + right arrow.

Chart Section 177

Pivot Section
Subtopics
l
l
l
l
l
l
l

Pivot Table Components


Working with Pivot Data
Focusing and Hiding Pivoted Data
Working with Row and Column Labels
Working with Pivot Facts
Analyzing Pivot Data
Paging Through Pivot Data

Pivot tables are analytical tools that resemble spreadsheets or crosstab reports. Data can be sliced
and diced for ad-hoc, interactive and multidimensional analysis. You can pivot your data at any
time to change the way you view it, or you may drill down, or drill to detail to see how it all adds
up or summarizes. Pivot tables also allow you to add, move, focus on and group dimensions to
gain customized views of the data.

Pivot Table Components


A pivot table is composed of three components:
l

FactsNumeric values broken up in the body of the pivot table. Facts may also be referred
to as data values.
Data LabelsColumn and row headings on the top and sides of the Pivot and define the
categories by which the numeric values are organized
DimensionsFull row or column of labels

Working with Pivot Data


Interactive Reporting provides several ways for you to dynamically manage your pivot data for
better analysis:
l

Adding a Pivot Section

Adding Pivot Items

Deleting Pivot Items

Auto-Sizing a Column

Focusing and Hiding Pivoted Data

Swinging Pivot Dimensions

Grouping and Ungrouping Pivot Labels

178 Interactive Reporting

Adding a Pivot Section


To create a table based on the Results section data:
1

Select Actions, then Insert, and then Pivot.

Drag items from the Catalog list to the Pivot data layout.

If the data layout is not displayed, select View, and then Data Layout.
Interactive Reporting populates the cells, rows and columns automatically.

Adding Pivot Items


You can add items from the results set to view and analyze different scenarios in your Pivot.

To add a pivot item:


1

From the Catalog list, select any item and click Add Items on the shortcut menu.

A shortcut showing Row, Column or Facts is displayed.

Select the value you want to add.

Deleting Pivot Items


To delete a pivot item:
1

Select the item to be removed from the Facts, Rows or Columns data layout.

Select Delete on the shortcut menu.

The Pivot is redrawn to reflect the new configuration of items.

Refreshing Pivot Values Manually


If a Pivot section has been designed so that pivot values can be refreshed manually, you can
request an immediate refresh to the current section.

To refresh pivot values manually, click anywhere on the pivot and select Refresh Pivot on
the shortcut menu.

Auto-Sizing a Column
By default, Interactive Reporting truncates columns evenly and without regard to the length of
data values. With the Auto-Size Column Width feature, you can automatically size any column
to fit the text of the largest value in the column.

To autosize a column:
1

Select the column.

Pivot Section 179

Select Auto-Size Column Width on the shortcut menu.

Focusing and Hiding Pivoted Data


A straightforward way to refresh your view of a pivot table is to single out items for closer focus
or to hide some of the pivot elements. This allows you to concentrate on particular items of
interest.
Focusing redraws the pivot table to show only the item you have chosen to focus on.
The Show All Items command updates the pivot table to include all items removed by focusing.
This command is available only when a pivot dimension label has been focused.
Hiding columns is a good way to temporarily suspend the display of a column.

To toggle the focus on a pivot item:


1

Select one or more dimension labels (either side or top).

Choose Focus on the shortcut menu.

The Pivot is redrawn to display only the chart object selected.

To show all items, select a dimensional label and choose Show All on the shortcut menu.
To hide pivoted data:
1

Select an item.

Select Hide Items on the shortcut menu.

The Pivot is redrawn to hide the selected object.

To restore a selected hidden item, select a pivot item and choose Show Hidden on the shortcut
menu.

Working with Row and Column Labels


Row and column labels can be grouped and reoriented:
l

Grouping and Ungrouping Pivot Labels

Swinging Pivot Dimensions

Grouping and Ungrouping Pivot Labels


You can merge pivot labels using the Group feature. When combined, the data labels are
aggregated, creating a new summary label category. With grouping, only your view of the data
is changed. You can easily ungroup grouped categories and redisplay original label values.

180 Interactive Reporting

For example, your pivot table is structured with data item Units (sold) dimensioned by Year
and Quarter. You can group the first and second quarters together to summarize activity for the
first half of the year. The data is aggregated in a new label.

To toggle the group dimensional label feature:


1

Select the individual labels to be grouped.

(You can group contiguous or discontiguous labels, but the labels must be part of the same
dimension item or axis.)

Select (Un)Group Items on the shortcut menu.

The selected labels, and their associated data values or chart objects, are combined. The
resulting label is displayed with an asterisk (*) to indicate a grouping.
To ungroup items, reselect the grouped items and choose (Un)Group Items on the shortcut
menu.

Swinging Pivot Dimensions


The swing feature allows you to re-orient the axes of a pivot table and view your data in new
ways. When you swing a dimension, you can move it up, down or to the opposite axis. This
feature is a powerful tool that makes pivot table reporting more powerful than a common
spreadsheet.
Note: You can swing pivot dimensions by moving items within and between data layout panes.

To swing a dimensional label:


1

Select a dimensional label and choose Swing on the shortcut menu.

Select a direction.

Valid swing positions are:


l

Vertical

Horizontal

Up

Down

Left

Right

Before

After
If you select the before swing positions, you must choose the dimension label before
which you wish to place the selected label. This behavior applies to the after selection
as well.

Pivot Section 181

Working with Pivot Facts


Core numeric data that you slice and dice dimensionally in your analysis are called facts. Facts
can be summed to create totals.
You can calculate totals for both columns and rows in a Pivot report. If you layered dimension
items along the top or side labels of your report, you can calculate the totals for any level in the
hierarchy. When you select an inner dimension for totaling, subtotals are created for each of the
categories in the outer dimensions. Totals in the Pivot section include:
l

Total Function

Cumulative Totals

Surface Values

Total Function
You can quickly add totals to your pivot table data. The new total value is created as an additional
column. Total functions can be applied to:
l

Underlying values from the original results sections

Surface values displayed in the Pivot

Depending on which set of values you apply the total function, different results are yielded.
Consider a simple pivot table with two values of 20 and 30. Each of these is already a total of
underlying values (20 = 8 +12 and 30 = 10 + 20). An average of the underlying value yields the
result of 12.5 = (8 + 12 + 10 + 20) /4). An average of the surface values yields the results 25 =
(20 +30) / 2).

To add totals to a Pivot:


1

Click a row or column label handle to select it.

Selecting the outermost label creates a total; selecting an inner label creates a subtotal.

Select Add Total on the shortcut menu.

A submenu of data functions is displayed.

Select a data function.

Cumulative Totals
By adding cumulative running totals to a pivot table, you can break totals by dimension to restart
at each dimensional grouping in the report.

To add a cumulative calculation:


1

Select a fact item in the data grid of the Pivot.

Select Add Cume on the shortcut menu.

The Add Cume shortcut menu is displayed.

182 Interactive Reporting

Select a scope from the Add Cume shortcut menu.

A new data values item named Cume of X is displayed across each row of the report. The
new cume item maintains a cumulative running sum of the original data values item.
Note: Cumulative totals are most effective when all dimensions are located on a row or

column of the report, and data label column heads are placed orthogonally.

To modify a cumulative calculation:


1

Select a column in which a cume has already been place in the pivot tables data grid.

Select Modify Cume on the shortcut menu.

The Modify Cume submenu is displayed.

Select a scope from the Modify Cume shortcut menu.

Surface Values
You can use underlying or surface values when working with totals in Pivot sections. Underlying
values refer to values from the original results section. Surface values refers to values in the actual
report section. The two approaches yield different results, and produce values that may be
displayed incongruous with the values in the report.
To understand this difference between underlying and surface values, consider a simple pivot
table with two values of 20 and 30. Each of these is already a total of underlying values (20 = 8
+12 and 30 = 10 + 20). An average of the underlying value yields the result of 12.5 = (8 + 12 +
10 + 20) /4). An average of the surface values yields the results 25 = (20 +30) / 2). By default,
the surface value feature is not active.

To activate surface values, select a pivot item and Surface Values on the shortcut menu.

Analyzing Pivot Data


Data functions in the Pivot section are particularly useful if you want your report to display
different types of values. Data functions summarize groups of database records and replace the
original values with new summary data.
For example, in the Pivot section, you can show either the total sale, average sale, or the maximum
sale of each product by quarter. Each of these dimensions is based on the same underlying values.
They differ only in the data function that is applied.
Table 45

Pivot Data Functions

Data Function

Returns the:

Sum

Sum of all underlying values.

Average

Average of all underlying values.

Pivot Section 183

Data Function

Returns the:

Count

Number of underlying values.

Count Distinct

Number of distinct values in a column.

Null Count

Number of nulls among underlying values.

Non-Null Count

Number of underlying values; null values are excluded.

Maximum

Highest of underlying values.

Minimum

Lowest of underlying values

% of Row

Sum of underlying values as a percentage of their respective surface row.

% of Column

Sum of underlying values as a percentage of their respective surface column.

% of Grand

Sum of underlying values as a percentage of all surface values in the report.

To apply a data function:


1

Select a row or column of facts (such as Amount).

Select Data Function on the shortcut menu.

A shortcut menu of available data functions is displayed.


Optional: You can also select the item or column and choose Actions, then Data
Function, and select the (function).

Select a function.

Each column is recalculated according to the data function applied to the underlying value.

Paging Through Pivot Data


By default, Interactive Reporting shows a fixed number of rows in a table when a user views a
page in a browser. Often data extends beyond the vertical and horizontal rows shown on the
page. To view your paging options, see the table below.
Table 46

Pivot Paging Options

Paging Option

Description

Current Page

The tooltip shows the current page in the report.

Page Left

Moves one page in the up direction. To move to the top page, select [Shift] + Click + Up.

Page Up

Moves one page in the down direction. To move to the first page in the down direction, select [Shift] + Click + Down
arrow.

Page Down

Moves one page in the left direction. To move to the first page in the right direction, select [Shift] + Click + right arrow.

Page Right

Moves one page in the left direction. To move to the first page in the left direction, select [Shift] + Click + left arrow.

184 Interactive Reporting

Common Chart/Pivot Features


Subtopics
l
l
l

Sorting Charts/Pivots
Drill Anywhere into Charts/Pivots
DrillDown into Dimensional Data

Interactive Reporting document file management features allow you to easily tailor the look of
reports. The features shown below are common in the Chart and Pivot sections:

Sorting Charts/Pivots
In the Chart and Pivot sections, data is sorted alphabetically. You can override this default and
sort dimensional data with reference to other data, rather than alphabetically.
For example, if a chart lists each type of item your company sells and the total amount sold of
each, initially the item types are alphabetically ordered. But this data becomes more meaningful
when you instead sort the item types with reference to the total sales revenue produced by each.
This approach allows you to rank each product type from highest to lowest total sales.
When you want to apply a sort criteria there are three components used to define the sort
condition:
l

Sort ItemsItem sorted in ascending or descending order. In the Chart section, sort items
refers to the chart axes. In the Pivot section, sort items refers to the pivot dimensions.
Referential ItemsNumeric data item included in the Chart or Pivot section, and also the
keyword labels. These selections provide two ways to sort the selected Chart or Pivot item.
m

Sorting by labelsDimensional data items are sorted alphabetically by name when the
chart section is created: this is equivalent to sorting by labels. When selected, the
labels keyword indicates that the item chosen from the submenu are sorted by label
or name rather than by reference to corresponding numeric data values in the report.
Sorting by valuesSorting by a numeric data item orders each value of the target item
specified by its corresponding numeric value in the second list. Sorting by values
produces an entirely different sort order. For example, your chart may list each state in
which your company has made sales revenue and the total cost-of-sales for each. The
data items are initially listed in alphabetical order, that is, sorted by labels. When you
sort instead by cost-of-sales, the states are ranked in order by each corresponding costof-sales figure.

FunctionsAggregate statistical functions available when you sort by values. The functions
generally duplicate the data functions available in the chart section.

When you sort by values, dimensional data is sorted by the corresponding numeric values of the
referenced item. (For example, sorting states by the sum total of the cost of good sold in each
state).

Common Chart/Pivot Features 185

To specify a sort:
1

Select an item to sort in the Chart or Pivot sections.

Click Sort Ascending or Sort Descending on the shortcut menu.

Select Label to sort the item alphabetically, or select the numeric value item as a sort reference.

If you selected a numeric value, choose an aggregate function on the shortcut menu.

Drill Anywhere into Charts/Pivots


The Drill Anywhere feature allows you to drill into and add items in the Chart and Pivot sections
that are resident in the Results section, but have not been included in the Chart and Pivot you
are viewing. Drill anywhere items are broken out as a new label item(s) automatically. The
advantage of this feature is that it instantly allows you to add items to the data set to reflect
temporary and hypothetical situations.
The extent to which you can drill into your data depends on how the original query was built,
since Drill Anywhere retrieves data from the Results section.

To drill anywhere into a Chart:


1

Select a pivot dimension or chart item for analysis.

Select Drill Anywhere on the shortcut menu.

A shortcut of drill anywhere items displays.

Select an item on which to drill down.

The report is redisplayed, breaking out the additional data as a new label item.
Note: If no options are available in the Drill Anywhere drop down list, all available items

have been referenced in the chart.

DrillDown into Dimensional Data


The DrillDown feature enables you to use a predefined drill-down path to go directly to the next
item in a hierarchy when working with dimensional analysis. For example, you may need to find
out if a particular product sells better in different regions of the country. Using a drill-down
path, all you have to do is follow the drilldown path to discover which state or even city is a more
appropriate market for your product.

To drill down into a Pivot or Chart label:


1

Select any label for drill-down analysis.

Because the drill-down into feature is not context sensitive, access the drill-down from any
label shown.

Click Drilldown into on the shortcut menu.

186 Interactive Reporting

All available drill-down paths are displayed. Each drill-down path shows the topic which is
being drilled into, and the label from which it was drilled.

Click the drill-down label.

After you specify the drill down label, the label is added to the data layout and breaks out
the additional data according to the label selected for drill-down.

To drill up from data:


1

Click the label that has been drilled downed.

On the Pivot or Chart menu, select Drill Up.

The report is redisplayed, reversing the drill-down and displaying the original item.

OLAPQuery Section
Subtopics
l
l

Working with OLAP Data


OLAP Data Functions

The OLAPQuery section is designed for viewing and analyzing queries based on
multidimensional databases (MDD).

Working with OLAP Data


Interactive Reporting provides several ways for you to dynamically manage your OLAP data for
better viewing analysis:
l

OLAP Terminology

Auto-Sizing a Column

Sorting OLAP Dimensions

Drilling into OLAP

Drilling up

OLAP Terminology
CubeData in OLAP databases is stored in cubes. Cubes are made up of dimensions and
measures. A cube may have many dimensions.
DimensionsIn an OLAP database cube categories of information are called dimensions. Some
dimensions could be Location, Products, Stores, and Time.
MDXMDX (Multi Dimensional eXpressions) is the language used to give instructions to OLE
DB for OLAP- compliant databases. When an OLAP query section is built, <product Interactive
Reporting is translating those into MDX instructions. When the query is refreshed, MDX is sent

OLAPQuery Section 187

to the database server. The data the server returns to the Interactive Reporting document file is
the collection of records that answers the query.
MeasuresMeasures are the numeric values in an OLAP database cube that are available for
analysis. The measures could be margin, cost of goods sold, unit sales, budget amount, and so
on.
MembersIn a OLAP database cube, members are the content values for a dimension. In the
location dimension, they could be San Francisco, Japan, Paris, 35 Main Street, Tokyo, USA,
France, Rome, and so on. These are all values for location.
MultidimensionalMultidimensional databases create cubes of aggregated data that anticipate
how users think about business models. These cubes also deliver this information efficiently and
quickly. Cubes consist of dimensions and measures. Dimensions are categories of information.
For example, locations, stores and products are typical dimensions. Measures are the content
values in a database that are available for analysis.

Auto-Sizing a Column
By default Interactive Reporting truncates columns evenly and without regard to the length of
data values. With the Auto-Size Column Width feature, you can automatically size any column
to fit the text of the largest value in the column.

To auto-size a column:
1

Select the column.

Select Auto-Size Column Width on the shortcut menu.

Sorting OLAP Dimensions


In the OLAP section, data can be sorted in ascending or descending order.

To specify a sort:
1

Select an item to sort in the OLAP sections.

Select either Sort Ascending or Sort Descending on the shortcut menu.

Select Label to sort the item alphabetically, or select the numeric value item as a sort reference.

If you select a numeric value, choose an aggregate function on the Function shortcut menu.

Drilling into OLAP


The Drill Down feature retrieves data from the MDD cube following the hierarchy down to the
granular level. When you find a specific item to learn more about, such as a product line, you
can drill down into the item label. You can drill down on more than one item and additionally
drill down on all items at the same time.
For a member drill down, any row or column label can be drilled into so that you can view the
structure of the hierarchies for any particular dimension. Every time you select a specific label

188 Interactive Reporting

in a dimension row or column, you show only the data for that label value. When you select the
dimension tab for a level, you show all the members of that dimension level.
For a measure drill down, you can show how different measures consolidate together. A drill
down on a measure is done on a progressive basis, one level at a time on a 1 to n path (sequential
rather than nested). For example, if Profit is the parent of Tax and Pre-Tax Profit, and Revenue
and Expenses are children of Pre-Tax Profit, then the Tax and Pre-Tax columns are drilled down
first and you must select the Pre-Tax label to display the Revenue and Expense columns.
Note: You cannot set filters while in a drilled-down state on a dimension.

To drill down on a label:


1

Select a label.

Click Drill Down on the shortcut menu.

You can select a label and choose Action, then Drill Down.
Note: Essbase only: For a measure drill down, you can show how different measures

consolidate together. A drill down on a measure is done on a progressive basis, one


level at a time on a 1 to n path (sequential rather than nested). For example, if Profit
is the parent of Tax and Pre-Tax Profit, and Revenue and Expenses are children of
Pre-Tax Profit, then the Tax and Pre-Tax columns are drilled down first and you must
double-click the Pre-Tax label to display the Revenue and Expense columns.

Drilling up
If you used the drill-down feature, you return to your original view of the data by drilling up
one level at a time. To drill up, you simply select the level to drill up.

To drill up on a label:
1

Select the label that has been drilled down.

Select Drill Up on the shortcut menu.

Optional: You can also select a label and choose Action, then Drill Down.

OLAP Data Functions


Column or row totals added to your OLAPQuery are aggregates (literally, totals of totals), and
can be recalculated using data functions. When applied to totals, data functions apply to the
calculation to surface values.
When applied to surface values, data functions recalculate the values in the visible cells or
surface of the OLAPQuery. For example, you can show the total sale, average sale, and
maximum sale of each product by Quarter. Each of these dimensions is based on the same value.
They only differ in the data function that is applied.

OLAPQuery Section 189

Table 47

OLAP Data Functions

Data Function

Returns the:

Sum

Sum of all values

Average

Average of all values

Count

Number of values

Maximum

Highest value

Minimum

Lowest value

% of Row

Surface values as a percentage of their respective row item

% of Column

Surface values as a percentage of their respective column item

% of Grand

Surface values as a percentage of all like values in the report

To apply a data function:


1

Select a row or column of facts (such as Amount).

Select Data Function.

A list of available data functions is displayed.


Optional: You can also select the item or column and choose Actions, then Data
Function.

Select the function.

Each column is recalculated according to the data function applied to the underlying value.

190 Interactive Reporting

CubeQuery Section
Subtopics
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l

About Essbase
About Multidimensional Database
Catalog List
OLAPQuery and CubeQuery Data Layout Differences
Building a CubeQuery
DB Logon
Searching Members
Member Selection
Filter Member Selection
Navigating CubeQuery
Using Swing
Downloading to Results
Formatting CubeQuery Items
Query Options
Launching Smart View from CubeQuery

The CubeQuery section is the Interactive Reporting interface with Essbase 7.x , and 9.x databases.
It provides access to the cube in which multidimensional data can be analyzed and complex
calculations can be applied before and after the query is processed. The data set from this section
can be shown with relational data side-by-side in a dashboard report, or the data can be
downloaded to a results set and joined to relational sources.

About Essbase
Analytic Services is a multidimensional database application that enables you to analyze multiple
aspects of your business continually in comparison to one another. The Essbase database has
the following characteristics:
l

Works with multidimensional data and roll-up hierarchies in dimensions.

Retrieves information from other systems.

Handles some level of summarized data, not transaction.

Adaptable to multiple reporting and analysis environments.

Additionally the Essbase database uniquely blends an innovative technical design with an open,
client-server architecture. Essbase can be used for a broad range of online analytical processing
(OLAP) applications, including:
l

Budgeting

Forecasting and seasonal planning

Financial consolidations and reporting

Customer and product profitability analysis

CubeQuery Section 191

Price, volume and mix analysis

Executive information systems

About Multidimensional Database


The Essbase multidimensional database stores and organizes data. It is optimized to handle
applications that contain large amounts of numeric data and that are consolidation-intensive
or computation-intensive. The database organizes data in a way that reflects how users want to
view the data.

Definition of Multidimensional
A multidimensional database is an extended form of a two-dimensional data array, such as a
spreadsheet, generalized to encompass many dimensions. Dimensions are composed of values
called members, which are arranged in a hierarchical structure. A dimension is a perspective or
view of a specific dataset. A system that supports simultaneous, alternate views of datasets is
multidimensional. Dimensions are categories such as time, accounts, product lines, markets and
so on. Each dimension contains additional categories that have various relationships one to
another. Members are the names of the elements within a dimension. A dimension can contain
an unlimited number of members.

Number

Description

Dimension

Member

Dimensions and Members


Dimensions and members describe the metadata structure of the database, which is also known
as the Essbase outline. The Essbase outline determines how data is stored inEssbase. Following
are typical examples of dimensions and their members:
l

TimeHours, Days, Months, Quarters, Years

MeasuresProfit, Inventory, Ratios

192 Interactive Reporting

ProductIndividual products of the company

MarketNorth, South, Central

ScenarioActual, Budget, Variance, Variance %

Non-Aggregate Dimensions
Some dimensions are aggregates of their members. For example, 24 hours make a day, 7 days
compose a week, 52 weeks make a year, and so on. In these cases, the Time dimension represents
the sum of its components. However, some dimensional hierarchies are not the sums of their
components. For example, the Measures dimension commonly comprises business measures
such as Sales, Profit, and Cost of Goods Sold. When the dimension label cannot represent the
sum of contents, a protocol replaces the dimension label with a member set. Essbase uses the
first child in the dimension outline as the implied share instead of non-aggregate dimension
labels.

Familial Relationships
To simplify the concept of hierarchical order, Essbase uses familial relationships.
l

ParentDirect ancestor of an element in a hierarchy; for example, Quarters are the parent
of Months.
ChildDirect descendant of any element in a hierarchy; for example, Months are children
of Quarters.

DescendantsElements of greater detail; for example, Days are descendants of Weeks.

AncestorsElements of more generality; for example, Weeks are ancestors to Days.

SiblingsMembers with the same parent

CubeQuery Section 193

Number

Description

Ancestor

Parent

Child

Descendent

Siblings (not marked)

Generations and Levels


Hierarchical structure also can be described in terms of generations and levels. Dimension
members on the same layer of the dimensional hierarchy are referred to collectively as
generations or levels. The relationships are defined as follows:
GenerationsCounted down from the highest ancestor. The root member, or dimension
name, is Generation 1. In the following figure, Market is Generation 1

LevelsCounted from bottom to top: Level 0, Level 1, Level 2, and so on. In the following
figure, states are at Level 0

Leaf nodesLowest points in a hierarchy

Number

Description

Ancestor

Parent

Child

194 Interactive Reporting

Number

Description

Descendent

Attributes
n addition to dimension member names, locations, and relationships, Essbase stores
characteristics, called attributes, about members. For example, the Product dimension indicates
that in Women's Apparel, Shirts and Blouses, there is a cotton T-shirt; an attribute indicates that
the cotton T-shirt is red, cyan, lime, or pink. Essbase does not store data for attribute dimensions
as part of the multidimensional database but instead dynamically calculates it upon request.
Attribute dimensions are displayed in dimension hierarchies, in the same manner as other
dimensions, despite their data being stored differently.

Catalog List
The Catalog List displays one or all dimensions in a tree model. The tree can be expanded to
display additional members, but generations are not included in the hierarchy. For cubes with
many members in a dimension, paging facilitates navigation. The number of members that can
be displayed in the Catalog and Member Selection is defined in the Number of members to
display option in Query Options. The default is 50.

To display the Catalog in single-dimension mode, select a dimension from the Dimension
Selection.
To expand the tree to display additional members in the dimension hierarchy, next to the
dimension, click + .

To display the Catalog in all dimension, click

OLAPQuery and CubeQuery Data Layout Differences


OLAPQuery is the pre release 9.3 section used to query a multidimensional database. The data
layout tool in OLAPQuery and CubeQuery have these differences:
OLAPQuery Data Layout

CubeQuery Data Layout

Slicer

Filters

Side

Rows

Top

Columns

Filters from multiple members may be selected and applied from a


single hierarchy.

One filter member can be selected per dimension. Filters for multiple
members within the same dimension are not supported.

CubeQuery Section 195

OLAPQuery Data Layout

CubeQuery Data Layout

Measures are treated as distinct dimensions and can be placed only


in the Facts pane of the data layout.

Measures can be placed in the Row, Column, and Filter panes of


the data layout.

Member selection in the data layout is unavailable.

Member selections in the Row, Column and Filter panes of the data
layout can be edited in the Member Selection dialog box.

Shortcut menu enables access to the Filter dialog box and Remove
option.

Shortcut menu enables access to Remove option, Member


Selection dialog box, Variable option and Filter option

Building a CubeQuery
Before you can build a CubeQuery section, you need a published Interactive Reporting database
connection file (.oce), and an Interactive Reporting document file (BQY).

To import a published Interactive Reporting database connection file (.oce):


1

In Explore, select File, and then Import File.

Select Browse, navigate to the folder where the Interactive Reporting database connection file is located,
and click Open.

The File field is populated with the Interactive Reporting database connection file name.

Click Next.

The OCE Properties Import dialog box is displayed.

Specify a user name and password, and any appropriate data source access settings.

Click Finish.

To import an Interactive Reporting document file (BQY):


1

Select File, and then Import.

Click Browse, navigate to the folder where the Interactive Reporting document file (BQY) is located, and
click Open.

The File field is populated with the Interactive Reporting document file name.

Click Next.

The Interactive Reporting Properties Import dialog box is displayed.

Specify a connection option in the Apply Option to All Queries field

Select an Interactive Reporting database connection file (.oce) to associate with the Interactive
Reporting document file in the Query/DataModel Connection drop-down, and specify an user name and
password.

Click Finish.

196 Interactive Reporting

To create a new CubeQuery section based on a previously published Interactive Reporting


document file (BQY):

In Explore, select an Interactive Reporting document file (BQY) that contains a CubeQuery section.

Enter your name in the Host Name field and password in the Host Password field and click OK.

Select Actions, then Insert, and then Query.

Check Existing Essbase Connection to select the current Interactive Reporting database connection
file (.oce), or select another from the drop-down and click OK.

A new Interactive Reporting document file is created.

To populate the Catalog List, select Actions, then Retrieve Dimensions.

The Catalog List shows the dimensions available to add to the query.

If prompted, enter your database user name and password in the DB User Name and DB Password
fields and click OK.

From the Catalog List, select a dimension.

To toggle the Catalog List between single and all dimension modes, click

In the Catalog List, select a member dimension and select Query, then Add to Rows or Query , then
Add to Columns.
Note: Members from the same dimension cannot be split across columns, rows and filters.

In the Catalog List, select a measure dimension and select Query, then Add to Rowsor Query, then Add
to Columns.

10 To filter a member, select a member in the Catalog List and select Query, then Add to Filters.
11 Click Process.
Note: If missing values are not displayed, it is possible that the Suppress Missing and

Suppress Zero options are enabled. These options are enabled by default and can be
disabled in the Query Options

DB Logon
Use the DB Logon dialog box to specify the database name and password used to logon to the
Essbase database.

To specify the database logon, enter the database user name in the DB User Name field, and
database password in the DB Password and click OK.
Your database administrator retains a list of all valid logon names and passwords.

CubeQuery Section 197

Searching Members
Member search is available for member names, aliases or both in one or more dimensions from
the Catalog List. If the Catalog List shows members in single dimension mode, the Search is
performed on a selected dimension. If all dimensions are displayed, Search is performed on all
dimensions.

To search members from the Catalog List:


1

Select to search by name, alias, or both.

Enter the text on which to search.

If you use wildcards in searches, only trailing wildcards are accepted (for example, Cola*),
and not leading wildcards (for example, *-10).
The ?? (placement position) is a valid search criteria. The ? substitutes one occurrence of a
character; and can be placed anywhere in the string.

Click

The search results are displayed in the Catalog List, and they can be added to the data layout.

To close Search, select

The Search results are cleared.

Member Selection
An Essbase database may contain hundreds or even thousands of members. Use the Member
Selection Browse and Search tabs to refine query member criteria for a selected dimension. The
Member Selection dialog box includes dynamic selection functions such as children,
descendants, bottom, siblings, or subsets (UDA, Attribute Dimensions, Level and Generation).
The Available pane lists the member hierarchy for the selected dimension. An additional node
for substitution variables lists substitution variables for all dimensions; however, if they are
selected from another dimension, an error appears when adding the substitution variables to
the Selected pane.
The Selected pane lists all member selections. Selections can be a single member or a dynamic
selection function (for example, children).
Icon

198 Interactive Reporting

Dynamic Function

Description

Member

Currently selected member

Children

Children of the selected member (one level below)

Descendants

Descendants of the selected member

Icon

Dynamic Function

Description

Bottom

Descendants of the selected member on the lowest level of


the hierarchy (Level 0)

Siblings

Members on the same level with the same parent as the


selected member

Same Level

Dimension members on the same level as the selected


member

Same Generation

Dimension members on the same generation as the selected


member

Browsing Members
Use the Member Selection Browse tab to navigate through and select individual members to
include in the query.

To browse and select members:


1

In the data layout, on the shortcut menu, select a dimension member and select Edit.

The Member Selection dialog box is displayed.

Select Browse.

Select a member and click + to the left of the member name to expand it.

To include an individual member in the query, select the member in the Available pane and click

The member is added to the Selected pane.

To include a dynamic function, on the shortcut menu, select the member in the Available pane and
select the function from the submenu:
l

Member

Children

Descendants

Bottom

Siblings

Same Level

Same Generation

Disable or Enable (selected members only)

Click OK.

To change the member function in the Selected pane:


1

Select the member to modify.

CubeQuery Section 199

Use Shift + click to select multiple and consecutive items. Use Ctrl + click to select multiple,
but nonconsecutive items.

To include or exclude a member (for example, Member+Children versus Children), select the check
box next to the member name.

Click OK.

To clear an item used in the query without removing it from the Selected pane:
1

Select the item and choose Disable from the shortcut menu.

Click OK.

To remove a member or member element:


1

Select the member in the Selected pane and click

Use Shift + click to select multiple and consecutive items. Use Ctrl + click to select multiple,
but nonconsecutive items.
The member is moved from the Selected pane.

Click OK.

To remove all members and member elements, select

The Selected pane is depopulated.

To toggle between including or excluding a member:


1

Select a member in the Selected pane.

Select Disable to exclude a member, or Enable to include a member.

Substitution Variables
Substitution variables define global variables that represent Essbase-specific values. For example,
CurMonth can be a substitution variable for displaying the latest time period. Rather than
constantly updating queries when a value changes, you change only the value for the substitution
variable on the server. Essbase creates substitution variables, but you can specify a substitution
variable when selecting members.

To add a substitution variable:


1

Select a member in the data layout and select Edit on the shortcut menu.

The Member Selection dialog box is displayed.

Select Browse.

In the Available pane click + to expand the Substitution Variable node.

To include a substitution variable, select the member in the Available pane and click

200 Interactive Reporting

To include a dynamic function on a substitution variable, on the shortcut menu, select the member in
the Available pane and select the desired function from the sub-menu:
l

Member

Children

Descendants

Bottom

Siblings

Same Level

Same Generation

Select Next/Previous

Subsets

Click OK.

Variables
A variable is a constraint placed on the query when the query is processed.

To use all selected members as a variable (the user is prompted for the values when the query
is processed:

In the data layout, select a dimension member and select Edit on the shortcut menu.

Select Use as variable.

Click OK.

Searching Members
To search for members:
1

In the data layout, right click a dimension and select Edit.

Select Search.

From the Member Type, select the type of member to search:


l

NameMember Name

AliasAlternate Names for database members

BothMember Name and Alias Name

Note: To search on alias names, enable the Use Alias Tables option and select an alias table

in Query Options.

Enter the text string or numeric value to search (a member name or pattern).

Trailing asterisks and wildcard strings are acceptable. Examples of value text strings: Ja*, M?
n, and M??n. Examples of invalid text strings: *-10 and J*n.
CubeQuery Section 201

To locate all member within the selected dimension that matches the text string or numeric value, click
.

The results of the search populate the Available pane.

Optional: To add a member to the Selected pane, click

Click OK.

Filter Member Selection


All data object intersections are relative to filter member selections, which focus intersections
and data values, and, consequently, analysis. Filter-axis dimensions are by default represented
by the highest aggregate member defined in the data source. To focus analysis on members other
than the highest aggregate, you can select one filter member per dimension. Filter member
selections do not rearrange dimensions or reorganize pages but focus analysis on intersections.
Use Filter Selection tabs to navigate through, search, or select the members to use in a filter
definition.

Browsing Filter Members


Use the Filter Selection Browse tab to navigate through and select individual members to use as
a filter.

To browse and select members:


1

In the Filter pane of the data layout, select a dimension member and select Edit on the shortcut menu.

The Filter Selection dialog box opens.

Select Browse.

Select a member and click + to the left of the member name to expand it.

To include a member as a filter in the query, in the Available pane, select the member and click

The member is added to the Selected pane.

To include a member as a dynamic function, in the Available pane, select the member and select
Member on the shortcut menu.

Click OK.

Searching Filter Members


Use the Search tab of Filter Selection dialog to search for members within selected dimensions.
Note: Only the member names and aliases are displayed and not the fully qualified name (for

example, [West].[Salem]) in the Member Selection, Catalog or query results.

202 Interactive Reporting

To search for members:


1

In the Filter pane of the data layout, right click a member and select Edit.

Select Search

From the Member Type, select the type of filter member to search:

NameMember Name

AliasAlternate Names for database members

BothMember Name and Alias Name

Type the text string or numeric value to search in the text box.

Trailing asterisks and wildcard strings are acceptable. Examples of value text strings: Ja*, M?
n, and M??n. Examples of invalid text strings: *-10 and J*n.

Click
value.

to locate all members within the selected dimension that match the text string or numeric

Hovering the mouse over an item in the Location column shows a tooltip with the member's
full location path.
The results of the search populate the Available pane.

Optional: To add a member to the Selected pane, click

Click OK.

Note: To add a different member as a filter, first remove the selected member.

Note: A Search by Alias name searches the currently selected Alias Table in Query Options

when the Use Aliases option is enabled.

Navigating CubeQuery
For navigating and maintaining data in the CubeQuery section, see:
l

Keep Only

Remove Only

Suppressing Missing and Zero Values

Drilling

Drilling to Shared Members

Keep Only
Focuses one member by allowing you to clear all other dimension member selections except the
selected member from the results set. Non-kept members are not available on the Member
Selection dialog box.

CubeQuery Section 203

To keep specific set members:


1

Select one member or a range of members.

Use Ctrl + click to keep nonadjacent cells.

Select a dimension label and select Keep Only on the shortcut menu.

Only the selected members are shown.

Remove Only
Clears a dimension member to remove it from the query result set. At least one member must
be retained to use this feature. Removed members are not included in the results set, but display
on Member Selection dialog box as excluded from the query (flagged with a - or minus sign).
To add a member again to the query, the exclusion must be removed from the Selected pane.

To remove a selected member:


1

Select one member or a range of members.

Use Ctrl + click to remove nonadjacent cells.

Select a dimension label and select Remove Only on the shortcut menu.

The member is removed from the report and the query. To add the member to the query
again, add it from the Catalog to the data layout, or select it on the Member Selection dialog
box.

Suppressing Missing and Zero Values


Suppressing missing and zero values in rows and columns prevents irrelevant information from
being returned, reduces network traffic, and increases query speed. Query options box enables
you to customize how CubeQuery handles missing and zero values, including the text label
displayed for these values by default.

To suppress missing values in rows, select a row and select Suppress, then Missing rows on
the shortcut menu.
By default missing values are blank.

To suppress missing values in columns, select a column and select Suppress, then Missing
columns on the shortcut menu.

To suppress zero values in rows, select a row and select Suppress, then Zero rows on the
shortcut menu.
By default zero values are shown as 0 (zero).

204 Interactive Reporting

To suppress zero values in columns, select a column and select Suppress, then Zero
columns on the shortcut menu.

Drilling
Drilling increases or decreases the display of report detail for dimensions with large amounts of
level data. It can consist of drilling down (in many forms) or drilling up. Drilling down retrieves
more detailed data within a dimension. You can drill down into more detailed data until the
lowest level of a dimension as defined in the database outline is reached.
A before and after drill down example is shown below:
Before drilling:

After drilling:

In this example, for Oct, you can drill down to Audio and Visual. Drilling up is the opposite of
drilling down, where you move up the hierarchy within a dimension to less detailed data. Query
Options enables you to customize the behavior of the drill level. Shortcut menus also control
the drill levels.
Note: You cannot drill down on a Date Time Series member.

To drill down to more detail:


1

Select the member.

Double-click the member to drill down using the default Drill Level as defined in Query Options.
Tip: You can also select a member, and select Drill. then Down to drill down using the default

drill level defined in Query Options on the shortcut menu.


Additional drill down options include:
l

DownDrills down to more dimension detail using the default drill level defined in
Query Options.
UpDrills up to less dimension detail.

CubeQuery Section 205

NextDrills down to the children. This is the default Drill Level. For example, a drill
on Year retrieves Qtr1, Qtr2, Qtr3, and Qtr4.
BottomDrills down to the lowest level of members in a dimension. For example, a
drill on Year retrieves Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, and Dec.
All DescendantsRetrieves data for all descendants. For example, a drill on Year
retrieves all quarterly and monthly members.
SiblingsRetrieves data for siblings. For example, a drill on Jan retrieves Jan, Feb, and
Mar.
Same LevelRetrieves data for all members at the same level. For example, a drill on
Sales might retrieve values for COGS, Marketing, Payroll, Misc, Opening Inventory,
Additions, Ending Inventory, Margin %, and Profit %.
Same GenerationRetrieves data for all members of the same generation as the selected
member or members. For example, a drill on Sales retrieves COGS, Marketing, Payroll,
and Misc.

Sample Drill Through To Relational


The sample below shows the drill through feature applied to a CubeQuery with multiple
dimensions in the rows.
The initial CubeQuery section includes:
Rows
Jan, Feb, March
100 (children)
200 (children)
Columns
East (children)
100 (children)
200 (children)
Filters
Sales

206 Interactive Reporting

The relational section includes:

CubeQuery Section 207

The initial results of the relational query are:

The following topic mappings are defined for the drill through:
Table 48

Mapping of Relational topics to OLAP Dimensions for Drill Through

Relational

OLAP

Details.State

Market

Details.Product

Product

Details.Month

Year

When the context of New York is 100-10, and Jan. is passed in the CubeQuery, these results are
displayed in the relational query:

208 Interactive Reporting

Drilling to Shared Members


You can drill down or drill up on a member that has a shared member defined in the Essbase
outline. Essbase determines which members are eligible the base member or the shared
member, and returns drilled or stored members based on the drill path.
This is an Essbase outline:
Product
100
150 (stored member)
100-10
100-20
Brand1
150 (shared member)
The stored member 150 has children; the shared member 150 does not. Drilling up and down
on 150 gives different results:
l

Drilling down on 150 returns nothing if it is interpreted as the shared member; or, returns
100-10 and 100-20 if it is interpreted as the regular member.
Drilling up on 150 returns Brand1 if it is interpreted as the shared member; or returns 100
if it is interpreted as the regular member.

The proximity of the shared member to the regular member gives different results when drilling
down. When drilling up on a member that has a shared member, Analytic Server looks at the
members to determine which one is being queried. For example, drilling up on 100-20 sometimes
returns Diet and returns 100. depending on whether Diet or 100 is closest to the member 100-20.
If 100-20 is alone, then Essbase determines that this is the regular member. If Diet is closer, then
100-20 may be interpreted as the shared member.

Drill Through
The Drill Through feature enables users to drill from a data cell or meta data label in a CubeQuery
section to an existing relational query section within the same Interactive Reporting document

CubeQuery Section 209

file. In CubeQuery, drill through blue indicators may have been enabled to indicate data cells
and metadata labels where drill can be executed. The indicators are displayed for the top/left cell
or member label because all data cells and all member labels in a dimension can be drilled on.
Drill Through has these characteristics:
l

Essbase dimensions are mapped to the target relational fields, so that the member context
in the Essbase query can be passed to the relational query as a filter. Drill through to fact
items is not available because facts are defined in the relational query section only.

Drill Through be accomplished at any level of Essbase members in the hierarchy.

You can drill a to new or existing Results section.

To execute a drill through:


1

Select a single cell or member label and select Actions, then Drill through.

A Drill through can only be performed on one label or cell at a time. If multiple metadata
labels and/or cells are selected, the option to drill through is not be available .
The Drill to Results dialog box is displayed.
This dialog box is only displayed if the option Existing Results was selected when the Drill
Through option was defined. You are prompted to enter a user name and password to the
relational query.
By default there are new results, and the dialog box is not shown.

Select the target Results section and click OK.

Using Swing
Use the Swing feature to swap dimensions between rows and columns from the query. This
feature enables you to view your data in new ways, and easily compare the new data to data in
the originating table. You swing dimensions by dragging the dimension headers (either column
or row) from one position to another using the swing handles. By default swing handles are
transparent. They only appear when you select a dimension header. When the swing handle
appears, it is shown in white with a light grey handle. Once the selection is off, the handle is
transparent again.

To swing a dimension column:


1

Select a dimension column header (number 1 below) by clicking on the border to the left of the header.

The swing handle (number 2 below) is displayed to the right of the rows. In this example
the Scenario dimension header is selected.

210 Interactive Reporting

Select the swing handle and drag it to the new position (left/bottom or right/top).

In the example, the handle has been swung downward and to the left of the Product
dimension:

As a result, the Scenario dimension is positioned to the left of the Product dimension:

CubeQuery Section 211

To swing a row dimension:


1

Select an entire dimension row header.

The swing handle is displayed at the bottom of the query:

212 Interactive Reporting

Select and drag the swing handle to the new position (left/right or right/top).

In this example the handle is swing to the right and upward of the query:

CubeQuery Section 213

The result of the swing is:

Note that the Product dimension is positioned under the Year dimension.

Downloading to Results
Download to Results is an instrument for rendering a flat table representation of the multidimensional Essbase data cubes in Interactive Reporting. The data is loaded into a Result section
of Interactive Reporting document, and can be used for further analysis, report creation and
joining with data from other relational data sources. In this case the data processing (e.g.
aggregation, totaling, custom calculations, table joins) is performed on the Interactive Reporting
side.
By default Download to Results creates separate columns in the results set for every generation
in every dimension. In addition, only the lowest level member values are imported, with any
ancestors for each member (included in the original query) appearing in additional columns.
In the following example, separate columns appear for the two Product member Generations

214 Interactive Reporting

from the query. Only the lowest level Product members data are in the query. Data for the upper
level Product members is not included:

The Results set can be integrated with the Chart, Table, and reporting sections.
Results are only updated when you select the Download to Results feature, or when you take the
downloaded results set and process the results again.
If you expect the query to retrieve a small to medium sized data set, it is recommended that you
enable the automatic download feature from the Query, then Tools, then Options, then Program
Options, then OLAP, and then Auto Generate Results When Processing OLAP Query. If you
choose this option, the Results set is not created for the current CubeQuery section, but only
for new CubeQuery sections. In some circumstances when querying large amounts of data, the
automatic creation of a Results section may result in a slight reduction in query performance.
Note: Shared members can be excluded from the query by way of Query Options, however there

are some cases where customers might want to include Shared Members in the query and
results set, but not in the totals. If you want to include shared members in the results set,
the parent context needs to exist in the query. In other words, if a shared members parent
does not exist in the query, Download to Results does not recognize that it is a shared
member.
Note: If you open an Interactive Reporting version 11.1.1 document that contains data in Results

downloaded from a CubeQuery with version 9.3.1, the existing Results data is not visible.
Furthermore, using the download to results feature with an Interactive Reporting
document created with Interactive Reporting version 11.1.1, the result set is not be the
same as it was with version 9.3.1.

CubeQuery Section 215

To download the query to results, select Query, then Download to Results.


The behavior of Download to Results varies for different components in CubeQuery:
l

Separate Columns for Metadata Labels on page 216

Measure Behavior in Columns and Rows on page 217

Ragged Hierarchies on page 218

Shared Members on page 220

Separate Columns for Metadata Labels


Separate columns for metadata labels are displayed for each Essbase generation in the hierarchy.
Table 49

CubeQuery Requested Items (Profit Member Applied In the Filter)

Product

Qtr1

Qtr2

Qtr3

Qtr4

Cola

5096

5892

6583

5206

Diet Cola

1359

1534

1528

1287

593

446

400

544

7048

7872

8511

7037

Old Fashioned

1697

1734

1883

1887

Diet Root Beer

2963

3079

3149

2834

Sarsaparilla

1153

1231

1159

1093

Birch Beer

908

986

814

1384

6721

7030

7005

7198

Caffeine Free Cola


Cola

Root Beer
Table 50

Results Set

Category

Product SKU

Year

Profit

Colas

Cola

Qtr1

5096

Colas

Diet Cola

Qtr1

1359

Colas

Caffeine Free Cola

Qtr1

593

Root Beer

Old Fashioned

Qtr1

1697

Root Beer

Diet Root Beer

Qtr1

2963

Root Beer

Sarsaparilla

Qtr1

1153

Root Beer

Birch Beer

Qtr1

908

If only one generation of the hierarchy is in the query, additional columns do not show the parent
members in the Results section as shown below:
216 Interactive Reporting

Table 51

CubeQuery Requested Items (Profit Member is in the Columns)


Qtr1

Qtr2

Qtr3

Qtr4

Profit

Profit

Profit

Profit

Cola

5096

5892

6583

5206

Diet Cola

1359

1534

1528

1287

593

446

400

544

Old Fashioned

1697

1734

1883

1887

Diet Root Beer

2963

3079

3149

2834

Sarsaparilla

1153

1231

1159

1093

Birch Beer

908

986

814

1384

Dark Cream

2544

3231

3355

3065

Caffeine Free Cola

Table 52

Results Set

Product SKU

Quarter

Profit

Cola

Qtr1

5096

Cola

Qtr2

5892

Cola

Qtr3

6583

Cola

Qtr4

5206

Diet Cola

Qtr1

1359

Diet Cola

Qtr2

1534

Diet Cola

Qtr3

1528

Diet Cola

Qtr4

1287

Caffeine Free Cola

Qtr1

593

Caffeine Free Cola

Qtr2

446

Caffeine Free Cola

Qtr3

400

Caffeine Free Cola

Qtr4

544

Measure Behavior in Columns and Rows


In the CubeQuery section, the measure dimension is handled like any other dimension (it can
be placed in rows or columns), but a separate results set column is created for each Measure
member, whether it is in a row, column, or filter.

CubeQuery Section 217

Table 53

Measures in CubeQuery
Qtr1

Sales

Cola

COGS

Table 54

Qtr2
14585

16048

Diet Cola

7276

7957

Cola

5681

6136

Diet Cola

3496

3871

Caffeine Free Cola

1493

1606

Measures in Results Set

Product SKU

Quarter

Sales

COGS

Cola

Qtr1

14585

5681

Diet Cola

Qtr1

7276

3496

Caffeine Free Cola

Qtr1

3187

1493

If no Measures are in the row, column or filter, all data values appear in a Value column.
Table 55

Values Column in Results Set

Product SKU

Quarter

Value

Cola

Qtr1

14585

Diet Cola

Qtr1

7276

Caffeine Free Cola

Qtr1

3187

Ragged Hierarchies
Typically in Essbase, an individual hierarchy has the same number of members above it as any
other member at the same level. In a ragged hierarchy, the logical parent member for one member
is not in the level directly above the member. When downloading to results a query that has a
ragged member selection, and where some parent members are not expanded to details, a
warning message is displayed: "Note that if the source query results are not fully expanded and/
or symmetric, invalid flattened results might be returned." This message is necessary to show
parent context or shared member parents need to exist in the query in order to determine that
they are shared for the results set.
In the following example Qtr2 does not have children in the query. Because only the lowest level
members are included in the query, the results set includes: Jan, Feb, Mar, and Qtr2. For the
month value for Qtr2, the label is blank.

218 Interactive Reporting

Ragged Hierarchy in CubeQuery Section

Table 56

Product
Jan

8024

Feb

8346

Mar

8333
Qtr1

24703

Qtr2

27107

Ragged Hierarchy in Results Set

Table 57

Quarter

Month

Gen1,Product

Value

Qtr1

Jan

Product

8024

Qtr1

Feb

Product

8346

Qtr1

Mar

Product

8333

Qtr2

(blank)

Product

27107

If a child member does not have a parent member in the original query, the parent or any other
ancestor is included in the Results set:
Ragged Hierarchy in CubeQuery Section

Table 58

Product
Jan

8024

Feb

8346

Mar

8333

Qtr1

24703

Dec

8780

Table 59

Ragged Hierarchy in Results Set

Quarter

Month

Gen1,Product

Value

Qtr1

Jan

Product

8024

Qtr1

Feb

Product

8346

Qtr1

Mar

Product

8333

Qtr4

Dec

Product

8780

CubeQuery Section 219

Shared Members
Shared member data can be included in a query, or their totals can be excluded. Each shared
member column in the Results set corresponds to an Essbase Generation/Field in the Results set
and query. For Shared Members, the parent context must exist in the query. In other words, if
the parent of a shared member is not in the query, the Download to Results feature does not
recognize that it is a shared member and determines the parent . That is, the parents of a shared
member must exist in the query in order to determine that they are shared for the results set.
For example, in the Sample Basic Product dimension, for the second instance of 100-20 (shared
member) to be properly accounted for in the Download to Results, its parent Diet must be
included in the query such as Diet (Children).
Note: Shared members are in bold below.

Table 60

Shared Members in CubeQuery Section


Qtr1

10010

5096

10020

1359

10030

593

100

7048
20010

1697

20020

2963

20030

1153

20040

908

200

6721
30010

2544

30020

690

30030

2695

300

5929
40010

2838

40020

2283

40030

116

400

5005
10020

1359

220 Interactive Reporting

Qtr1
20020

2963

30030

2695

Diet

7017
Product

Table 61

24703

Shared Members in Results Set

Product SKU, Shared

Gen1, Product

Category

Product SKU

Quarter

Value

Product

100

10010

Qtr1

5096

Product

100

10020

Qtr1

1359

Product

100

10030

Qtr1

593

Product

200

20010

Qtr1

1697

Product

200

20020

Qtr1

2963

Product

200

20030

Qtr1

1153

Product

200

20040

Qtr1

908

Product

300

30010

Qtr1

2544

Product

300

30020

Qtr1

690

Product

300

30030

Qtr1

2695

Product

400

40010

Qtr1

2838

Product

400

40020

Qtr1

2283

Product

400

40030

Qtr1

116

10020

Product

Diet

10020

Qtr1

1359

20020

Product

Diet

20020

Qtr1

2963

30030

Product

Diet

30030

Qtr1

2695

If multiple generation dimensions have shared members, one shared indication per dimension
is created:
Note: Shared members are in bold below.

CubeQuery Section 221

Table 62

Multiple Dimensions with Shared Members in CubeQuery Section


Qtr1

Actual

10010

5096

10020

1359

100

7048
10020

1359

Diet
Budget

7017
10010

6510

10020

2240

100

9790
10020

2240

100

9790
10020

2240

Diet
Actual

8910
10010

5096

10020

1359

100

7048
10020

1359

Diet

Table 63

7017

Multiple Dimensions with Shared Members in Results set

Scenario, Gen2, Shared

Scenario, Gen2

Category

Product SKU

Quarter

Value

Actual

100

10010

Qtr1

5096

Actual

100

10020

Qtr1

1359

Diet

10020

Qtr1

1359

Budget

100

10010

Qtr1

6510

Budget

100

10020

Qtr1

2240

Diet

10020

Qtr1

2240

Actual

Budget

Product SKU, Shared

10020

10020

Actual

Actual

100

10010

Qtr1

5096

Actual

Actual

100

10020

Qtr1

1359

222 Interactive Reporting

Scenario, Gen2, Shared

Scenario, Gen2

Product SKU, Shared

Category

Product SKU

Quarter

Value

Actual

Actual

10020

Diet

10020

Qtr1

1359

If a dimension contains shared members at multiple generations, a column is added to the Results
set for each CubeQuery generation and Results set column:
Note: Shared members are in bold below.

Table 64

Shared Members At Multiple Generation Level in the CubeQuery Section


Qtr1

10010

5096

10020

1359

10030

593

100

7048

...
40010

2838

40020

2283

40030

116

400

5005
10020

1359

20020

2963

30030

2695

Diet

7017

400

5005

Product

Table 65

24703
Shared Members at Multiple Generation Level in the Results Set

Category, Shared

Product SKU, Shared

Gen1, Product

Category

Product SKU

Quarter

Value

Product

100

10010

Qtr1

5096

Product

100

10020

Qtr1

1359

Product

100

10030

Qtr1

593

...

CubeQuery Section 223

Category, Shared

Product SKU, Shared

Gen1, Product

Category

Product SKU

Quarter

Product

400

40010

Qtr1

2838

Product

400

40020

Qtr1

2283

Product

400

40030

Qtr1

116

10020

Product

Diet

10020

Qtr1

1359

20020

Product

Diet

20020

Qtr1

2963

30030

Product

Diet

30030

Qtr1

2695

Product

400

Qtr1

5005

400

Download Database Totals


The Download Database Totals feature creates only one column per dimension, and includes
all members, and the corresponding data, in the Results set. In addition, a column with each
dimensions parent members is also included in the results. By default this option is disabled.
Once this option is enabled, any existing Results set is deleted. If this option is enabled through
Tools, then Options, then Program Options, then OLAP, then the option is enabled also in a
newly created CubeQuery section.
Note: If you use the Download to Results feature, only separate columns in the Results set are

created for every generation in every dimension. In addition, only the lowest level member
values are imported, with any ancestors for each member (included in the original query)
appearing in additional columns.
In the following example:
l

All Product members in the query, are listed in only one column and not separated into
multiple columns based on Generation. In addition, the data values for the upper level
Product members are also included in the results.
Each dimension has an additional column that displays parent members for each member
in the query.
m

The Year dimension members Qtr1, Qtr2, etc. have their parent member (Year)
displayed in the Year Parent column.
The Scenario dimension members Actual and Budget have their parent member
(Scenario) displayed in the Scenario Parent column.
The Product dimension members have their respective parent members displayed in the
Product Parent column.

224 Interactive Reporting

Value

Note: If you open an Interactive Reporting version 11.1.1 document that contains data in Results

downloaded from a CubeQuery with version 9.3.1, the existing Results data is not visible.
Furthermore, using the download to results feature with an Interactive Reporting
document created with Interactive Reporting version 11.1.1, the result set will not be the
same as it was with version 9.3.1.

To enable download database totals:


1

Select Query. then Query Options

The Query Options dialog box is displayed.

Select the Global tab.

Enable Download Database Totals and click OK.

Relational Aggregation
When selecting Download Database Totals, aggregations are disabled for all the sections
dependent on the Results with database totals. This feature protects users from performing
aggregations, where the results maybe double counted. Enabling the option Allow Relational
Aggregation allows usage of aggregation in the following sections:
l

Break/Grand Totals in Results section

Data Functions, Totals, Cume in Pivot

Data Functions in Chart

Data Functions, Break Totals, Show Column Totals in Report.

CubeQuery Section 225

To set relational aggregation:


1

Select Query Options, then Global.

Enable Allow Relational Aggregation and click OK.

Formatting CubeQuery Items


Common formatting options are available for CubeQuery items on the Format and shortcut
menus including:
l

Auto-size WidthBy default columns and rows are distributed evenly and without regard
to the length of data values, which may be truncated. With the auto-size width feature, you
can automatically size any column or rows horizontally to fit the text of the largest value in
the column.
Auto-size HeightBy default columns and rows are distributed evenly and without regard
to the length of data values, which may be truncated. With the auto-size height feature, you
can automatically size any column or rows vertically to fit the text of the largest value in the
column.
Number FormatOptions for changing the way numbers, currency values, and dates are
displayed throughout or create new custom formats. See Number Formatting
.

To auto-size the width of a row or column, select the row or column label and choose AutoSize Width.

To auto-size the height of a row or column, select the row or column label and choose AutoSize Height.

Query Options
Use the Query Options to define global and local display behavior and drill options. The Query
Options dialog box comprises the Global, Display, and Drill tabs.

To display query options, select Actions, and then Query Options.

Global Options
Use the Global tab to set global display behavior in the CubeQuery section.

Design Options

Description

Auto-Refresh Query

Queries the database automatically when an item is added to or removed from the data layout, or when the
Suppress and Replace options in Query Options are changed. If Auto-Refresh is disabled, you must click Process
to query the database whenever you make a change in the data layout.

226 Interactive Reporting

Catalog Display Options

Description

Number of members to
display

Sets the maximum number of members to display in the Catalog List and Member Selection. The number
can be:
l

unlimited

10

20

50

100

250

500

The default number of members is 50. In both the Catalog List and Member Selection, the more node
expands to the next set of members.

Results Options

Description

Download Database Totals

Download Database Totals creates only one column per dimension, and includes all members, and the
corresponding data, in the results set. In addition, a column with each dimensions parent members is
included. By default this option is disabled.

Allow Relational Aggregation

Enables relational aggregation in the following sections:


l

Break/Grand Totals in Results section

Data Functions, Totals, Cume in Pivot

Data Functions in Chart

Data Functions, Break Totals, Show Column Totals in Report.

When the Download Database Totals option (see above) is enabled, aggregations are disabled for all the
sections dependent on the Results sets with database totals. This option protects users from performing
aggregations, where the results may be counted twice. By default this option is disabled.
Include Consolidation
Information

Enabling this option includes consolidation type/unary operator information of all members from the Data
Layout when Download To Results is executed. Disabling the option excludes the consolidation type/unary
operator information for each member. By default this option is disabled for newly inserted CubeQuery
sections.

Display Options
Use the Display tab to set row and column suppression criteria, alias information, replacement
values, , and label indentation.
Suppress

Description

#Missing Rows

Suppress the return of data rows that contain only missing values. If one value is in the row, the row is not suppressed.
By default, this option is enabled.

Zero Rows

Suppress the return of data rows that contain only zeros. By default this option is disabled.

Shared Members

Suppress the return of members tagged as shared. By default, this option is disabled.

CubeQuery Section 227

Suppress

Description

#Missing Columns

Suppress the return of data columns that contain only missing data. By default this option is enabled.

Zero Columns

Suppress the return of data columns that contain only zeros. By default this option is disabled.

Aliases

Description

Use Aliases

Display aliases when performing database retrievals rather than database member names. Aliases are alternate
names for database members. You can retrieve data that uses the database name, which is often a stock number
or product code, or an alias, which can be more descriptive.
When this setting is updated, this message is displayed: The OLAP Tree will be updated automatically with new
Alias information and the OLAP Query will be re-processed.

Select an Alias
Table

Specify the alias table to use for alias names. Each database can contain one or more alias tables.

Replacement

Description

#Missing Label

Specify a label for missing values. For example, you might enter:
#Missing
By default, the replacement value for a missing label is blank.

#NoAccessLabel

Specify a label for values from the Essbase cube to which a user does not have security access. For example, you
might enter:
NoAccess

Zero Label

Table 66

Specify a label for zero values. By default the replacement value for a zero label is blank.

Label Indentation

Option

Description

Indent Each
Generation By

Select the number of characters by which each generation in the hierarchy is indented. For example, you can change
the following indentation from 1 to 3. This option can take options from 0 to 25.
indentation at 1:
10010
10020
10030
100
indentation at 3:
10010
10020
10030
100

228 Interactive Reporting

Drill Options
Use the Drill tab to define the next level of data displayed when you drill down in a CubeQuery.
Additionally, the Member Retention option group contains items that enable you to customize
drilling retention characteristics.

Drill
Level

Description

(Drill
Level
dropdown)

Defines the next level of data displayed when you drill down from the Query menu, or when you double click a member. Any
drill down selection made from the shortcut menu overrides the selection made here. For example, if you select Bottom Level,
data for the lowest level of members in a dimension is retrieved. A drill-down on Year retrieves: Jan, Feb, Mar, Apr, Ma, Ju,
Jul, Aug, Sep, Oct, Nov, and Dec.
Valid drill down levels are:
l

Next Level

Bottom Level

All Descendants

Sibling

Same Level

Same Generation

Member Retention

Description

Include Selection

Retains the selected member along with the other members retrieved as a result of a drill down. For example,
if you drill down on Qtr1, the data for Jan, Feb, and Mar, as well as Qtr1, is retrieved. When this option is
disabled, the data for only for Jan, Feb, and Mar, is retrieved: Qtrl is eliminated. By default this option is
enabled.

Within Selected Group

Applies (drilling) to only the group of members in which the selection is made. By default this setting is
disabled. It is meaningful only when the report contains two or more dimensions of data down a report as
rows or across a report as columns. This type of report is considered asymmetric, which is characterized
by groups of nested members that differ by at least one member.

Remove Unselected Groups

Removes all dimension groups that are not in the selected group.

Launching Smart View from CubeQuery


A CubeQuery section can be exported to Smart View which is a centralized interface which
enables simultaneous use of multiple Oracle Hyperion products, and improves integration with
Microsoft Office. You can export a CubeQuery section to Microsoft Excel as query-ready HTML.
When you export content as query-ready HTML, the current page of the current CubeQuery
section is converted to HTML and Hyperion-specific formatting is removed. This enables you
to re-query the data source independent of the Web application.For more information about
exporting a CubeQuery with , see Oracle Hyperion Smart View for Office User's Guide.
Note: You cannot export content as query-ready HTML to a Firefox browser.

CubeQuery Section 229

To launch Smart View from a CubeQuery section, select Actions, then Launch Smart View.
For more information about using CubeQuery inSmart View, see Oracle Hyperion Smart View
for Office User's Guide.
For more information about using CubeQuery inOracle Hyperion Smart View for Office,
seeOracle Hyperion Smart View for Office User's Guide.

Dashboards
The Dashboard section is a streamlined, push button approach to querying a database.
Dashboards are ideal for users who do not have the time to build a query or design a report
section. Up to the minute thumbnail views of data allow you to explore what is behind trends
and indicators.
On opening the file, you have a customized dashboard, which may show Gauges, Live Charts
embedded reports and navigational buttons and boxes that allow you to retrieve data, and
populate controls.
Each button selection, item selection, or navigation sequence can invoke a script created by a
Designer. Behind the scene, Interactive Reporting refreshes the Dashboard script commands
that allow you to retrieve data, populate controls, hide objects, navigate to different sections,
and specify report parameters.

Embedded Section Objects


Results, Pivot, Chart, Table, OLAP, and CubeQuery sections can be embedded in any Interactive
Reporting documents and viewed in EPM Workspace. Data is updated in EPM Workspace as it
is updated in the original sections.
The limitations to Interactive Reporting document files embedded in a dashboard through an
embedded browser or hyperlink control include:
l

Online help is available through a toolbar or a dialog box.

Number formatting options are not available.

The Reference sub dialog box of the Computed Item dialog box is not available.

Embedded sections are added to the EPM Workspace in three modes:


l

View-onlyCan view static reports (The reports are displayed as thumbnails in the
dashboard sectionas currently defined in the native-report section. Users cannot interact
with the reports.
HyperlinkCan navigate to original sections by clicking thumbnails.
Active-Embedded section objects in active modeEnables users to interact with reports.
Selecting a live report activates it in-place for object specific functions such as drill down,
pivoting, and other analysis.

230 Interactive Reporting

View-Only Embedded Section Objects


Embedded section objects in view-only mode are designed to be static objects that is, users
cannot interact with the report beyond viewing its content. Only actions performed on the parent
section of the embedded section object update it. Scroll bar behavior for view only objects depend
on the scroll bar settings defined for the object:
l

Vertical and horizontal scroll bars always appear, and adjacent to but outside the defined
objects container boundary and do not obstruct the object
Vertical and horizontal scroll bars only appear when the object has focus (when the user
selects the object). The scroll bars continue to show until the user selects another object, or
tool bar.

Active Embedded Section Objects


Active embedded section objects allow you to select the embedded section object and perform
selected tasks as you might with other object in the non-dashboard sections. This interaction is
provided on the shortcut menus or the object, or by selecting embedded section object and
clicking Shift+F10. Actions performed on the active embedded section object update the parent
section, as do actions made by the parent section to the embedded section object.
Available options depend on the object and which tasks have been associated with it by the
designer: The following list shows the default shortcut menu options for each embedded section
object.
Embedded Results Section Object shortcut menu options:
l

Sort Ascending

Sort Descending

Auto-size Column

Embedded Pivot Section Object shortcut menu options:


l

Drill Anywhere (with sub-menu listing available columns from parent Results/Table)

Drill Up

Focus on Items

Hide Items

Show Hidden Items

Show All Items

Auto-Size Column Width

Swing
m

Horizontal

Vertical

Up

Down

Dashboards 231

Left

Right

Before (submenu is also launched listing all top and side labels, listing them in a topdown, left-right order)
After (submenu is also launched listing all top and side labels, listing them in a topdown, left-right order)

Sort Ascending

Sort Descending

Refresh Pivot

Embedded Chart Section Object shortcut menu options:


l

Drill Anywhere

Drill Up

Focus on Items

Hide Items

Show Hidden Items

Show All Items

(Un)Group

Show Negative Values

Show Label

Add Trend Line

Sort

Ascending

Descending

Zoom
m

Zoom In

Zoom out

Return to original

Refresh Chart

Embedded OLAPQuery/CubeQuery Section objects (the list of available speed menu options is
context sensitive and depends on what component of the report is selected, for example label,
measure, handle. It also depends on the state when the component selection is made. For example
if items have been hidden, if additional levels are available for drill down, and so on).
l

Keep Only

Remove Only

Drill

232 Interactive Reporting

Down

Up

Next

Bottom

All Descendants

Siblings

Same Level

Same Generation

Drill
m

Down

Up

Next

Bottom

All Descendants

Siblings

Same Level

Same Generation

Suppress
m

Missing rows

Missing Columns

Zero rows

Zero columns

Drill-Through

Column Width

Row height

Scroll bar behavior for view only objects depend on the scroll bar settings defined for the object:
l

vertical and horizontal scroll bars always appear, and adjacent to but outside the defined
objects container boundary and do not obstruct the object
vertical and horizontal scroll bars only appear when the object has focus (when the user
selects the object). The scroll bars continue to show until the user selects another object, or
the tool bar.

Report Section
The Report section allows you to view high-quality and professionally designed reports. These
reports can span anywhere from a complex critical operational report to a results sets, a chart,
Report Section 233

and a pivot table. Use the reports in this section to help you evaluate your business, expand
communications, and assist in the decision-making process.
The reports found here are dynamic and provide you with an almost unfiltered framework from
which to view and analyze data. You can resort and apply data functions, which allow you to
display different types of values.

Paging Through the Report


By default Interactive Reporting shows a fixed number of rows in a table when a user views a
page in a browser. Often data extends beyond the vertical and horizontal rows shown on the
page. To view your paging options, see the table below.
Table 67

Report Paging Options

Paging Option

Description

Current Page

The tooltip shows the current page in the report.

Page Left

Moves one page in the left direction. To move to the first page in the left direction, select [Shift] + Click + left arrow.

Page Up

Moves one page up. To move to the top page, select [Shift] + Click + Up.

Page Down

Moves one view in the down direction. To move to the first page in the down direction, select [Shift] + Click + Down
arrow.

Page Right

Moves one page in the right direction. To move to the first page in the right direction, select [Shift] + Click + right arrow.

234 Interactive Reporting

Using Production Reporting


Documents

7
In This Chapter

Viewing a Production Reporting Document............................................................ 235


Viewing Functionality for HTML Reports ................................................................ 236

Viewing a Production Reporting Document


To view a Production Reporting document in EPM Workspace:
1

Run an Production Reporting job in EPM Workspace.

Double-click the job output and view the available output formats.

Depending on the output formats selected when you ran the job, see Output Options on
page 284, you can select from some or all of the following output formats:

Comma Separated Value file (CSV)

HP Printer file (PCL)

HTML file (HTML)

Interactive Reporting Data file (BQD)

Line Printer file (LP)

Listing file (LIS)

Microsoft Excel file (XLS)

Microsoft Word File (DOC)

Portable Document Format file (PDF)

PostScript file (PS)

PowerPoint file (PPT)

SQR Production Reporting Document (SPF)

Production Reporting Log file (LOG)

Production Reporting Output file (XML)

Select the desired output format and click Open.

Viewing a Production Reporting Document 235

Viewing Functionality for HTML Reports


Subtopics
l
l

Using the Navigation Bar


Navigating with the Table of Contents

When you view a Production Reporting document in an HTML format, you can navigate from
page to page, move to a specific page, or browse with a table of contents.

Using the Navigation Bar


The navigation bar provides options for navigating to different pages within the HTML report
and for viewing the report in multiple output formats.

Exporting Report Information from the Navigation Bar


The navigation bar displays icons for viewing an HTML report in different file formats. The
icons that appear on the navigation bar are defined in the Navigation Bar tab in the SQR
Production Reporting Studio preferences. (See the Oracle Hyperion SQR Production Reporting
Studio User's Guide for more information.) Table 68 describes the export options on the
navigation bar.
Table 68

Icon

Export Options on the Navigation Bar


Message

Description

Display Table of Contents

Displays the Table of Contents frame.

Display PDF file

Displays the report in a Portable Document Format (PDF) and launches it in a new browser
window.

Download the Data in CSV (commadelimited) format

Downloads the report data in a Comma Separated Value format (CSV) and displays it in a
new browser window.

Download the Data in BQD format

Downloads the report data in a Brio Query Data format (BQD) format and displays it in a
new browser window.

Display XML file

Displays the report in an XML format and launches it in a new browser window.

Note: The HTML navigation bar only displays a subset of all the available output formats. See

Viewing a Production Reporting Document on page 235.

Using the Navigation Bar to Move Among Pages


You can navigate among the pages of a multi-page HTML report by using the paging options
on the navigation bar. Table 69 describes the navigation options on the navigation bar.

236 Using Production Reporting Documents

Table 69

Icon

Navigation Options on the Navigation Bar


Message

Description

Go to First Page

Displays the first page of the report in the current browser window.

Go to Previous Page

Displays the previous page of the report in the browser window.

Go to Page

Type the page number you want to go to.

Go to Next Page

Displays the next page of the report in the browser window.

Go to Last Page

Displays the last page of the report in the browser window.

Navigating with the Table of Contents


The table of contents offers standard functionality for navigating through a document.
Figure 2 shows an HTML report with the table of contents displayed.
Figure 2

Table of Contents Displayed for an HTML Report

Viewing Functionality for HTML Reports 237

238 Using Production Reporting Documents

Scheduling Jobs

8
In This Chapter

Overview .................................................................................................. 239


Scheduling and Running Jobs .......................................................................... 240

Overview
In EPM Workspace, you use the Schedule module to perform the following tasks:
l

Run and schedule job types:


m

Interactive Reporting jobAn Interactive Reporting document imported in EPM


Workspace as a job and its associated files.
Production Reporting jobA Production Reporting report or program and its
associated files. A Production Reporting job can be secure or nonsecure.
Generic jobA report or program from another software provider (for example, an
Oracle report or a Crystal report), and any associated files.

Run and schedule batches, which are collections of reports.

Overview 239

Scheduling and Running Jobs


Subtopics
l
l
l
l
l
l
l
l
l
l
l
l

About Job Execution


Events
Event Status and Schedule Status
Job Parameters
Running Jobs
Scheduling Jobs
Using Job Output
Managing Events
Managing Job Queue
Viewing Job Notifications
Using the Consolidated Job Status List
Retrieving Jobs

You can manually run jobs from Explore. Select the jobs you want to run, enter the job
parameters, then view the job output. You can also run jobs automatically by scheduling your
jobs to run using events and job parameters.
The schedule module contains the following panels for scheduling jobs:
l

Managing Job Queue on page 250Job queueing occurs when no Job Service is available
to process a job. Administrators can control Job Service availability using the Job Limit and
Hold properties. For more information on these properties, see Oracle Hyperion Enterprise
Performance Management Workspace Administrator's Guide.
Viewing Job Notifications on page 250Use this to see the status of jobs and notifications
for jobs that are finished.
Show ParametersDisplays a list of information about job parameters. You can modify or
delete parameters from the Show Parameters page. See Modifying Job Parameters on page
255.
Jobs RunningUse this to list jobs which are currently running. You can cancel a job by
selecting a job, right-click and select Cancel.
Managing Events on page 247Use this to create and manage events.
Using the Consolidated Job Status List on page 250Use this to view a list of jobs with
the option to filter the list and modify the jobs, schedules or events. You can also use the
Run Now option on a job from the Consolidated Job List.

If your administrator enabled the pass-through feature, you can configure foreground jobs to
run without additional requests for data source login credentials. You can run jobs in the
foreground or in the background depending upon how the job was configured by the importer.
Note: You can also run any job in the background or foreground using Run Job option from

File menu.

240 Scheduling Jobs

About Job Execution


When a job executes in the foreground, you must wait until the job completes before continuing
with other tasks. When a foreground job finishes executing, EPM Workspace displays:
l

For Interactive Reporting jobs, a link to the output in the folder where the job resides

For Production Reporting jobs, the HTML frame file

For generic jobs:


m

The primary output file, if there is only one

A list of primary output files, if there are multiple files

A list of all output files, if there is no primary one

When a job is executing in the background, you can perform other tasks in the foreground.
When the background job finishes executing, the output files are written to the repository, and
a notification message is displayed in the View Job Status panel of the Schedule module.
The Output link is displayed next to the job title. Click the Output link to view the job output.
l

Job Priority on page 241

Scheduling Jobs on page 241

Job Priority
When jobs are scheduled to process at the same time, jobs with High priority run first. You can
set the priority to High or Normal when you schedule the job.

Scheduling Jobs
Scheduling a job enables you to automatically run jobs at a date or time and/or on a recurring
basis. To schedule a job, you must associate a time event and a job parameter list with the job.
All types of jobs can be scheduled through EPM Workspace.
l

Events define the timetable for running a job

Job Parameters define the run time values necessary to execute a job
Note: For Production Reporting jobs, compile time parameters may also be specified with

job parameters.
l

Schedules specify the job you want to execute, as well as the event schedule and job parameter
list for running the job

Events
Events define when the job runs and whether the job runs only once or many times. You can
determine whether the job runs every Wednesday, or every fourth Friday, or after an event
occurred.

Scheduling and Running Jobs 241

Because events are not associated with a particular job, you can use them to schedule multiple
jobs. You can create personal recurring time events that only you can use. You may have access
to public recurring time events and externally triggered events your administrator created.
You can create events as you schedule a job or from the Schedule module using the Manage
Events panel. You can also view, modify, access, or delete time events.
The types of events that can be used for scheduling jobs are:
l

Public recurring time events Reusable time events created by an administrator and
accessible to you with the required access privileges.
Personal recurring time events Reusable time events created by you and accessible only to
you.
Externally triggered events Date based events created by an administrator and accessible
to you with the required access privileges. Jobs are scheduled to run when the event is
triggered.
Custom time events Time events created by you for one time use within a job schedule.
Custom events cannot be used by other job schedules.

Event Status and Schedule Status


Events and Schedule each maintain their own status, which is displayed by a traffic light indicator.
The following table shows how the status enables a job to run. You can set the status when you
modify the event or schedule.
Table 70

Event Status and Schedule Status

Event Status

Schedule Status

Description

active

active

The scheduled job runs

active

inactive

The scheduled job will not run

inactive

active

The scheduled job will not run

inactive

inactive

The scheduled job will not run

Job Parameters
Job parameters are run-time values that are necessary to run a job. The run-time values are the
job variables or limits you are prompted for by the job. For some Interactive Reporting jobs, job
parameters also include processing and job output options. You can save job parameters to:
l

Run or schedule jobs without being prompted for the run-time values

Share Public job parameters with other users

Run jobs using different parameters on a schedule

EPM Workspace supports the following types of job parameters:


242 Scheduling Jobs

Public job parameters Reusable named job parameters created by your administrator and
accessible to you with the required access privileges.
Personal job parameters Reusable named job parameters created by you and accessible
only by you.
Custom job parameters Unnamed job parameters created by you and associated with a
schedule. Default job parameters are not listed or named and cannot be used with other
schedules. They are deleted when the schedule is deleted.
Note: Job parameters can only be created when creating or modifying a job schedule or

when running a job. See Running Jobs on page 243 or Scheduling Jobs on page
241 to see how to get to the job parameters section.

Job Parameter Tasks


You can modify and delete parameters from the Show Parameters page. You can also modify
job cycles.

To modify a job parameter, select a job name, right-click and select Modify. See Setting
Interactive Reporting General Properties and Options on page 261 to complete the
Properties dialog.

To delete a job parameter, select a job name, right-click and select Delete.

Running Jobs
This section provides general instructions for running a job and setting your default job
parameters.

To run jobs:
1

From Explore, navigate to the job you want to run, then do one of the following:
l

From the menu bar, select File, and then Run Job.

Double click the job.

Right-click the job, from the shortcut menu, select Run Job.

Right-click the job, from the shortcut menu, select Run Job in , then Foreground.
When you run jobs in the foreground, a progress bar displays status and you cannot
perform other tasks until it is complete.

Right-click the job, from the shortcut menu, select Run Job in , then Background.
When you run jobs in the background, you can continue working in EPM Workspace.

If database authentication is required, enter the user name and password for each connection in the
Database Connectivity section.

The Database Connectivity section is displayed only if database authentication is required.

Scheduling and Running Jobs 243

For Production Reporting and Generic jobs, browse to specify a folder destination for the job output.

The default folder is the folder where the job is located.

In the Job Parameters section, define parameters using an existing job parameters list or create one.

If the job has no run-time variables, the job parameters section is not displayed.
To set personal default job parameters, see Setting Job Parameters on page 244.

If you are using default parameters, click Run Job, if not continue with the following steps.

Set values, limits, or define or modify cycles depending upon the type of job you are running.

See Setting Job Parameters on page 264 and Setting Production Reporting and Generic
Job Parameters on page 288.

Click Run Job.

Job parameters selected when jobs are imported are called Publisher defaults. You can
override these Publisher defaults at run time and set your own job parameters. Your jobs
run with your Publisher defaults until you change them.

Setting Job Parameters


To set your default job parameters:
1

From Explore, navigate to the job you want to run, right-click, then select Run Job.

Select an existing job parameter list or New Values.

Set values, set limits, or define or modify cycles depending upon the type of job you are running.

See Setting Production Reporting and Generic Job Parameters on page 288.

Do one or more of the following steps:


l

Check Save as my default.

Check Save, then select Public or Private.

Click Run Job.

Your job parameters are not saved until you run the job.

Scheduling Jobs
This section provides general instructions for scheduling a job.
Note: When scheduling the Day of the Week option, it is calculated based on the server time.

To schedule a job:
1

Do one of the following:


l

From Explore, navigate to a job.

244 Scheduling Jobs

From Consolidated Job Status page, select a job.

Right-click the job and select Add a Schedule.

Fill in the properties.


l

Name(Required) Ccontain letters, numbers, the space character, and the underscore
character _.
DescriptionA meaningful description of the schedule. For example, Quarter end for
all regions. The length is limited to 250 characters.
PriorityWhen jobs are scheduled to process at the same time, jobs with High priority
are run first. Select High or Normal priority.
ActiveDisplayed when you modify a schedule only. A traffic light that indicates if the
job is scheduled to run.
m

A green traffic light indicates that the job is scheduled to run.

A red traffic light indicates that the job is not scheduled to run.

Run this jobInfinitely or a specified number of times. The job automatically becomes
inactive after it runs the indicated number of times.
Job outputs inherit time to live from the job propertiesEnable to automatically delete
job output.
Auto-delete job outputs after: Indicate when to delete by entering a number and
selecting a time interval (minutes, hours, days, weeks, years) after the job is run. Default
is minutes.
User name and PasswordYou are prompted for database authentication if it is
required.

Click Next.

For Job Parameters, select one of the following options:


l

To create job parameters from scratch, select Define job parameters starting with and
select New Values.
To create job parameters from existing job parameters, select Define job parameters
starting with and select a job parameter. This enables you to quickly create a job which
is similar to an existing job. Make changes to the parameters and save the completed
job parameters using a different name.
To use or view job parameters, select Schedule this job with existing job parameters
and select the parameters you want to use from the drop-down list. Click View if you
want to see the parameters before you move on to the next screen.
If the job has no parameters (no run time variables or limits), the job parameters section
is not displayed.
If there are no job parameters, you must create them.

Click Next.

For Set Values, select the cycles and actions for this Interactive Reporting job.

Scheduling and Running Jobs 245

Select Save if you want to save the parameters for another job as your own, Personal, or available to
others as Public.

From the Time Events page, indicate if you want to create an event or use an existing event using one
of the following options:
l

To create a new event, select A New Recurring Time Event from the drop-down list.
See Creating Personal Recurring Time Events on page 247.
A New Custom Time Event. You use a custom time event in order to create a one time
schedule. The time cannot be changed by modifying event since you do not have access
to the event properties.

10 Click Next.
11 If desired, configure notification options.
l

If you want to view your notifications in the Schedule module using the Job
Notifiications panel, select Display notification in Schedule Module.
If you want to Email the notification, enter Email addresses. Separate Email addresses
by semicolons, colons, space characters, commas, or new lines.
If you want to attach the latest job output to the Email, select Attach PDF outputs to
email messages.
For Production Reporting jobs, see additional notification options in Output Options
for Scheduling Jobs on page 288.

12 Complete Permissions step, see Setting Permissions on page 70.


13 Click Finish to schedule the job.

Using Job Output


When jobs run, the results are placed in job output items. This section describes modifying job
output properties and viewing job output. Job output deletion is streamlined. When you delete
jobs, you can also delete all associated outputs.

Modifying Job Output Properties


Job output properties determine which users can view the job output. Job output is listed in the
same folder as the job. Each run of the job produces job output. You can modify or view the job
output properties depending on your access privileges on the job.

To modify or view job output properties:


1

From Explore, navigate to the job output, and select it.

Select File, and then Properties.


Note: You can also right-click on an artifact and select Edit Permissions.

Change the properties or click Permissions to change the access control.

246 Scheduling Jobs

When assigning access to additional users, groups, or roles, the adaptive state is limited to
View Only. Also, the adaptive state cannot be modified for the existing roles, groups, and
users. You can modify the adaptive state for future job output when modifying the access
control for the job.
To modify access control, see Setting Permissions on page 70.

Click OK.

Viewing Job Output


You can open job output and a table of contents is displayed to navigate through the job output.

To view job output:


1

From Explore, right-click the job output file, and then select Open.

The table of contents is displayed for items in the job output.

Click an item, then click Open.

To return to the table of contents and view other items, select the TOC tab in the content tab area.

Managing Events
From the Schedule module, use the Manage Events panel to:
l

View events which you can access

Make events accessible to other users using access control

Modify, delete, or create events

To manage events:
1

Select Navigate, then Schedule, and then Manage Events.

To filter the events displayed, select Filter from the toolbar. Complete the Filter dialog fields and select
Apply.

All the events you can access are listed with their properties.

To modify or delete an event, select the event, right-click and select Edit or Delete.

To create a personal time event, see Creating Personal Recurring Time Events on page 247 and to
create a public recurring time event, see Creating Public Recurring Time Events on page 248.

Creating Personal Recurring Time Events


To create a personal recurring time event:
1

Select Navigate, then Schedule, and then Manage Events.

To filter the events displayed, select Filter from the toolbar. Complete the Filter dialog fields and select
Apply.

Scheduling and Running Jobs 247

All the events you can access are listed with their properties.

Right-click an event and select Add , then Personal RecurringEvent.


Note: You must be an Administrator to add a Public Recurring Event or Externally

Triggered Event.

The Create Personal Recurring Time Event dialog wizard is displayed. Enter the time event name and
description.

Click Active to make the Event available for scheduling.


Note: If a schedule is associated with an inactive event, the job will not run. You can check

the events active status by using the Manage Events panel in the Scheduler.

Select the calendar you want to use for this time event.

Company calendars are created by your administrator.

From the Days to Run list, select the option you want to use and click Go (By Day is the default).

By Day, By Week, By Period, By Quarter, and By Year let you specify a recurring time pattern.
Advanced Days of Week and Advanced Days of Period give you the option to select days
with no pattern.

From the Time to Run list, select the option you want to use and click Next (Once per hour is the default.)

The options include Once Per Day, More Than Once Per Day, or After External Event.

Update the Starting At and Ending At time to specify a range for the event.

10 Enter a Start Date and select the option to enter an End Date or to accept the default, No End Date.
11 Click Finish.

Creating Public Recurring Time Events


To create a public recurring time event:
1

Repeat step 1 through step 10 above. The only exception is to select Public Recurring Event in place of
Personal Recurring Event.

Select Next.

Complete the permissions for this event and select Finish. For more information on setting permissions,
see Setting Permissions on page 70.

Creating Externally Triggered Events


To create an externally triggered event:
1

Repeat step 1 through step 10 above. The only exception is to select Externally Triggered Event in place
of Personal Recurring Event.

Select Next.

248 Scheduling Jobs

Complete the permissions for this event and select Finish. For more information on setting permissions,
see Setting Permissions on page 70.

Viewing Events
You can view all your events from the Manage Events panel in the Schedule module.

To view events:
1

Select Navigate, then Schedule, and then Manage Events.

A recurring and externally triggered event list is displayed.

To filter the events list, select Filter from the toolbar area. Complete the Filter dialog and select Apply.

Modifying Events
You can modify events from the Manage Events panel in the Schedule module.

To modify events:
1

Select Navigate, then Schedule, and then Manage Events.

A recurring and externally triggered event list is displayed.

To filter the events list, select Filter from the toolbar area. Complete the Filter dialog and select Apply.

Select an event, right-click and select Modify.

Change properties.

Click OK.

The modified event is displayed in the events list.

Deleting Events
You can delete events unused by schedules or other events. For example, if an external event is
used to trigger a recurring event, the recurring event needs to be deleted or disassociated from
the external event before the external event can be deleted.

To delete events from the Manage Events panel in the Schedule module.
1

Select Navigate, then Schedule, and then Manage Events.

An event list is displayed.

To filter the events list, select Filter from the toolbar area. Complete the Filter dialog and select Apply.

Select an event, right-click, select Delete and confirm deletion by clicking Yes.

If schedules are associated with the time event you are deleting, modify those schedules to
use another time event.
Before you delete a time event associated with an external event, disassociate the time event
from the external event or delete the external event.
Scheduling and Running Jobs 249

Managing Job Queue


Job Queueing enables users to limit the number of jobs processed in parallel and manage the
Job Queue.

To manage job queue:


1

Select Navigate, then Schedule, and then Job Queue.

On the Job Queue page, verify that jobs with High priority are at the top of the queue.

Perform the following tasks to manage and validate changes are reflected in the queue:

From the right-click menu:


l

Place a job to the top of the queueThis job should be first removed from queue.

Place job in the bottom of the queueThe job should be removed from the queue last.

Select Hold item for the Job. Repeat for several job typesJob should not be processed,
but not removed from the queue. Check mark next to the job is displayed when Held.
Delete job from the queue. Repeat for all job typesJob should be removed from the
queue.

Note: When some scheduled jobs are in the queue, run several different jobs in Background

and Foreground. A dialog is displayed asking whether user wants to queue the Job.
Job is added to the Queue if user clicks Yes.

Viewing Job Notifications


From the Schedule module, use the Job Notifications panel to:
l

Display completion status of jobs running in the background.

Display notifications for jobs that have completed.

To view job notifications:


1

Select Navigate, then Schedule, and then Job Notifications.

To delete job completion notifications:


l

To delete one notification, select the job, right-click, then select Delete.

To delete all notifications, select the jobs, right-click, then select Delete.

Using the Consolidated Job Status List


From the Schedule module, use the Consolidated Job Status panel to:
l

Filter the job list shown in the Consolidated Job Status List, see Filtering Consolidated Job
Status List on page 251.

250 Scheduling Jobs

Run Now. Run the scheduled job again with parameters used previously when the job failed.
See Run a Scheduled Job Now on page 252.

Modify job properties. See Modifying Job Parameters on page 255

Modify schedule properties. See Modifying Schedules on page 254

Modify event properties. See Modifying Events on page 249

Add schedules. See Adding Schedules on page 254

Delete schedules. See Deleting Schedules on page 254

To update a scheduled job list:


1

Select the Navigate, then Schedule, and then Consolidated Job Status.
l

Job NameJob Name


Job OwnerDJob owners login id. A non-administrator user must have view access
to display jobs.
Schedule Name.Job schedule name
Schedule Owner.Scheduler owners login id. Only administrators can see schedules
owned by others.
Event NameDEvent name
Last Run DateJob last ran. If the schedule or event is inactive, this column displays
Schedule Inactive or Event Inactive.

Last StatusStatus from the last time the job ran

Next Run DateJNext date the job will run

To filter the Consolidated Job Status list, select Filter from the toolbar. See Filtering
Consolidated Job Status List on page 251.

Optional: To delete schedules, select the schedule, then right-click and select Delete.

To select all schedules, click the check box at the top of the column.

Filtering Consolidated Job Status List


You can filter your job list using the filter criteria listed in Table 71. A particular filter is not set
when it is blank. The Consolidated Job Status List is sorted by the filter you selected in the Default
Sort Order field from the filter page.

To set filters and sort criteria for the Consolidated Job Status List:
1

Select Navigate, then Schedule, and then Consolidated Job Status.

If default filter settings do not exist, select filter settings by selecting Filter from the toolbar. Filter dialog
is displayed..

See Table 71 for more details on the filter criteria.

Scheduling and Running Jobs 251

Determine the sort order by selecting the Default Sort Order from the drop-down list and the options
indicating ascending or descending order.

The default sort filter is the job name. For descriptions of sorting filters, see Table 71.

Click a button:
l

ApplySaves your values for one session.

Save As DefaultSaves your values as your default values.

Restore DefaultsRetrieves the values you last saved as your default values.

CancelSaves no values.
Table 71

Job Filters

Job Filter

Description

Job Name

Select Equals, Contains, Ends with, or Begins with and enter text.

Job Owner

Select Equals, Contains, Ends with, or Begins with and enter text.

Schedule Name

Select Equals, Contains, Ends with, or Begins with and enter text.

Schedule Owner

Select Equals, Contains, Ends with, or Begins with and enter text.

Event Name

Select Equals, Contains, Ends with, or Begins with and enter text.

Last Status

Select All, Is, or Is not from the first drop-down list and Successful or Cancelled from the second dropdown.

Last Run Date

Select the time period from the drop-down list.

Next Run Date

Select After, Between, or Before from the drop-down list and the year, month, and day for your selection.

Default Sort Order

Select a filter criteria from the drop-down list to sort the list. Select a radio button for ascending or
descending sort order.

Schedule State

Select the desired filter(s) for the schedule state. Active is the default.

Run a Scheduled Job Now


This functionality allows a user to run any job from Consolidated Job Status list. You can also
select multiple jobs to run at once. For applicable user rights required, see Table 72.
Table 72

User Privileges Required for Run Now

Artifact

Job Type

User Rights

Generic Job

Simple

Administrator

Generic Job

Simple

Any user with lower than Modify and Run access

Generic Job

With Parameters

Schedule Manager with Modify and Run access

Interactive Reporting job

Simple

Schedule Manager with Modify and Run access

252 Scheduling Jobs

Artifact

Job Type

User Rights

Interactive Reporting job

With parameters

Administrator

Interactive Reporting job

Simple

Any user with lower than Modify and Run access

Production Reporting job

Simple

Any user with lower than Modify and Run access

Production Reporting job

With parameters

Administrator

Production Reporting job

With DB connection

Schedule Manager with Modify and Run access

Production Reporting job

With DB connection

Administrator

To run a scheduled job now:


1

Select Navigate, then Schedule, and then Consolidated Job Status.

Select a job which had been run successfully by the schedule with notifications enabled.

Right-click and select Run Now.

Do any of the following:


l

Go to Jobs Running page, verify that the job is running.

Go to Job Notifications page, check job's notification.

Open the output from Job Notifications page.

If you run a job when job service is busy, you can check the Job Queue module to see if
the job has been added to the top of the queue.

Managing Individual Job Schedules


To manage schedules:
1

From Explore, right-click a job and select Manage Job Schedules.

Review Schedules information:

Job NameName of job

Job OwnerOwner of job

Schedule OwnerCreator of schedule

Schedule NameThe name of the schedule

DescriptionA schedule description

Event NameType of action

Next Run DateNext scheduled run

Review Job Parameters information, select a job, right-click and select Show Parameters.
l

Job NameName of the job

Job TypeType of Interactive Reporting or Production Reporting job

Scheduling and Running Jobs 253

Parameter NameName of parameter created for this job

DescriptionParameter description

OwnershipOwner of parameter

Modifying Schedules
When your schedule needs changes, you can modify it.

To modify a schedule:
1

Select Navigate, then Schedule, and then Consolidated Job Status.

A list of all jobs that you can access is displayed.

Under Job Name, locate the job.

Select the job, right-click and select Modify Schedule.

Change properties.

See Scheduling Jobs on page 241.

To deactivate or activate the schedule on the General Properties page toggle Active.

To modify more properties click Apply, otherwise click OK.

Deleting Schedules
To delete a schedule:
1

Select Navigate, then Schedule, and then Consolidated Job Status.

A list of all jobs in the system is displayed.

Under Job Name, locate the schedule, right-click and select Delete.

Adding Schedules
To add a schedule:
1

Do one of the following: .


l

Select Navigate, then Schedule, and then Consolidated Job Status

A list of all jobs in the system is displayed.


l

From Explore, select a job.

Right-click and select Add Schedule.

Follow the instructions in Scheduling Jobs on page 241.

254 Scheduling Jobs

Viewing Job Parameters


To view job parameters, select Navigate, then Schedule, and then Show Parameters. A list
of all jobs with schedules and parameters is displayed. See also, Modifying Job Parameters
on page 255 and Deleting Job Parameters on page 255.

Modifying Job Parameters


To modify job parameters:
1

Select Navigate, then Schedule, and then Show Parameters.

A list of all jobs with schedules and parameters is displayed.

Select a job, right-click and select Modify.

Change properties and click OK.

Deleting Job Parameters


You can delete job parameters that are not being used by a schedule.

To delete job parameters:


1

Select Navigate, then Schedule, and then Show Parameters.

A list of all jobs with schedules and parameters is listed.

Click the scheduled job.

Right-click and select Delete.

If no schedules are associated with it, the job parameter is deleted.


If schedules are associated with it, you must associate the schedule with other job parameters
by modifying the schedule.

Retrieving Jobs
You can retrieve a Production Reporting job and its associated files.

To retrieve a Production Reporting job:


From Explore, right-click the job, and select Retrieve.

Scheduling and Running Jobs 255

256 Scheduling Jobs

Using Interactive Reporting Jobs

In This Chapter
Interactive Reporting Jobs............................................................................... 257
Setting Interactive Reporting Job Properties........................................................... 259
Selecting Database-Connection File Options.......................................................... 262
Setting Job Parameters.................................................................................. 264
Job Parameter Options .................................................................................. 266
Example: Importing and Scheduling a Job ............................................................ 272

Interactive Reporting Jobs


Subtopics
l
l
l
l

Import Requirements
Pass-Through Feature
Parameters
Supporting Exceptions in Interactive Reporting Programs

Interactive Reporting jobs are created with Interactive Reporting Studio and defined by
properties and parameters. You can import, run, and schedule Interactive Reporting jobs.

Import Requirements
To import an Interactive Reporting, you need this information:
l

Interactive Reporting database connection file names, to connect to the database for
processing queries
Custom calendar name, if not using the default calendar, to resolve dynamic date parameters
Filter names and values, if running a job with parameters that must be specified. (See
Parameters on page 258.)

Email addresses if sending results directly to users

Output directory name if sending results to a directory

Database create-and-insert privileges if processing results to a database table

Database grant access if giving additional users access to a database table.

Interactive Reporting Jobs 257

Pass-Through Feature
Pass-through enables users to log on once and access data sources without additional
authentication. Pass-through is enabled per authentication system and per Interactive Reporting
database connection file. Pass-through can be used for foreground jobs and all Interactive
Reporting documents.
After your administrator enables pass-through for authentication systems, you can enable or
disable it for Interactive Reporting database connection files.

Parameters
Interactive Reporting job parameters include runtime values, processing options, and joboutput options. Processing and job-output options are defined using cycles and actions. A cycle
contains job actions and job filters. Actions define how documents are processed and results are
distributed. Filters are the values for the run-time variables. Job cycles are named and associated
with jobs.
When importing a job, you specify whether users can create cycles (multiple-cycle jobs) or use
only the default cycle (single-cycle jobs).
l

Single-cycle jobsLimited to one cycle. The default processing and printing actions are
used. All single-cycle job results are processed to file as job output. The job output is listed
with the job in the Browse item list.
Multiple-cycle jobsProcessed according to how many cycles are defined. Cycles can be
created using processing, printing, and exporting actions. You can design jobs to process as
many times as necessary at each scheduled run, each process having different parameters
(or filters) and job output options.

Example
Your document queries sales transactions within a region. The region is specified through a
variable filter on the query to make the data available to each sales manager on Monday
mornings.
When scheduling the job, you can add a job cycle for each region. You can resolve the variable
and filter for each run to retrieve numbers for only one region, and email the numbers from
each run directly to the regional manager. All job-run cycles are part of one job, which is easier
to track and update.

Supporting Exceptions in Interactive Reporting Programs


This section is for Interactive Reporting programmers who support exception notifications to
users. (Users can receive email notifications or see a graphic indicator on the Exceptions
Dashboard on Personal Pages.)

258 Using Interactive Reporting Jobs

Setting Interactive Reporting Job Properties


Subtopics
l
l
l
l

Setting Advanced Options


Setting Data Source and Query Properties
Setting Interactive Reporting General Properties and Options
Setting Job Defaults

These topics describe the properties for Interactive Reporting importing and modifying
Interactive Reporting jobs:
For details on general properties and advanced options, see Working with Properties on page
75.

To access properties:
1

From Explore, select an item.

Select File, and then Properties.

Setting Advanced Options


In addition to the advanced option detailed in Working with Properties on page 75, two
options specific to Interactive Reporting jobs are available.

Option

Description

MIME Type

Displays the file type

Run this job in the background

Enable running of your job in the background

Hidden File

Set file to hidden

Auto-delete file on this date

Select a time period and enter a number to specify when output is automatically deleted

Auto-delete job outputs after

Deleted job output after a specified time. Enter a number, and select a time element:
l

Minutes

Hours

Days

Weeks

If exceptions are generated, allow users to


add to their Exceptions Dashboard

Enables users to report exceptions to Exceptions Dashboards

Automatically generate keywords

Automatically generates keywords in <Assigned Keywords>


.

To add, enter keywords and click

To remove, select from <Assigned Keyword> and click

Setting Interactive Reporting Job Properties 259

Setting Data Source and Query Properties


Interactive Reporting database connection files are used by Interactive Reporting jobs and files
to connect to databases. Queries in a document can use different databases. In addition, an
Interactive Reporting database connection file can be specified for each query of an file or job.
Before you can import files and jobs, you need access to all Interactive Reporting database
connections that your document uses. Otherwise, the required database connection files are not
displayed in the connection list. Ask your administrator for access to the required Interactive
Reporting database connections.
If you use pass-through, see Pass-Through Using Multiple, Interactive Reporting, DatabaseConnection Files on page 262.
Note: If no Interactive Reporting database connection file is specified for a query, users accessing

the document cannot process the query unless it uses only local results.

To access data source and query properties from Properties, select 2: Query from the left
pane.
Property

Description

Apply Option to All


Queries

Select a method for obtaining user names and password for queries:
l

Use Default User Name & PasswordUses the defaults for database access.

Prompt for User Name & PasswordPrompts the user for a user name and password per data connection. The
word prompt is displayed in the user name and password fields.

Specify NowPrompts the importer for a user name and password for all queries. The user name is displayed
in all user name fields. The password is not retractable.

You can override individual username or password combinations by selecting a method for each query connection.
Connection

Select an Interactive Reporting database connection file to use the query. For queries using only local results, select
<No Connection>.
If you are using pass-through, see Pass-Through Using Multiple, Interactive Reporting, Database-Connection Files
on page 262.

User name

Enter a user name, set one globally with the Connecting to Data Sources list; or set a one individually with the
options list.

Password

Enter the password to use for this query; or set globally with the Connecting to Data Sources list; or set individually
with the options list.

Options

Set the username and password using the selected method (default or prompted)

Query Connections
and Processing

Validate all queries that you process at runtime.

260 Using Interactive Reporting Jobs

Setting Interactive Reporting General Properties and Options


The Interactive Reporting properties page for an Interactive Reporting job contains general
properties and the Interactive Reporting options.

To access general properties, from Properties, select 3:Interactive Reporting Job Properties
from the left pane.
Table 73

General Properties

Property

Description

Calendar

Calendar selected for resolving dynamic date parameters.

Users running this job can


define their own cycles and
actions

Allow users to define cycles and parameters for the job, thus creating a multiple-cycle job. The default is
selected (multiple -cycle jobs).
Only single-cycle jobs can be viewed in View Manager.
Note: If you select the option now, you can deselect it later. If you do not select it now, you can never
select it.

Table 74

Interactive Reporting Options

Option

Description

Enable ADR

Enables the Automatic Distributed Refresh (ADR) feature. ADR is a sophisticated version control feature that transparently
updates Interactive Reporting when the data model or standard query is changed in the document repository. ADR operates
completely in the background without any user interaction.

Setting Job Defaults


Job Defaults are detailed in Table 75 gives you the option to include HTML as a default, joboutput format and to set default, job-parameter values. See Setting Job Parameters on page
264.

To access Job Defaults, from Properties, select 4. Job Defaults from the left pane.
Table 75

Job Defaults

Default

Description

Include static HTML as a


default output format

Select to make HTML and the default output format (the standard Interactive Reporting document) your
default output format.

Set Values

Set default job-parameter values. See For field definitions to set values, see Setting Job Parameters
on page 264Modifying Job Parameters on page 264.

Modify Filter

Set default filter options. .

Set Locale

Set locale properties:

(Interactive Reporting)

LanguageDetermines the sort order and the job log language.

CountryDetermines the data format (for example, the date/time format).

Setting Interactive Reporting Job Properties 261

Selecting Database-Connection File Options on page 262Click OK to close Properties. You


can schedule the job later from the Browse web module. See Oracle Hyperion Enterprise
Performance Management Workspace User's Guide
To complete the Import dialog wizard for Interactive Reporting (.bqy) files, see Importing Files
as Jobs on page 68.

Selecting Database-Connection File Options


Subtopics
l
l

Pass-Through Using Multiple, Interactive Reporting, Database-Connection Files


Setting Processing and Metadata Options

Interactive Reporting jobs and files use database-connection files to connect to databases. An
Interactive Reporting, database-connection file must be specified for each query of an Interactive
Reporting file or job, except for queries that use only local results, so users can process the query.

Pass-Through Using Multiple, Interactive Reporting,


Database-Connection Files
If enabled by your administrator, pass-through enables you to access data sources without
entering a username and password for each data source. For pass-through to work for Interactive
Reporting jobs or files associated with multiple, Interactive Reporting database connections,
these conditions are necessary:
l

Interactive Reporting database connections is configured for pass-through.

Credentials required to access each data source are identical.


Note: Oracle recommends selecting similarly configured Interactive Reporting, database-

connection files when importing Interactive Reporting documents. To enable users


doing imports to make this selection, Interactive Reporting database connection
names should indicate whether the database connection is configured for passthrough.
When Interactive Reporting jobs and files with some but not all Interactive Reporting database
connections configured for pass-through are processed:
l

Interactive Reporting database connections configured for pass-throughUsers are not


prompted for logon credentials.
Interactive Reporting database connections not configured for pass-throughThe
credential option selected when the job or file was imported (prompt user, specify now, or
use the default) is used.

262 Using Interactive Reporting Jobs

Caution!

For pass-through processing of all queries, Interactive Reporting database


connections must have identical database credentials.

Setting Processing and Metadata Options


Three options types specific to Interactive Reporting, database-connection file are offered:
processing and metadata.
Processing Open Catalog Extension (OCE) options store database connection information.
Table 76

Processing Database-Connection Options

Option

Description

Data source access

Select a method for the Interactive Reporting database-connection file to use a username and password
when a job is run or a file is processed.
l

Use the username/password specified belowYou enter the database username and password.

Prompt for user name/passwordYou are prompted for the database username and password when
the job is run or scheduled or the file is processed. This is the default when pass-through is disabled.

User name

If Data source access is set to use this field, enter the database user name.

Password

If Data source access is set to use this field, enter in the database password.

Allow pass-through where


end users authentication
system is enabled for it

Select to allow pass-through credentials for data source access.

Metadata options store a file that contains extra information about the Interactive Reporting
database connection.
Table 77

Metadata Options

Option

Description

This Interactive
Reporting database
connection (.oce) uses
metadata defined in
another connection

Metadata is used and the metadata connection is not specified in the Interactive Reporting, databaseconnection file. All fields in this group are disabled if this field is not selected.

Select metadata
connection

If metadata is used and the metadata connection is not specified in the Interactive Reporting, database
connection file, select the Interactive Reporting database-connection file for the metadata.

Metadata access

Select one of the following:


l

Use processing OCEs credential for metadata connection Use that username and password associated
with the Interactive Reporting database connection to access the metadata.

Use specified user name/password Use the specified user name and password to access the metadata.

User name

If Data source access is set to use this field, enter the database user name.

Password

If Data source access is set to use this field, enter in the database password.

Selecting Database-Connection File Options 263

Table 78

Interactive Reporting Database Connection

Option

Description

Connection Software

Connection software name used by this Interactive ReportingInteractive Reporting database connection file (.oce)
to connect to the database server, for example, ODBC or EssbaseOracle Essbase.

Database

Type of the database or database connectivity to which this Interactive Reporting Connection file (.oce) is used
to connect, for example ORA8, Essbase, ODBC, OLEDB and so on.

Host

Identifier or alias for the specific information needed to connect to the client, for example, host name or DSN.

To complete the Import dialog wizard for Interactive Reporting Database Connection (.oce)
files, see Importing Files on page 67.

Setting Job Parameters


Subtopics
l
l
l

Setting Single-Cycle Job Parameters


Modifying Job Parameters
Setting Multiple-Cycle Job Parameters

With single-cycle jobs, job parameters contain job variables filters. With multiple-cycle jobs, job
parameters contain job variables or filters and job cycles, which contain processing options and
job actions.
Note: You can create job parameters only when creating or modifying a job schedule or running

a job.

Setting Single-Cycle Job Parameters


Only single-cycle jobs with variables filters have job parameters.

To set job parameters for a single-cycle, Interactive Reporting job:


1

From Explore, right-click the Interactive Reporting job, and select Run Job.

This job is stored in a folder to which you have Run Job access rights. The Job Parameters
window displays the parameter values that are set.

Select a job parameter definition.

Click Go to use the definition as is or click Edit to modify it.

If you clicked Edit, proceed to the following topic.

Modifying Job Parameters


The following procedure assumes that you clicked edit in the preceding procedure.
264 Using Interactive Reporting Jobs

To edit a job parameter definition:


1

Under Job Parameters next to Define Job Parameters starting with and just to the right of Go, click
Edit.

From Show Parameters, select a Job Name.

Right-click and select Modify .

From the Properties dialog, in Name, enter a name.

In Description, enter a description.

To change owner for this job, select Change Owner.

Select the new owner and click OK. For additional information, see Changing Ownership of Artifacts
on page 76.

Under Set Local, change the language:


l

In Language, select the language.

In Country, select a country.

Optional: Modify filters (available only if filters exist in the file).

Take one action:


l

Select Save as my default

To save your job parameters, select Save, select parameter type, and enter a name.

10 Optional: Click Permissions in the left pane of the properties dialog to change access permissions. For
more information, see Setting Permissions on page 70.

Setting Multiple-Cycle Job Parameters


When creating job parameters for multiple-cycle jobs, you can save the cycles and the job
parameters associated with the job that you are running or scheduling.
Note: You can create job parameters only when creating or modifying job schedules or running

jobs.

To set job parameters for multiple-cycle, Interactive Reporting job:


1

From Explore, right-click the Interactive Reporting job, and select Run Job.

This Interactive Reporting job is stored in a folder to which you have Run Job access rights.
The Job Parameters window shows the parameter values that are set.

Under Cycles, you can perform the following:


l

To add a cycle click Go.

To modify cycle, click Modify, or to add new cycles, click Go.


m

Under Define Cycle, enter cycle information:


o

In Cycle Name, enter a name.

Setting Job Parameters 265

Select Save Job Output with the job or Save job output in another folder and
enter a file path.
Click Edit Cycle Permissions for permissions access.

To copy, click Copy.

If filters exist, see Filter Options on page 266.

Select Process Options. See Process Options on page 268.

The connection file and database to which you are connected determine whether you can
process the results to a database table.

Select Action.

For details on action options, see Table 81.

Click OK.

Select Save Job Parameters, and enter a name.

Job Parameter Options


Subtopics
l
l
l

Filter Options
Process Options
Action Options for Multiple-Cycle Jobs

This following topics provide details on Interactive Reporting, job-parameter options:


l

Filter optionsFor single-cycle and multiple-cycle jobs

Processing optionsFor multiple-cycle jobs only

Actions optionsFor multiple-cycle jobs only

Filter Options
In Interactive Reporting Studio, filters enable you to control how much data is processed and
displayed during relational or OLAP database queries.
Query filters which are created initially in Interactive Reporting Studio, can be static or variable.
Static filter values cannot be changed. You can change variable filter values at runtime from Set
Values. The Set Values area displays information for relational and OLAP databases.
These topics detail the information displayed in the Set Values area during relational or OLAP
database queries:

Setting Filter Values for Relational Databases


The Set Values area displays the values for the filters.

266 Using Interactive Reporting Jobs

To access properties:
1

From Explore, select an item.

Right-click a job and selectRun Job.

Properties is displayed.
Option

Description

Query Name

(Read-only) Query name

Filter Name

(Read-only) Name of the field that the filter is on from the Interactive Reporting job

Operator

(Read-only) The operator that the filter uses, such as =, <, or >

Values

(Read-only) The values that the filter uses (Variable system values such as $USER, are acceptable. The values are
from the database that the query is using.)

Ignore

Disables the filter when the query is processed

Dont Prompt

Disables prompting for runtime values. (A dynamic value, such as a system variable can be used for a value(s).
This option essentially changes the variable filter to a static filter with fixed values.)

Modify Filter

Enables modification of a selected filter.

Include nulls

Enables inclusion of an is null condition in the SQL sent to the database when the query is processed.

Operator

(Read-only) The operator that the filter uses, such as =, <, and >

Show values

Retrieves from the database all available values associated with the item you can consider and select from the
range of values when applying a filter.

Custom values

Lists available values saved with the filter or read from a file, you can select values from a pre-defined pool. You
can create and save a custom list with each filter.

Setting Filter and Slicer Values for OLAP Queries


You can set OLAP variable filters and slicers when importing or scheduling a job with an OLAP
query. In the query, you can filter data on cube dimension levels to be displayed in the top or
side labels of the query.
Slicers are filters on a dimension that are not in top or side labels but are visible in the data
displayed. The filters list on Set Values displays the slicers last.
Note: When modifying filters, you cannot remove the last filter. You need at least one filter value

per filter.

To access filter and slicer values:


1

From Explore, select an Interactive Reporting job.

Select Run Job.

Click Go to add a schedule.


Job Parameter Options 267

Enter the schedule properties and click Next until you can define the value and filter options.
Table 79

Fileter Options

Option

Description

Set Values
(MDD)

OLAP Query Name (Read-only) Query name


Filter On (Read-only) The dimension level on which the filter is applied
Operator Type (Read-only) The type that is set
Data Operator (Read-only) The operator that the filter uses, such as =, <, and >. (Slicers have no data operators.
)
Value(s) (Read-only) The values that the filter uses (Variable system values such as $USER are acceptable. The
values are from the database that the query is using.)
Ignore Disables the filter when the query is processed
Dont Prompt Disables prompting for runtime values. (A dynamic value such as a system variable can be used for
a value. This option essentially changes the variable filter to a static filter with fixed values.)

Modify Filter

Lists OLAP Query Name/Filter On values. Toggles filter list to filters applied for selected OLAP Query section and filter.

Operator
Type

Availability determined by the database:


l

Select Members From Database

Select By Measure

Top N

Bottom N

Top Sum

Bottom Sum

Top N%

Bottom N%

Select Members

User Defined Attributes

Substitution Variables

Available operator types are displayed in the filter list. Slicers have no operator types.

Process Options
Process options, are displayed in the section below the Modify Filters options. The connection
file and database to which you connect determine whether you can process the results to a
database table. You need Create and Insert privileges on the database to process to a database
table.

To set process options for a multiple-cycle, Interactive Reporting job:


1

From Explore, right-click the job and select Run Job.

Click Go to add another cycle to this job.

Click Process Options (+) to display all process options.

268 Using Interactive Reporting Jobs

Table 80

Process Options

Option

Description

Save job output with the job

For storing the job output in the folder containing the job

Save job output in another folder

For specifying an output folder

Process results to Interactive


Reporting file

For processing queries to the Interactive Reporting file Results section

Process results to database table

For creating a database table to store the data set. (Items on the Request line become the
column headings. You can append columns to the table and query it. You need Create and
Insert privileges on the database to process to a database table.)

Query

For selecting the query to process to a database table.

Table Name

For entering the name of the table that you are creating or to which you are appending columns
(See your database administrator if you want to use a new table.)

Create a table for each run,


appending date to table name

For creating a table for each job run and appending the date to its name

Delete and recreate table for each


job run

For deleting the old table and creates a table for each job run (Runs use the same table name.
)

Create table on initial run, and


then append data to existing table

For creating a table on the initial run and adding data to the table

Grant access to:

For entering additional usernames (separated by commas) (You need Grant privileges to use
this field. If Grant Access to is not selected, the table is granted only to your user name.)

Action Options for Multiple-Cycle Jobs


The action is the output method. The options on the actions page vary depending on the action.
Actions and items to which they apply:
l

ExportDashboard, Report, Results, Chart, Pivot, OLAPQuery, and an entire document


as a web page
Save DocumentEntire Interactive Reporting file
PrintDashboard, Report, Results, Chart, Pivot, and OLAPQuery (Available if the
administrator defined a printer for Oracle Hyperion Interactive Reporting Studio)

Email SectionDashboard, Report, Results, Chart, Pivot, and OLAPQuery

Email DocumentEntire Interactive Reporting file


Note: A cycle can have only one Save As Job Output action. It can have multiple save actions

but can be saved as a file on only some output folders.

To set action options for a multiple-cycle, Interactive Reporting job:


1

From Explore, right-click the job, and select Run Job.

Job Parameter Options 269

Click Go to add another cycle to this job.

From the actions list, select a value and click Go.


Table 81

Export Action Options

Option

Description

Section

Section to be saved, printed, mailed, or exported.

Filename

Export file name (no extension)

Format

Export file format:


l

Microsoft Office Web Archive (*.mhtml)

Excel (*.xls)

HTML (*.htm)

Lotus 1-2-3 (*.wks)

Text (Tab Delimited)(*.txt)

Text (Comma Delimited)(*.csv)

Adobe Acrobat (*.pdf)

Graphics file (*.jpg)

Note: The choices depend on the export section type and text port action type.
Export as job
output

For exporting the section to the current job folder in the repository. (The filename is not used with this option.)

Save as job
output

For saving the section to the current job folder in the repository. (The file name is not used with this option.)

Output
Directory

The directory for saving the export file or Interactive Reporting document

Append Unique
Identifier to
Filename

For appending the job ID# and report cycle name to the saved document or export file; ensures that the file is
recognizable if similar files are saved to one directory.

Append Date to
Filename

For appending the date (year, month, and day) to the saved document or exported file

270 Using Interactive Reporting Jobs

Option

Description

Save in Output

Sets the type of output saved with the Interactive Reporting document. The output types include the Results section
and computed items. Use the Include drop-down to view and select the output type. Available options include:
l

Inherit from BQYThe output saved with the document is determined when the Interactive Reporting document
(BQY) was created.
Results and Computed ItemSaves the Results set and computed items. Saving results with your query allows
you to analyze and generate reports without being connected to the database. Results are saved for an
individual query or for multiple queries for which results have been generated. Having your results set makes
sense if you cannot connect to a database, for example, when traveling or working remotely, or if you are
scheduling or forwarding documents for someone elses use.
Computed values are recalculated when the document is opened and the query is reprocessed. If the
corresponding Results section contains a large number of column items which use complex formulas in their
definitions, the document make take a while to open.

Results and No Computed ItemsSaves the Results section, but not computed items. This is especially useful
when you need to view a Results set, but do not need to show and recalculate computed items.
No ResultsSaves computed items, but not the Results section with the document. To automatically recalculate
the values of computed columns when a document is opened, do not select the corresponding Results section.
The document may take longer to open, especially if the Results set contains a large number of computed
columns or uses complex formulas in the definitions, since all computed values are recalculated in the Results
section and in any other section that references the Results section.

Compress

For saving the job file in Interactive Reporting, compressed-file format.

Message

Enter the message text to send with the email

Attach File

Select to include the scheduled file in an email message

Save in File

Sets the type of output saved with the Interactive Reporting document attached in the email. The output types
include the Results section and computed items. Use the Include drop-down to view and select the output type.
Available options include:
l

Inherit from BQYThe output saved with the document is determined when the Interactive Reporting document
(BQY) was created.
Results and Computed ItemSaves the Results set and computed items. Saving results with your query allows
you to analyze and generate reports without being connected to the database. Results are saved for an
individual query or for multiple queries for which results have been generated. Having your results set makes
sense if you cannot connect to a database, for example, when traveling or working remotely, or if you are
scheduling or forwarding documents for someone elses use.
Computed values are recalculated when the document is opened and the query is reprocessed. If the
corresponding Results section contains a large number of column items which use complex formulas in their
definitions, the document make take a while to open.

Compress

Results and No Computed ItemsSaves the Results section, but not computed items. This is especially useful
when you need to view a Results set, but do not need to show and recalculate computed items.
No ResultsSaves computed items, but not the Results section with the document. To automatically recalculate
the values of computed columns when a document is opened, do not select the corresponding Results section.
The document may take longer to open, especially if the Results set contains a large number of computed
columns or uses complex formulas in the definitions, since all computed values are recalculated in the Results
section and in any other section that references the Results section.

For sending the saved job file in Interactive Reporting compressed-file format.

Job Parameter Options 271

Example: Importing and Scheduling a Job


This example illustrates importing and scheduling of an Oracle Hyperion Interactive Reporting
job. In this example, you import and schedule sample1.bqy to run once per quarter.

To import sample1.bqy:
1

Navigate to the folder to which to import the job.

Select File, then Import, and then File as Job.

In File, click Browse to search for the file sample1.bqy. Click Next.

For Query, on Connecting to Data Sources, under Connection, select Sample for the Query/
DataModel name called SalesQuery, and click Next.

For Interactive Reporting Job Properties, select Users running this job can define their own cycles
and actions, and click Next.

For Job Defaults, set General Properties and Locale and click Next.

In Permissions,

give the World group access to sample1.bqy.


a. Under Users, Groups, and Roles, click Update List.
b. Select a user and click

c. Under Selected Users, Groups, and Roles, select the user and click Edit.
d. On Permissions, select the access permissions level for the job and the job output, and
set the adaptive state.
l

Access to JobFull Control

Adaptive stateView

e. Click Finish.
Permissions is displayed.

Click Finish and Schedule.

On General Properties, in Name, enter Quarterly, and click Next.

10 On Job Parameters, click Next.


11 On Cycles, by Add another cycle to this job, click Go.
12 Define a cycle:
l

Under Define Cycle, in Cycle Name, enter Weekly.

Under Add a(n) (blank) Action to this Cycle, select Email Document, and click Go.

13 On Add/Modify Action: Email Document, in To, enter your email address.


14 Select Send File and/or Send Results, and click OK.
15 On Define Cycle, click OK.

272 Using Interactive Reporting Jobs

16 On Cycles, select Save Job Parameter Name, select Personal from the drop-down list, enter a name
in the box, and click Next.

17 On Time Events, select Define when to run this job starting with, and select A New Recurring Time
Event, and click Next.

18 On Define Event:
l

In Name, enter a name.

In Days to Run, select By Quarter.

Click Next.

19 Under Notification, select Display notification in Schedule Module, and click Finish.
The job is now scheduled to run.

Example: Importing and Scheduling a Job 273

274 Using Interactive Reporting Jobs

10

Using Production Reporting


and Generic Jobs

In This Chapter
Overview .................................................................................................. 275
Prerequisites for Importing Jobs ........................................................................ 275
Job Properties ............................................................................................ 276
Generic Job Properties................................................................................... 286
Modifying Production Reporting and Generic Job Properties ........................................ 287
Setting Production Reporting and Generic Job Parameters .......................................... 288
Output Options for Scheduling Jobs.................................................................... 288
Working with Secure Production Reporting Jobs ...................................................... 290
Supporting Exceptions in Production Reporting or Generic Programs............................... 292
Setting Priority on Output Programmatically........................................................... 293

Overview
Production Reporting jobs are created with Oracle Hyperion SQR Production Reporting Studio.
Generic jobs are created using applications with a command-line Production Reporting
interface. You can use the Explore and Schedule modules to import, run, and schedule
Production Reporting and generic jobs. You also use properties and parameters to further define
Production Reporting and generic job options.
This chapter explains the properties specific to Production Reporting jobs, generic jobs, and
Production Reporting documents (Production Reporting job output).
For basic importing procedures, see Chapter 4, Importing Artifacts. For basic job execution
and scheduling procedures, see Oracle Hyperion Enterprise Performance Management Workspace
User's Guide

Prerequisites for Importing Jobs


Information needed for importing a Production Reporting job:
l

Database connectivity, database type, and Production Reporting version needed to run the
Production Reporting program that you are adding (select from the list); for example,
Marketing Production Reporting v. 9
Files that the Production Reporting program references:

Overview 275

Include files (#INCLUDE commands)

Input data files (open for-reading commands)

Image files (print-image and declare-image commands)

Compile-time parameters (ASK commands) and runtime parameters (INPUT commands).


For secure Production Reporting jobs, the security organization of the program: which users
have access to which data and how the output is (divided) (bursted).

Job Properties
Subtopics
l
l
l
l
l
l

Dependency Analysis Commands


Advanced Options
Connectivity and Run Options
Parameters
Job Output
Compile Properties

The properties explained in the following topics pertain only to Production Reporting and
generic jobs. Properties that do not apply to generic jobs are noted. See Generic Job Properties
on page 286 for properties unique to generic jobs.
Production Reporting and generic jobs and other items, such as BQY jobs share many general
properties and advanced options. See Working with Properties on page 75.

To access properties:
1

From Explore, select a Production Reporting job.

Select File, and then Properties.

Dependency Analysis Commands


When importing Production Reporting job, the system can analyze your Production Reporting
program for dependencies. The analysis occurs if you request the system to scan for required
files and INPUT and ASK parameters. Analysis can be time-consuming if your Production
Reporting program is large.
The system examines these commands in your Production Reporting program:
l

INCLUDEIncludes an external source file in the Production Reporting report


specification; for example, a Production Reporting code file, charts.sqi, required by
stocks.sqr when it compiles
OPENOpens an operating system file for reading or writing; for example, an OPEN
statement that opens a file for sequential reading the data in the file, which is identified to
the program as 1:

276 Using Production Reporting and Generic Jobs

open 'stocks.dat'as 1 for-reading record=100


l

DECLARE-IMAGEDeclares the type, size, and source of an image to be printed; for


example:
declare-image control flow
type = eps-file
source = 'controlf.eps'
image-size = (321, 309)
end-declare

PRINT-IMAGEPrints an image in any report section (As with the declare-image


command, the print-image command accepts type, size, and source arguments.)
ASKRetrieves a compile-time substitution variable (Retrieval can be by user input,
command-line arguments, or entries in the @file on the command line.)
INPUTRetrieves a runtime variable (Retrieval can receive by user input, command-line
arguments, or entries in the @file on the command line.)
PRINT URL=...Prints the file found at the URL location, usually an image file (The file
is listed with the required files for the job.)
SECURERetrieves the secure tag

Advanced Options
The Security Tags Included property, which is read-only, indicates whether the job is secure.
Secure jobs can have only HTML output. All other advanced options are explained in Working
with Properties on page 75.

Connectivity and Run Options


These topics describe all data source connection properties and run properties for Production
Reporting jobs:
l

Connection and Run Options

Required Files

Required-File Addition

Advanced Production Reporting Options

Connection and Run Options


Use these options, which apply only to Production Reporting jobs, to configure or change the
database connections and the Production Reporting engine for the job.
Connection and Run Options

Descriptions

Data Source and Production


Reporting Engine

For selecting a data source and a Production Reporting engine


If the data source or engine that you need is not available, see your administrator.

Job Properties 277

Connection and Run Options

Descriptions

Database Connectivity

Use Job Service connectivity for this data sourceFor using the default username and password
Prompt for username/passwordFor prompting users to enter IDs and passwords at runtime
Use the username/password specified belowFor setting the username and password now on
import

Allow pass-through where end


users authentication system is
enabled for it

For enabling users to access data sources without additional credentials.

Required Files
When importing a file or job, you can identify and locate required files by scanning the
Production Reporting program, or you can manually enter the required files.
Note: Scanning the Production Reporting program to locate required files is possible only

during the import process.


As you identify and locate required files, they are added to the required files screen. For generic
jobs, you must manually enter required files.
Files that can be associated with a job or Production Reporting document and required for
successful execution:
l

For Production Reporting jobs, Include, Data, Image files, and INI file

For generic jobs, associated files used for running the job

Production Reporting documents and associated files used in viewing the document

This chapter concentrates on required files managed through a listing interface, namely files for
Production Reporting and generic jobs and Production Reporting documents. The INI file and
the custom-form required files are managed through another interface.
Note: Scan for required files before manually entering required files, because the scanned results

replace the required files list. If duplicate required files are listed, you must delete the extra
files.
Table 82

Job Properties

Job Properties

Descriptions

Name

Required-file name
The local file icon next to the name indicates that the file is on your local system.

Location

Required-file path
If the location is not listed, you must find the file by selecting Modify or delete the file.

278 Using Production Reporting and Generic Jobs

Job Properties

Descriptions

Type

The type (INCLUDE, IMAGE, DATA), as determined by the system


Manually entered JPEG, GIF, and HTML files are given the IMAGE type. You must select a type for other manually entered
files. All files must have a type before you can continue the importing process.

Action

RetrieveOpen any type of required file


ReplaceReplace the file with one selected from your local computer or Reporting and Analysis Framework repository
DeleteDelete the file
ModifyBrowse the local system for files that the system could not locate

Add Files
Manually

Default method to locate required files for a job

Note: Scanning
is available only
during the import
process.

You can enter each required file separately or zip the required files and enter the zip file manually.Reporting and Analysis
Framework extracts the zipped files and adds them to the required files summary list.
Scan Folders Specified in Preferences The Production Reporting program scans listed folders for required files.
Files not located are listed on the summary screen with the File not found message under location. Locate missing
files by selecting Modify.
Scan All of Oracle Hyperion Reporting and Analysis The Production Reporting program is scanned for required
files, and files in the Reporting and Analysis Framework repository are listed on the required files summary list.
If your program uses variables for file names in the OPEN, DECLARE-IMAGE, or PRINT-IMAGE commands, you receive
a warning message that the system cannot find the files unless you provide their names. Ignore the message, if you
enter the required files manually or if the variables point to files that reside on the Job Service numbers. Otherwise,
exit the import process and modify your Production Reporting program.

Required-File Addition
Browse your local system or the repository for required files to add manually.
Table 83

Add Required File Parameters

File Parameters

Descriptions

Add File from my PC

Add a file from your local hard drive

Add File from the Repository

Add a file from the database

Browse

Click to search files

Advanced Production Reporting Options


Advanced Production Reporting options apply only to Production Reporting jobs. For more
information on command-line flags and the SQR.ini file, see Oracle Hyperion SQR Production
Reporting Developer's Guide Volume 2: Language Reference.

Job Properties 279

Advanced Options

Description

Compile

Compile the program


Benefits:

Command-line flags for Job


Execution

Save time later when running the job

Validate SQL ASK parameters

Check program validity

Optional command-line flags


Some flags can be over-ridden by job-output option formats and demand-paging options, for example, burst and -printer.XX where XX is a format type.
This command-line flag option is unavailable: -EH_CSVONLY.
The system accepts 250 characters on the command line.

Use SQR.ini from File


System on Job Factory Host

Use the SQR.ini file location

Custom SQR.ini

Path to a custom SQR.ini file


Browse for the file locally or in the repository.
l

Add File from my PCSelect a local file.

Add File from the RepositorySelect a file from the database.

Enable search indexing

Allows keywords generation during job execution. This is in support of searching for Production Reporting
jobs.

Persist foreground job


output in repository when
running this job

Stores output in the repository.

Allow Job Runners the


option to change the
persistence option

When this is selected, Persist foreground job output when running this job is available to users when
running the job in real time.

Parameters
Production Reporting jobs have two parameter types, ASK and INPUT. ASK parameters
(variables) are used at compile time. INPUT parameters (variables) are used when the job is
executed and are displayed as prompts when users run the job. You can add ASK and INPUT
parameters to the parameter list. Only Production Reporting jobs have ASK parameters.
Production Reporting and generic jobs can have INPUT parameters. Further define a parameter
by selecting Modify for the parameter. Also select custom forms for user input of parameters.

Parameter Settings
Use Parameters to view scanned parameter or manually enter new ones.Table 84 details the
define parameter properties.

280 Using Production Reporting and Generic Jobs

Table 84

Parameter Properties

Parameter Properties

Descriptions

Manually entering parameters

Default method for entering ASK and INPUT parameters . See Dependency Analysis Commands
on page 276(Parameters are listed as you add them.)

Scanning job and reading


parameters from the Production
Reporting code

Option to enable automatic scenery of the Production Reporting job and the INPUT and ASK
parameters list

Available during the import


process.
Add another parameter to this job

Select INPUT or ASKand click GO. See INPUT Parameters on page 281.

Prompt

The prompt for values for the parameter

Display

The display format (Text, SQL Choice, Choice Box) for the parameters (Default is Text.)

Default Value

Default value for the parameter

Modify

Select to modify these properties for each parameter: prompt, display format, and default value

Arrow icons

Arrows to reorder the parameter. (The parameters are processed in the order that they are displayed
on this list.)

Garbage can icon

Select to delete the parameter.

ASK Parameters
ASK parameters can be entered as text or as an SQL query.
Table 85

ASK Parameter Properties

Parameter Properties

Descriptions

Display parameter on form as:

Select a parameter display type:


l

Text Entry

Choice of Values obtained from SQL Query

Prompt

The prompt for the parameter

Default value

For entering a default value or allowing users to change the value (text entry only)
The system requires a default value or section of End-user can change value.

End-user can change value

For allowing users to enter default values during runtime

SELECT/FROM/WHERE

SQL commands for retrieving the parameter list (SQL query only)

INPUT Parameters
INPUT parameters can be entered as text, predetermined values, or an SQL query.

Job Properties 281

Table 86

INPUT Parameter Properties

Input Parameter
Properties

Descriptions

Display parameter on
form as:

Select a parameter display type:


l

Text Entry

Choice of Pre-Determined Values

Choice of Values Obtained from SQL Query

Prompt

Prompt for the parameter

Data Type

Data type (text, numeric, or date; default is text)

Presentation

Presentation format: drop-down list, option buttons, or list box (Pre-determined and SQL query only)

Default value

Enter a default value or allow users to change the value (predetermined and text entry)
If Value optional is unavailable, the system requires a default value or requires that End-user can change
value is selected.
When $FIXED_USERNAME is selected, Value optional and End-user can change value are disabled.

Value optional

Allows the parameter to have no default value and enabling users to execute jobs with no value for the
parameter

End-user can change


value

Allows users to enter default values during runtime


If no default is specified and this option is selected, users must specify default values.
When this option is selected, the allow multiple values field is selectable (predetermined and SQL query only).

Allow multiple values

Allows multiple values (list box presentation only)


If multiple values selected are used to create dynamic selection criteria within the Production Reporting
program, the program must be designed to construct a WHERE clause.

Validation Type

Validation type (text only).

Validation Mask

Standard or custom validation mask (text only)

List Values

Values moved to the list with the right-facing arrows (predetermined only)
Delete values by selecting them in the list and selecting the left-facing arrows.

SELECT/FROM/WHERE

SQL commands for retrieving the parameter list (SQL query only).

Custom Forms
You can select a custom JSP parameter form or use the standard form for INPUT parameter
intake when the job is run. Parameter forms JSPs with input fields. They can also be more
complex, invoking JavaScript or applets. You can select a customized parameter collection form
developed by your company.
The assigned form is stored in the repository. You can assign a custom form from your local
system or from the repository.

282 Using Production Reporting and Generic Jobs

Custom Form Options

Descriptions

Standard Form

Default HTML parameter form, which is displayed only when properties are being modified

Custom Form

Upload the custom-form file by clicking ADD (next to Custom Form) and browsing to it

Required Files

Add supporting files, such as images, used by the selected form


NameRequired-file name
LocationRequired-file path (The icon next to the name indicates that the file is on your local system.)

Action

ReplaceReplace the file with one selected from your local system or the repository
DeleteDelete the file

Add Files Manually

Add required files by clicking Go.

Parameter List Options


INPUT Parameter List Options

Descriptions

Smartform allows user to choose a Parameter list

Allow users to choose parameter lists at runtime

Smartform allows user to save as Job Parameter

Allow users to save a parameter for values entered in the input fields

Job Output
HTML format is always selected for an output format. You can add additional output formats
by selecting them or listing them in the text box.

Job Properties 283

Output Options
Table 87

Output Options

Output
Options

Descriptions

Output
Options

Output formats generated from your Production Reporting program:


l

HTML

Interactive Reporting Data (bqd)

Smart View

Adobe Acrobat

PowerPoint

PostScript

HP Printer

Excel

XML

Comma Delimited

Line Printer

Word

Excel

HTML is the default.


Values entered in other are stored as a custom property.
Formats selected here override output formats specified in other Production Reporting Command-Line Option interfaces.
Note: SPF output is used to show or hide SPF output, which is always generated, in the output listing.

Demand Paging
Demand paging offers options for splitting, or bursting, the report into separate files for better
performance. By bursting a report, you avoid downloading the report in its entirety into the
browser.
For secure Production Reporting jobs, select an HTML Demand Paging option according to
how the report divides the output among users or groups.
Demand paging is for Web output types which include HTML, BQD, XLC, and CSV. Printed
output types include PDF, SPF, PS,LP, and HP.
Table 88

Demand Paging Options

Demand Paging Options

Descriptions

Write the entire report as


one file

Write report output to one HTML file (Not available for a secure Production Reporting job)

284 Using Production Reporting and Generic Jobs

Demand Paging Options

Descriptions

Write a separate file every


__ pages

Create an HTML file for every N pages


For example; if you enter 1, an HTML file is created for every report page; if you enter 20, an HTML file is
created for every 20 pages.
Default: An HTML file for every page in the report

Write a separate file


based on table of contents
level

Create HTML files for the table of contents


If you enter 1, a separate HTML file is created for each level 1 entry in the table of contents. If you enter 2,
an HTML file is created for each level 1 and level 2 entry.
Default: An HTML file for each level 1 entry
Note: If no table of contents exists, the report is saved as one HTML file.

Advanced Output Options


Table 89

Advanced Output Options

Advanced Output Options

Description

Allow users to add job output to a Personal Page

Allows users to embed job output contents (HTML only) in personal pages

Command-line flags for Job Output

Command-line flags to be used in output bursting.

Auto delete job outputs after

Defines when to delete job output automatically

Compile Properties
You can compile Production Reporting programs before you run them. All precompile programs
recompile if the INCLUDE file is modified.

Compile Properties

Descriptions

Compile-Time flags

Command-line flags for use at compile time

Database user name

Username to access the database

Database password

Password for the username

ASK parameters

Modifes default values for ASK parameters required by the Production Reporting job

An Production Reporting document is a printer-independent file format that accommodates all


Production Reporting graphical features, including fonts, lines, boxes, shaded areas, charts, bar
codes, and images. Production Reporting portable files have a default extension of SPF or SNN
(for multiple reports).This file format is very useful for saving report output. Production
Reporting documents can be distributed electronically and read with the Production Reporting
viewer. You can decide later where to print a document.

Job Properties 285

Generic Job Properties


Subtopics
l
l
l
l

Generic Job Output Options


Required Files for Generic Jobs
Database Connectivity for Generic Jobs
Output Options for Generic Jobs

Most generic job properties and Production Reporting job properties are the same. General
properties, advanced options, and parameter properties are the same except where noted in the
Production Reporting Job Properties section.
Job input and output properties are unique to generic jobs and are explained in the following
topics.

Generic Job Output Options


If the application that you need to run your program is not available, see your administrator to
configure a job service with the application that you need.
Generic Job Output Options

Descriptions

Job Factory Application

Application that runs the program


If the required application is not on the list, a job service must be configured for the application before
you proceeding with the job setup. Contact your system administrator to configure the application.

Command-line flags for Job


Execution

Command-line flags to be passed to the application

Required Files for Generic Jobs


Identify and locate required files by manually entering the required files. As you identify and
locate required files, they are added to the required files page.
Properties of
Required Files

Descriptions

Name

Required-file name
The icon next to the name indicates that the file is on your local system.

Location

Required-file path
If the location is not listed, you must find the file by clicking the modify icon or delete the file.

286 Using Production Reporting and Generic Jobs

Properties of
Required Files

Descriptions

Action

RetrieveDownloads the file


ReplaceReplaces the file with one from your local computer or the Reporting and Analysis Framework repository with
the same name
DeleteDeletes the file

Add Files
Manually

Method for locating required files for a job


Enter files separately or zip them and enter the zip file name.Reporting and Analysis Framework extracts the zipped
files and adds them to the required file summary list.

Database Connectivity for Generic Jobs


DB Connectivity for Generic Jobs Properties

Descriptions

User name

User name for the data source

Password

Password for the data source

Database Connect String

Database connect string for the data source

Allow pass-through where end users authentication system is


enabled for it

Allows users to access data sources without entering credentials

Output Options for Generic Jobs


Output Options for Generic Jobs

Descriptions

Display this primary output file after


running the job:

Primary output format


Separate formats with semicolons; for example, *.html; *.pdf. When a format matches,
remaining formats are ignored.
Default: All formats are shown

Output types generated by this job

Value to store as the property SYS_OUTPUTFILETYPE.


Use API in your application to access this property.

Auto-delete output after the job is run

Defines when job output is deleted automatically

Modifying Production Reporting and Generic Job


Properties
The properties of Production Reporting and generic jobs can be modified. See Working with
Properties on page 75.
Modifying Production Reporting and Generic Job Properties 287

The Output Summary section, from which you can delete output, is available when you modify
properties.
SQR and Generic Job Properties

Descriptions

Last Run Date

Lists the date the job was last run.

Output Formats

Lists the output formats generated.

Delete Selected

In the first column, select dates, then click Delete Selected to delete.

Page

Navigates through multiple pages of output by entering a page in this text box, or by clicking the arrows.

Setting Production Reporting and Generic Job


Parameters
You must set the necessary runtime values for a job before the job is run or scheduled. You can
save the values as personal job parameters, so they can be used again.

To set job parameters for Production Reporting and generic jobs:


1

Run or schedule a job.

See Running Jobs on page 243 or Scheduling Jobs on page 241.

Enter the necessary runtime values in the Set Values section if you are running the job or on Parameters
if you are scheduling the job.

You must specify values for all ASK parameters unless you specified default values when
importing the job or unless you have a saved job parameter in the Job Parameter list.

Optional: To save the values as personal job parameters, click Save and enter a name for the parameters.

Output Options for Scheduling Jobs


Subtopics
l
l

Email Notification Options


Output Directory Options

The standard job output options are explained in Scheduling Jobs on page 241. Production
Reporting jobs offer additional email notification options and output directory options.

Email Notification Options


Production Reporting jobs offers email notification options.

288 Using Production Reporting and Generic Jobs

Email Notification
Options

Descriptions

Email Address(es)

Email addresses for sending status reports; separate with semicolons, colons, space characters, commas, or
lines.

Attach job outputs to


email messages in
these formats

Select formats for email attachments:

Zip Options

Default: HTML
l

HTMLDefault

Comma Delimited

Line Printer

Include Dependent FilesIncludes all email attachment files dependent on this job.

SPF

Interactive Reporting Data

Smart View

Adobe Acrobat

Postscript

HP Printer

OtherEnter a file type.

Zip file options:


l

Do not compress attachment filesZip file not created

Combine all attachments into one Zip fileZip file contains HTML and selected file formats

Combine only HTML and Graphics into Zip fileZip file contains HTML and selected graphic file formats

Output Directory Options


Table 90

Output Directory Options

Output Directory Options

Descriptions

Output Directory

Automatically save job output in the directory containing the job


When you select an output directory, job output is saved to the selected directory. (Your administrator
configures the directory list.)

Save output in these


formats

Save job output in additional formats

Include dependent files

Include all files dependent on your job.

Status Report

Receive all status reports

HTML is automatically generated. These options work only if you select a directory from the list.

Default: Receive status reports only when errors occur


Email Status to

Email addresses for sending status reports; separate with semicolons, colons, space characters, commas,
or lines

Output Options for Scheduling Jobs 289

Note: You can list all output formats using a delimiter (;) in the Other Formats text field for

Schedule Output Properties.


Note: The Save to Output Directory section is displayed only if the administrator has configured

an output directory.

Working with Secure Production Reporting Jobs


Subtopics
l
l
l
l
l

Access Privileges on Secure Production Reporting Jobs


Security Mode
Recommendations for Security
Programmer Conventions
Viewing Security Information

Secure and insecure Production Reporting jobs are handled differently. For secure jobs, security
tags are applied to report sections. The following topics explain what secure jobs are and how
their security is accomplished and protected.
If the Production Reporting programmer applies security tags to report sections, thereby
restricting access to the sections to specified users, the report is secure. Production Reporting
produces only HTML output (with images) for a secure report. For details on programming a
secure Production Reporting report, see your Production Reporting documentation.
When a secure Production Reporting job is run, the security tags are written to the Production
Reporting. When the document is executed, each resulting HTML file is given a security tag
assuring that only users authorized to see all data in the file can see the file.
It is important to set the bursting (or demand paging) options appropriately for a secure report,
so the resulting files correspond to the way that the Production Reporting program divided data
among users. If you do not burst the Production Reporting document correctly, security is
preserved, but some users may not have access to data that they should be able to see.
The Production Reporting document written by running a Production Reporting program can
be imported into the repository. Executing a secure document yields the same output with the
same access privileges as executing the secure job.

Access Privileges on Secure Production Reporting Jobs


Access privileges on output files are derived, first, from the users access when the job is executed
or from the job output access privileges, if the privileges are set. Each output file may also have
an associated set of security tags. Job owners can change the access privileges on SPF or output
files. In a Production Reporting document, which contains all data, broadening access means
relaxing security on the report.
Users need all these privileges to see output files:

290 Using Production Reporting and Generic Jobs

View access on the report folder

View access on the files

Access granted by the Production Reporting security tags of the output files (The access is
derived from the security tags in the code.)

Security tags are not checked when job output is deleted. Only normal access privilege checking
is performed. Thus, a job output file owner can delete the file, regardless of whether the security
tags enable the owner to view the file contents. If a secure report creates data file through a
Production Reporting OPEN statement, only the job owner has view access to the file. The owner
can relax security for the file.

Security Mode
Every item in Production Reporting has a security mode that is on or off.
The security mode for all items derived from a secure Production Reporting file is on. These
items include the Production Reporting document, all output files, the Production Reporting
ProgramOutput item, and the SPFFileOutputCollection item. If a file is secure, this information
is displayed in Properties (on the Advanced tab).
It is possible to create a secure Production Reporting program that produces secure and
nonsecure output. The Production Reporting program can be coded so that some pages are
output without security, while the rest are secure. In this case, users with access to the output
files through normal EPM Workspace access control see the nonsecure output pages and the
secure pages that they are authorized to see. The ability to create secure and nonsecure pages
within a secure Production Reporting program is governed with the security command in
Production Reporting.
You can create on replace a version of a secure report, but the security mode for the new version
and the original must match.

Recommendations for Security


Recommendations for ensuring the security of secure Production Reporting jobs and documents
in EPM Workspace:
l

Establish dedicated user accounts for secure Production Reporting or SPF jobs.

Use a dedicated account for one secure report or a group of related secure reports.

Ensure that secure jobs are run only from dedicated accounts.

Limit access to the dedicated account to as few people as possible, because everyone with
access to it can import secure jobs and access the Production Reporting document, which
contains all data.

Working with Secure Production Reporting Jobs 291

Programmer Conventions
Production Reporting has built-in conventions for designating security tags to EPM Workspace
users or groups. A security tag that begins with u# represents a user. A security tag that begins
with g# represents a group.

Viewing Security Information


Secure Production Reporting programs tailor their output for multiple users and restrict access
accordingly. You can determine whether a file related to the Production Reporting program is
secure by viewing its security mode.
For secure Production Reporting file and its related files, the Secure mode property is set to on.
The related files include Production Reporting output files, document collections, and
Production Reporting documents output collections.

To view the security mode of a file:


1

Select the file, and Modify.

Open the Advanced Options section.

If the file is secure, the Security Tags Included box is checked.

Supporting Exceptions in Production Reporting or


Generic Programs
Subtopics
l
l

Production Reporting Programming


Generic Report Programming

The following topics are for Production Reporting and generic report programmers, who
support exception notifications to users. (Users can receive email notifications or see a graphic
indicator on the Exceptions Dashboard on personal pages.)

Production Reporting Programming


For Production Reporting programs to support exceptions, they must include these lines:
open 'output.properties' as 0 for-append record=32767:vary
write 0 from 'exception.default=on'
write 0 from 'exception.default.text=<exception text>
close 0

292 Using Production Reporting and Generic Jobs

Generic Report Programming


For generic jobs or files to support exceptions. Programmers must use the Oracle Hyperion
Enterprise Performance Management Workspace API to configure exception reporting through
the job output properties, exception present and exception text.

Setting Priority on Output Programmatically


In Production Reporting programs, you can set the output as high priority. In Explore module
listings, users see the high-priority icon next to any high-priority job output or version. Users
can also sort by priority (normal or high).
To set priority to high on the output, a program writes the string rating=high-priority to
the output.properties file used by the job service. This code excerpt accomplishes this
objective:
open 'output.properties' as 0 for-append record=32767:vary
write 0 from 'rating=high-priority'
close 0

Setting Priority on Output Programmatically 293

294 Using Production Reporting and Generic Jobs

11

Using Custom Parameter Forms


for Production Reporting Jobs

In This Chapter
Customizing Parameter Forms .......................................................................... 295
Parameter Form Elements............................................................................... 298
Standard Parameter Form............................................................................... 301
Standard Parameter Form Example .................................................................... 302
Parameter Forms: Example and Tip .................................................................... 305

Customizing Parameter Forms


Subtopics
l
l
l
l

Parameter Form Process


Assigning Parameter Forms Jobs
Assigning the Standard Form
Editing Parameter Forms

A Production Reporting job uses a parameter form to obtain INPUT parameter values at
runtime. This section explains how to customize parameter forms.
Note: The parameter forms are in JSP. Customizing the standard form provided with

Production Reporting requires a working knowledge of JSP and Java.


By default, when you run a Production Reporting job or create or modify a parameter list,
Reporting and Analysis Framework generates a standard form to collect parameter information.
You can customize the form. For example, some jobs may require a more sophisticated field
layout, or your organization may require certain conventions.
You can associate custom parameter forms with jobs at runtime. You run or schedule a job that
is associated with a custom form, which is displayed instead of the standard form.
A parameter form is a JSP containing input fields. Forms can also be more complex, invoking
JavaScript or an applet.

Customizing Parameter Forms 295

Parameter Form Process


The parameter form associated with a job or the standard form is displayed when you perform
any of these actions:
l

Select Run Job from the job shortcut menu

From an item list, select the job name

Create or modify parameter list while scheduling the job

After you submit a completed form for execution, Reporting and Analysis Framework performs
these actions:
1. Validates parameters for which validation is defined
2. Processes the form
The form can collect parameter values and database logon information, as required by the
job. For scheduling, the form can also collect the parameter list name and description.
3. Creates or modifies the parameter list or runs the job, as applicable
4. If the job was run, retrieves and displays job output

Assigning Parameter Forms Jobs


This procedure applies only to custom parameter forms created for use in Production Reporting.
Note: Custom parameter forms created prior to Production Reporting are in HTML and must

be recreated as JSP forms for use with Production Reporting.

To assign a custom parameter form to a Production Reporting job:


1

In the browser, navigate to the job, and right-click the job name.

Select Properties from the top menu.

Select Custom Form, and browse to the file to use.

If your form uses additional files, such as GIFs, select Show Required Files.

When you finish changing form properties, click OK.

Assigning the Standard Form


After assigning a custom form to a job, you can reassign the standard form.

To assign the standard form to a job:


1

In the browser, navigate to the desired Production Reporting job, right-click the job name and select

Properties.

Select Production Report and Parameters from the top menu.

296 Using Custom Parameter Forms for Production Reporting Jobs

Select Standard Form.

Select OK.

Editing Parameter Forms


Edit a custom form before you assign it to a job. To edit a form after it is assigned to a job,
download it, change it, and upload it to the repository. An edited standard form is uploaded as
a custom form.
Production Reporting parameter forms contain JSP tags or scriptlets that graphical HTML
editors cannot display correctly. However, the tags are designed so that you can use some
graphical HTML editors to modify layouts. Before using an editor, ensure that it does not alter
code.
Using an editor to modify a parameter form requires knowledge of Production Reporting
parameter-form API and JSP tags. When editing a parameter form, keep the scriplet code blocks
together. Otherwise, it may not work correctly.
To edit a parameter form, use a nongraphical HTML editor, such as Macromedia Homesite. Be
careful not to alter the JSP tags.

To edit a parameter form:


1

In the browser, navigate to the Production Reporting job, right-click the job name and select
Properties.

From the top menu, select Parameters.

Select Custom Form.

Select Modify, select Add next to Custom Form.

Download the standard form, or browse your PC or the repository for a custom form.

If editing the standard form, specify a location for saving an editable copy, and enter a name for the
new custom form.

Edit the form locally.

See Parameters on page 280.

Click OK to save changes.

Customizing Parameter Forms 297

Parameter Form Elements


Subtopics
l
l
l

Element Types
Required Elements
Nonrequired Elements

You create a parameter form as an HTML file that contains special elements. Before displaying
a parameter form, Reporting and Analysis Framework interprets and processes elements that it
encounters in the form. Typically, Reporting and Analysis Framework processes an element by
replacing it with the value indicated by the element. For example, it replaces <
%=targetFormParameter.getJobName()%> with the job name.
Note: Parameter form elements are case sensitive.

Element Types
The main element types of parameter forms:
l

Basic

Conditional

Looping

Basic Elements
Basic elements have the form <%=(bean).getxxx()%>>.
Example: <%=targetFormParameter.getJobName()%>.

Conditional Elements
A conditional element has the standard JSP or Java conditional code:
if () {}
else {}

You can insert HTML or applicable parameter form elements between the start and end tag.
Production Reporting evaluates whether the condition indicated by the has Value argument is
true or false. If true, the enclosed HTML is included in the displayed form, If false, the HTML
between the start and end tags is ignored.

Looping Elements
Looping elements have this form:
<getxxxLoop>

298 Using Custom Parameter Forms for Production Reporting Jobs

...
</getxxxLoop>.

An example is getParameterPickListLoop. You can insert HTML elements between the start
and end tags. When Reporting and Analysis Framework processes the elements, it processes the
loop contents until the loop finishes. The loop termination condition depends on the element.

Required Elements
A parameter form provides required elements and elements to use if, for example, you are setting
up a parameter pick list or must access information from a database.
Required elements include elements that identify a file as a parameter form file, return parameter
information, and return the URL to use when you submit the form for processing.
Table 91

Required Elements

Elements

Function

setParameterAskCond(String n)

Selects the Nth ASK parameter, where n is from 1 to the total number of ASK
parameters

getParameterFieldName()

Returns the name of the HTML form field for setting the value of the parameter selected
in ParameterInputCond or ParameterAskCond

setParameterInputCond(String n)

Selects the Nth INPUT parameter, where n is from 1 to the number of INPUT parameters

getParameterName()

Returns the current parameter name

getParameterValue()

Returns the value of the current parameter or, for a parameter list, the current value
of the parameter

The following topics show code snippets using the required elements.

Name Specification Elements


The element that follows specifies the import file name for the parameter form.
<jsp:include page=jsp/shared/formparameterFormJavaScript.jsp'flush=true>>

Parameter List Elements


Scheduling a job requires the creation of a parameter list, which has a name and description and
contains a value for each parameter associated with the job. When scheduling a job, you select
a parameter list, which provides the set of parameters that Oracle Hyperion Reporting and
Analysis Framework uses when it runs the job.

Parameter Display Elements


The following code snippet shows the use of elements for handling parameter values. If your
form uses a parameter pick list, see the sample code at the end of this topic.
Parameter Form Elements 299

<getParameterInputCond hasValue="1">
<!-- 1st parameter -->
<!-- Name of parameter -->
<TD VALIGN="MIDDLE">
<FONT face="Arial, Helvetica, sans-serif" size="-1">
<B><getParameterName/></B>
</FONT>
</TD>
<TD VALIGN="MIDDLE" COLSPAN="2">
<INPUT TYPE="text" NAME="<getParameterFieldName/>"
VALUE="<getParameterValue/>" SIZE="30">
</TD>
</getParameterInputCond>

The <getParameterInputCond> and <getParameterAskCond> tags select the INPUT or


ASK parameter that is used to resolve the <getParameterName/
>,<getParameterFieldName/> and <getParameterValue> tags. You must set the
hasValue argument from 1 to the number of INPUT or ASK parameters.

Nonrequired Elements
For parameter forms, you can use nonrequired and required elements.
Table 92

Nonrequired Elements

Elements

Function

getEmbedParameterValidationRoutines()

Adds the JavaScript parameter validation routines to the form

isFormUsesParameterValidationCond()

Returns true if the current job requires JavaScript validation


routines

isParameterValidationCond()

Tests the current parameter for a validation function

isParameterValidationMaskCond()

Returns true if a mask is associated with the validation function


of the current parameter

resetParameterPickList()

Initializes the static or dynamic choice options of the current


parameter and prints an error message if initialization fails

isParameterMultiValuesCond()

Returns true if the parameter accepts multiple values

see getParameterType()

Returns the current parameter type number:


Text edit = 0
Drop-down list = 1
Radio button = 2
List box = 3

300 Using Custom Parameter Forms for Production Reporting Jobs

Elements

Function

getParameterType()

Returns the current parameter type number:


Text edit = 0
Drop-down list = 1
Radio button = 2
List box = 3

getParameterListPublisherDefaultsFieldName()

Returns the name of the HTML form field used for the Publisher
Defaults parameter list

processParameterPickListLoop()

Iterates through a parameter pick list values.

getPickListParameterValue()

Used within a loop construct for


processParameterPickListLoop()
Returns the next value in a parameter pick list;

getParameterPickListValueSelected(String
presentationType)

Must be used within a Java loop construct. Returns "selected"


if the next value in the pick list is the current value for the
parameter;
Note: You can set presentationType to "select" or
"check." For a pick list for a parameter with only a few values,
you can use buttons to display the options. In this case, setting
the presentationType to "check" returns "checked." You
can use this option to indicate which option is the current value
for the parameter

getParameterValidationMask()

Returns the mask associated with the current parameter of the


validation function

getParameterValidationName()

Returns the name of the current parameter of the validation


function

getPublisherDefaultsParameterValue()

Returns the value of the current parameter in the Publisher


Defaults parameter list

isRequiredParameterCond()

Returns true if the current parameter is required

getSaveDefaultsCheckboxFieldName()

Returns the name of the HTML form field that represents the
save default box

isShowFormsParameterListCond()

Determines whether to display parameter lists

isShowFormsSaveMyDefaultsCond()

Determines whether the publisher selected save as my


defaults

isShowParameterListPublisherDefaultsCond()

Returns true if the job is configured to display Publisher


Defaults

Standard Parameter Form


The standard parameter form for Oracle Hyperion SQR Production Reporting is in JSP. Notice
the required import tags in the standard form example. A JavaBeanIFormParameter View
Standard Parameter Form 301

statement is used to access all form APIs to obtain information regarding the form parameter
list.
Note: You can create a custom parameter form by modifying the standard form. Java and JSP

can be leveraged to enhance the form.

Standard Parameter Form Example


<%@ include file=/jsp/shared/common.inc%>
<%@ page import=com.brio.one.web.ui.JSPUtility, com.brio.one.web.browser.ui.*,
com.brio.one.web.ui.config.*, java.util.*%>
<jsp:useBean id=targetFormParameter scope=request
type=com.brio.one.web.ui.IFormParameterView/>
<!-This template is used for these purposes:
1) Run a job that requires parameters or database user information
2) Create a parameter list for a job
3) Edit a parameter list for a job
This template is used when there is no custom ONE/SmartForm associated with the job.
-->
<jsp:include page=/jsp/shared/form/parameterFormJavaScript.jsp flush=true/>
<TABLE border=0 width=98% cellpadding=0 cellspacing=0>
<TR>
<TD WIDTH=45><IMG <%=imgLocator.getSrcAltAttribute(request, space.gif)%>
WIDTH=45 HEIGHT=1 ALT=></TD>
<TD WIDTH=15></TD>
<TD WIDTH=160><IMG <%=imgLocator.getSrcAltAttribute(request, space.gif)%>
WIDTH=160 HEIGHT=1 ALT=></TD>
<TD WIDTH=100%><IMG <%=imgLocator.getSrcAltAttribute(request, space.gif)%>
WIDTH=10 HEIGHT=1 ALT=></TD>
</TR>
<TR>
<TD COLSPAN=4><IMG <%=imgLocator.getSrcAltAttribute(request, space.gif)%>
WIDTH=45 HEIGHT=12 BORDER=0 ALT=></TD>
</TR>
<!-- Start Display of Parameters -->
<%
if (targetFormParameter.isParameterCond()) {
// initialize the parameter loop
targetFormParameter.resetParameterLoop();
while (targetFormParameter.processParameterLoop()) {
if (!targetFormParameter.isParameterHiddenCond()) {%>
<TR>
<TD><IMG <%=imgLocator.getSrcAltAttribute(request, space.gif)
%> WIDTH=45 HEIGHT=5 BORDER=0 ALT=></TD>
<TD VALIGN=middle COLSPAN=3><IMG <
%=imgLocator.getSrcAltAttribute(request, space.gif)%> width=20 height=5 ALT=></
TD>
</TR>
<TR>
<TD COLSPAN=2><IMG <%=imgLocator.getSrcAltAttribute(request,
space.gif)%> WIDTH=45 HEIGHT=12 BORDER=0 ALT=></TD>
<!-- Name of parameter -->

302 Using Custom Parameter Forms for Production Reporting Jobs

<TD VALIGN=MIDDLE class=SystemDataText><


%=targetFormParameter.getParameterName()%>:</TD>
<TD VALIGN=MIDDLE COLSPAN=2>
<%
int type = targetFormParameter.getParameterType();
if (type == targetFormParameter.TEXT_EDIT) {%>
<INPUT TYPE=text CLASS=Inputfield onchange=onParamChange()
NAME=<%=targetFormParameter.getParameterFieldName()%> VALUE=<
%=targetFormParameter.getParameterValue()%> SIZE=30><%
}
if (type == targetFormParameter.DROPDOWN_LIST) {
targetFormParameter.resetParameterPickList(); %>
<SELECT class=DataFrameDrop NAME=<
%=targetFormParameter.getParameterFieldName()%> onchange=onParamChange() ><%
if (!targetFormParameter.isRequiredParameterCond()) {%>
<OPTION VALUE=></OPTION><%
}
while (targetFormParameter.processParameterPickListLoop()) {%>
<OPTION VALUE=<%=targetFormParameter.getPickListParameterValue()%> <
%=targetFormParameter.getParameterPickListValueSelected(select)%>> <
%=targetFormParameter.getHTMLEscapedCurrentPickListParameterValue()%> </OPTION> <%
}%>
</SELECT><%
}
if (type == targetFormParameter.LIST_BOX) {
targetFormParameter.resetParameterPickList();
if (targetFormParameter.isParameterMultiValuesCond()) {%>
<SELECT class=DataFrameDrop NAME=<
%=targetFormParameter.getParameterFieldName()%> onchange=onParamChange()
size=5><%
} else {%>

multiple

<SELECT class=DataFrameDrop NAME=<


%=targetFormParameter.getParameterFieldName()%> onchange=onParamChange() size = 5><
%
}
if (!targetFormParameter.isRequiredParameterCond()) {%>
<OPTION VALUE=></OPTION><%
}
while (targetFormParameter.processParameterPickListLoop()) {%>
<OPTION VALUE=<%=targetFormParameter.getPickListParameterValue()%> <
%=targetFormParameter.getParameterPickListValueSelected(select)%>> <
%=targetFormParameter.getHTMLEscapedCurrentPickListParameterValue()%> </OPTION><%
}%>
</SELECT><%
}

Standard Parameter Form Example 303

if (type == targetFormParameter.RADIO_BUTTONS) {
targetFormParameter.resetParameterPickList();
if (!targetFormParameter.isRequiredParameterCond()) { %>
<input type=Radio class=RadioButton
onchange=onParamChange() name=<%=targetFormParameter.getParameterFieldName()%>
value= checked><span class=RadioButtonText>No Selection Made</span><br><%
}
while (targetFormParameter.processParameterPickListLoop()) {%>
<input type=Radio class=RadioButton onchange=onParamChange() name=<
%=targetFormParameter.getParameterFieldName()%> value=<
%=targetFormParameter.getPickListParameterValue()%> <
%=targetFormParameter.getParameterPickListValueSelected(check)%>><span
class=RadioButtonText><%=targetFormParameter.getPickListParameterValue()%></span><br><
%
}
}
%>
<TD VALIGN=TOP COLSPAN=2></TR><%
}
if (targetFormParameter.isParameterHiddenCond()) {%>
<INPUT TYPE=hidden NAME=<%=targetFormParameter.getParameterFieldName()
%> VALUE=<%=targetFormParameter.getParameterValue()%>><%
}
}
}
%>
<TR>
<TD COLSPAN=4><IMG <%=imgLocator.getSrcAltAttribute(request,
space.gif)%> WIDTH=45 HEIGHT=12 BORDER=0 ALT=></TD>
</TR>
</TABLE>

All form parameter APIs are directly accessed through the Java bean; for example:
targetFormParameter.getParameterHame()

Use Java scriptlet tags to run Java code blocks within the tags; for example:
<% String start=abc;%>

Use a JSP expression embedded in HTML to resolve variables to values at runtime; for example:
<HTML>
<BODY>
The start of the alphabet is <%=start%>
</BODY>
</HTML>

Parameter form information can also be accessed through the parameter form APIs. This
example resolves the current value of the parameter name and display the name in the form:
304 Using Custom Parameter Forms for Production Reporting Jobs

<%=targetFormParameter.getParameterValue()%>

Parameter Forms: Example and Tip


The following code snippet shows tag use for parameter pick lists.
<!-- Parameter Pick List example -->
<%
if (targetForm.setParameterInputCond("1")) {%>
<SELECT NAME="<%=targetFormParameter.getParameterFieldName()%>"><%
targetFormParameter.restParameterPickList();
while(targetFormParameter.processParameterPickListLoop() {%>
<OPTION VALUE="<%=targetFormParameter.getParameterPickListValue()%>" <
%=targetFormParameter.getParameterPickListValueSelected("select")%>><
%=targetFormParameter.getParameterPickListValue()%>
</OPTION>
}%>
</SELECT><%
}
%>

Custom form can import JSPs and thus become more modular. For example, the standard form
example, includes a jsp include tag. The <jsp:include> tag is a standard JSP tag:
<jsp:includpage=/jsp/shared/form/parameterFormJavaScript.jsp flush=true/>

The preceding example causes the parameterFormJavaScript.jsp file to be imported and


executed with the standard form. Custom forms that include context, such as images, must be
defined in the required files section.

Parameter Forms: Example and Tip 305

306 Using Custom Parameter Forms for Production Reporting Jobs

Glossary

! See bang character.

activity-level authorization Defines user access to applications

#MISSING See missing data.

and the types of activities they can perform on applications,


independent of the data that will be operated on.

access permissions A set of operations that a user can

perform on a resource.
accessor Input and output data specifications for data-

mining algorithms.
account blocking The process by which accounts accept input

data in the consolidated file. Blocked accounts do not


receive their value through the additive consolidation
process.

ad hoc report An online analytical query that an end user

creates dynamically.
adapter Software that enables a program to integrate with

data and metadata from target and source systems.


adaptive states Interactive Reporting Web Client level of

permission.
adjustment See journal entry.

account eliminations Accounts which have their values set to

Advanced Relational Access The integration of a relational

zero in the consolidated file during consolidation.

database with an Essbase multidimensional database so that


all data remains in the relational database and is mapped to
summary-level data in the Essbase database.

account type A property that determines how an account's

value flows over time and its sign behavior. Account type
options can include expense, income, asset, liability, and
equity.
accountability map A visual, hierarchical representation of

the responsibility, reporting, and dependency structure of


the accountability teams (also known as critical business
areas) in an organization.
active service A service whose Run Type is set to Start rather

than to Hold.
active-active high availability system A system in which all the

available members can service requests, and no member is


idle. An active-active system generally provides more
scalability options than an active-passive system. Contrast
with active-passive high availability system.

agent An Essbase server process that starts and stops

applications and databases, manages connections from


users, and handles user-access security. The agent is referred
to as ESSBASE.EXE.
aggregate cell A cell comprising several cells. For example, a

data cell that uses Children(Year) expands to four cells


containing Quarter 1, Quarter 2, Quarter 3, and Quarter 4
data.
aggregate function A type of function, such as sum or

calculation of an average, that summarizes or performs


analysis on data.
aggregate limit A limit placed on an aggregated request line

item or aggregated metatopic item.

active-passive high availability system A system with active

members, which are always servicing requests, and passive


members that are activated only when an active member
fails. Contrast with active-active high availability system.

Glossary 307

aggregate storage database The database storage model

application server cluster A loosely joined group of

designed to support large-scale, sparsely distributed data


which is categorized into many, potentially large
dimensions. Upper level members and formulas are
dynamically calculated, and selected data values are
aggregated and stored, typically with improvements in
overall aggregation time.

application servers running simultaneously, working


together for reliability and scalability, and appearing to
users as one application server instance. See also vertical
application cluster and horizontal application cluster.

aggregate view A collection of aggregate cells based on the

levels of the members within each dimension. To reduce


calculation time, values are pre-aggregated and stored as
aggregate views. Retrievals start from aggregate view totals
and add up from there.
aggregation The process of rolling up and storing values in

area A predefined set of members and values that makes up

a partition.
arithmetic data load A data load that performs operations on

values in the database, such as adding 10 to each value.


artifact An individual application or repository item; for

example, scripts, forms, rules files, Interactive Reporting


documents, and financial reports. Also known as an object.

an aggregate storage database; the stored result of the


aggregation process.

assemblies Installation files for EPM System products or

aggregation script In aggregate storage databases only, a file

asset account An account type that stores values that

that defines a selection of aggregate views to be built into an


aggregation.

represent a company's assets.

alias table A table that contains alternate names for

members.

the allocation model that controls the direction of allocated


costs or revenue flow.

alternate hierarchy A hierarchy of shared members. An

attribute A characteristic of a dimension member. For

alternate hierarchy is based upon an existing hierarchy in a


database outline, but has alternate levels in the dimension.
An alternate hierarchy allows the same data to be seen from
different points of view.

example, Employee dimension members may have


attributes of Name, Age, or Address. Product dimension
members can have several attributes, such as a size and
flavor.

ancestor A branch member that has members below it. For

attribute association A relationship in a database outline

example, the members Qtr2 and 2006 are ancestors of the


member April.

whereby a member in an attribute dimension describes a


characteristic of a member of its base dimension. For
example, if product 100-10 has a grape flavor, the product
100-10 has the Flavor attribute association of grape. Thus,
the 100-10 member of the Product dimension is associated
with the Grape member of the Flavor attribute dimension.

appender A Log4j term for destination.


application 1) A software program designed to run a specific

task or group of tasks such as a spreadsheet program or


database management system. 2) A related set of dimensions
and dimension members that are used to meet a specific set
of analytical requirements, reporting requirements, or both.
application administrator A person responsible for setting up,

configuring, maintaining, and controlling an application.


Has all application privileges and data access permissions.
application currency The default reporting currency for the

application.
Application Migration Utility A command-line utility for

migrating applications and artifacts.

components.

assignment The association of a source and destination in

Attribute Calculations dimension A system-defined dimension

that performs these calculation operations on groups of


members: Sum, Count, Avg, Min, and Max. This dimension
is calculated dynamically and is not visible in the database
outline. For example, using the Avg member, you can
calculate the average sales value for Red products in New
York in January.
attribute dimension A type of dimension that enables analysis

based on the attributes or qualities of dimension members.


attribute reporting A reporting process based on the attributes

of the base dimension members. See also base dimension.

308 Glossary

attribute type A text, numeric, Boolean, date, or linked-

base entity An entity at the bottom of the organization

attribute type that enables different functions for grouping,


selecting, or calculating data. For example, because the
Ounces attribute dimension has the type numeric, the
number of ounces specified as the attribute of each product
can be used to calculate the profit per ounce for that
product.

structure that does not own other entities.

authentication Verification of identity as a security measure.

Authentication is typically based on a user name and


password. Passwords and digital signatures are forms of
authentication.
authentication service A core service that manages one

authentication system.
auto-reversing journal A journal for entering adjustments that

you want to reverse in the next period.


automated stage A stage that does not require human

intervention; for example, a data load.


axis (1) A straight line that passes through a graphic used

for measurement and categorization. (2) A report aspect


used to arrange and relate multidimensional data, such as
filters, pages, rows, and columns. For example, for a data
query in Simple Basic, an axis can define columns for values
for Qtr1, Qtr2, Qtr3, and Qtr4. Row data would be retrieved
with totals in the following hierarchy: Market, Product.

batch calculation Any calculation on a database that is done

in batch; for example, a calculation script or a full database


calculation. Dynamic calculations are not considered to be
batch calculations.
batch file An operating system file that can call multiple

ESSCMD scripts and run multiple sessions of ESSCMD. On


Windows-based systems, batch files have BAT file
extensions. On UNIX, batch files are written as a shell script.
Batch Loader An FDM component that enables the

processing of multiple files.


batch POV A collection of all dimensions on the user POV of

every report and book in the batch. While scheduling the


batch, you can set the members selected on the batch POV.
batch processing mode A method of using ESSCMD to write

a batch or script file that can be used to automate routine


server maintenance and diagnostic tasks. ESSCMD script
files can execute multiple commands and can be run from
the operating system command line or from within
operating system batch files. Batch files can be used to call
multiple ESSCMD scripts or run multiple instances of
ESSCMD.
block The primary storage unit which is a multidimensional

backup A duplicate copy of an application instance.

array representing the cells of all dense dimensions.

balance account An account type that stores unsigned values

block storage database The Essbase database storage model

that relate to a particular time.

categorizing and storing data based on the sparsity of data


values defined in sparse dimensions. Data values are stored
in blocks, which exist only for sparse dimension members
for which there are values.

balanced journal A journal in which the total debits equal the

total credits.
bang character (!) A character that terminates a series of

report commands and requests information from the


database. A report script must be terminated with a bang
character; several bang characters can be used within a
report script.
base currency The currency in which daily business

transactions are performed.


base dimension A standard dimension that is associated with

one or more attribute dimensions. For example, assuming


products have flavors, the Product dimension is the base
dimension for the Flavors attribute dimension.

Blocked Account An account that you do not want calculated

in the consolidated file because you want to enter it


manually.
book 1) In Financial Reporting, a container that holds a

group of similar documents. Books may specify dimension


sections or dimension changes. 2) In Data Relationship
Management, a collection of exports that can be run
together as a group. Export results can be combined
together or output separately.
book POV The dimension members for which a book is run.

Glossary 309

bookmark A link to a reporting document or a website,

calculation status A consolidation status that indicates that

displayed on a personal page of a user. The types of


bookmarks are My Bookmarks and image bookmarks.

some values or formula calculations have changed. You


must reconsolidate to get the correct values for the affected
entity.

bounding rectangle The required perimeter that encapsulates

the Interactive Reporting document content when


embedding Interactive Reporting document sections in a
personal page, specified in pixels for height and width or
row per page.

calendar User-defined time periods and their relationship

broadcast message A simple text message sent by an

of member values.

administrator to a user who is logged on to a Planning


application. The message details information such as system
availability, notification of application refresh, or
application backups.
build method A method used to modify database outlines.

Choice of a build method is based on the format of data in


data source files.
business process A set of activities that collectively

accomplish a business objective.


business rules Logical expressions or formulas that are

created within an application to produce a desired set of


resulting values.
cache A buffer in memory that holds data temporarily.
calc script A set of commands that define how a database is

consolidated or aggregated. A calculation script may also


contain commands that specify allocation and other
calculation rules separate from the consolidation process.
Calculated Accounts Accounts with formulas that you cannot

alter. These formulas are fixed to maintain the accounting


integrity of the model that you are building. For example,
the formula for Net Income, a Calculated Account, is
modeled into Strategic Finance and cannot be changed in
historical or forecast periods.
calculated member in MaxL DML A member designed for

to each other. Q1, Q2, Q3, and Q4 comprise a calendar or


fiscal year.
cascade The process of creating multiple reports for a subset

Catalog pane An area that displays a list of elements available

to the active section. If Query is the active section, a list of


database tables is displayed. If Pivot is the active section, a
list of results columns is displayed. If Dashboard is the active
section, a list of embeddable sections, graphic tools, and
control tools are displayed.
categories Groupings by which data is organized. For

example, Month.
cause and effect map A map that depicts how the elements

that form your corporate strategy relate and how they work
together to meet your organization's strategic goals. A Cause
and Effect map tab is automatically created for each Strategy
map.
CDF See custom-defined function.
CDM See custom-defined macro.
cell (1) The data value at the intersection of dimensions in

a multidimensional database; the intersection of a row and


a column in a worksheet. (2) A logical group of nodes
belonging to one administrative domain.
cell note A text annotation for a cell in an Essbase database.

Cell notes are a type of LRO.


CHANGED status Consolidation status that indicates data for

an entity has changed.

analytical purposes and defined in the optional WITH


section of a MaxL DML query.

chart template A template that defines the metrics to display

Calculation Manager A module of Enterprise Performance

child A member with a parent above it in the database

Management Architecture (EPMA) that Planning and


Financial Management users can use to design, validate, and
administrate business rules in a graphical environment. c

outline.

310 Glossary

in Workspace charts.

choice list A list of members that a report designer can

computed item A virtual column (as opposed to a column

specify for each dimension when defining the report's point


of view. A user who wants to change the point of view for a
dimension that uses a choice list can select only the members
specified in that defined member list or those members that
meet the criteria defined in the function for the dynamic list.

that is physically stored in the database or cube) that can be


calculated by the database during a query, or by Interactive
Reporting Studio in the Results section. Computed items
are calculations of data based on functions, data items, and
operators provided in the dialog box and can be included in
reports or reused to calculate other data.

clean block A data block in which the database is fully

calculated, if a calculation script calculates all dimensions at


once, or if the SET CLEARUPDATESTATUS command is
used in a calculation script.

connection file See Interactive Reporting connection file

cluster An array of servers or databases that behave as a

unit files are consolidated; contains the definition of the


consolidation.

single resource which share task loads and provide failover


support; eliminates one server or database as a single point
of failure in a system.

(.oce)
consolidated file (Parent) A file into which all of the business

consolidation The process of aggregating data from

for heartbeat information, to detect node failure.

dependent entities to parent entities. For example, if the


dimension Year consists of the members Qtr1, Qtr2, Qtr3,
and Qtr4, its consolidation is Year.

cluster services Software that manages cluster member

consolidation file (*.cns) A graphical interface that enables

operations as a system. With cluster services, you can define


a set of resources and services to monitor through a
heartbeat mechanism between cluster members and to
move these resources and services to a different cluster
member as efficiently and transparently as possible.

you to add, delete, or move Strategic Finance files in the


consolidation process using either a Chart or Tree view. It
also enables you to define and modify the consolidation.

cluster interconnect A private link used by a hardware cluster

clustered bar charts Charts in which categories are viewed

side-by-side; used only with vertical bar charts.


code page A mapping of bit combinations to a set of text

characters. Different code pages support different sets of


characters. Each computer contains a code page setting for
the character set requirements of the language of the
computer user. In the context of this document, code pages
map characters to bit combinations for non-Unicode
encodings. See also encoding.
column In Data Relationship Management, a field of data

consolidation rule The rule that is executed during the

consolidation of the node of the hierarchy. This rule can


contain customer-specific formulas appropriate for the
correct consolidation of parent balances. Elimination
processing can be controlled within these rules.
content Information stored in the repository for any type of

file.
content browser A component that eanbles users to browse

and select content to be placed on a Workspace Page.


context variable A variable that is defined for a particular task

flow to identify the context of the taskflow instance.

associated with an import source or the results of a query,


compare, validation, or export.

contribution The value added to a parent from a child entity.

committed access An Essbase Kernel Isolation Level setting

controls groups Groupings used in FDM to maintain and

that affects how Essbase handles transactions. Under


committed access, concurrent transactions hold long-term
write locks and yield predictable results.

organize certification and assessment information,


especially helpful for meeting Sarbanes-Oxley
requirements.

Each child has a contribution to its parent.

conversion rate See exchange rate.


cookie A segment of data placed on your computer by a

website.

Glossary 311

correlated subqueries Subqueries that are evaluated once for

custom calendar Any calendar created by an administrator.

every row in the parent query; created by joining a topic item


in the subquery with a topic in the parent query.

custom dimension A dimension created and defined by users.

critical business area (CBA) An individual or a group

organized into a division, region, plant, cost center, profit


center, project team, or process; also called accountability
team or business area.
critical success factor (CSF) A capability that must be

established and sustained to achieve a strategic objective;


owned by a strategic objective or a critical process and is a
parent to one or more actions.
crosstab reporting Reporting that categorizes and

summarizes data in table format. The table cells contain


summaries of the data that fit within the intersecting
categories. For example, a crosstab report of product sales
information could show size attributes, such as Small and
Large, as column headings and color attributes, such as Blue
and Yellow, as row headings. The cell in the table where
Large and Blue intersect could contain the total sales of all
Blue products that are sized Large.
cube A block of data that contains three or more

dimensions. An Essbase database is a cube.


cube deployment In Essbase Studio, the process of setting load

Channel, product, department, project, or region could be


custom dimensions.
custom property A property of a dimension or dimension

member that is created by a user.


custom report A complex report from the Design Report

module, composed of any combination of components.


custom-defined function (CDF) Essbase calculation functions

developed in Java and added to the standard Essbase


calculation scripting language using MaxL. See also customdefined macro.
custom-defined macro (CDM) Essbase macros written with

Essbase calculator functions and special macro functions.


Custom-defined macros use an internal Essbase macro
language that enables the combination of calculation
functions and they operate on multiple input parameters.
See also custom-defined function.
cycle through Perform multiple passes through a database

while calculating it.


dashboard A collection of metrics and indicators that

options for a model to build an outline and load data into


an Essbase application and database.

provide an interactive summary of your business.


Dashboards enable you to build and deploy analytic
applications.

cube schema In Essbase Studio, the metadata elements, such

data cache A buffer in memory that holds uncompressed

as measures and hierarchies, representing the logical model


of a cube.

data blocks.

currency conversion A process that converts currency values

in a database from one currency into another. For example,


to convert one U. S. dollar into the European euro, the
exchange rate (for example, 0.923702) is multiplied by the
dollar (1* 0.923702). After conversion, the European euro
amount is .92.
Currency Overrides A feature allowing the selected input

method for any input period to be overridden to enable


input of that period's value as Default Currency/Items. To
override the input method, enter a pound sign (#) before or
after the number.

data cell See cell.


data file cache A buffer in memory that holds compressed

data (PAG) files.


data form A grid display that enables users to enter data into

the database from an interface such as a Web browser, and


to view and analyze data or related text. Certain dimension
member values are fixed, giving users a specific view into
the data.
data function Function that computes aggregate values,

including averages, maximums, counts, and other statistics


that summarize groupings of data.

currency partition A dimension type that separates local

data load location In FDM, a reporting unit responsible for

currency members from a base currency, as defined in an


application. Identifies currency types, such as Actual,
Budget, and Forecast.

submitting source data into the target system. Typically, one


FDM data load location exists for each source file loaded to
the target system.

312 Glossary

data load rules A set of criteria that determines how to load

descendant Any member below a parent in the database

data from a text-based file, a spreadsheet, or a relational data


set into a database.

outline. In a dimension that includes years, quarters, and


months, the members Qtr2 and April are descendants of the
member Year.

data lock A feature that prevents changes to data according

to specified criteria, such as a period or scenario.


data mining The process of searching through an Essbase

database for hidden relationships and patterns in a large


amount of data.

Design Report An interface in Web Analysis Studio for

designing custom reports, from a library of components.


destination 1) In Business Rules, a block of the database

data value See cell.

where calculated values are stored; 2) In Profitability and


Cost Management, the association of a source and
destination in the allocation model that controls the
direction of allocated costs or revenue flow.

database connection A file that stores definitions and

destination currency The currency to which balances are

properties used to connect to data sources and enables


database references to be portable and widely used.

converted. You enter exchange rates and convert from the


source currency to the destination currency. For example,
when you convert from EUR to USD, the destination
currency is USD.

data model A representation of a subset of database tables.

date measure In Essbase, a member tagged as Date in the

dimension where measures are represented. The cell values


are displayed as formatted dates. Dates as measures can be
useful for analysis types that are difficult to represent using
the Time dimension. For example, an application may need
to track acquisition dates for a series of capital assets, but
the acquisition dates span too large a period to allow for
feasible Time dimension modeling. See also typed measure.
Default Currency Units The unit scale of data. For example, If

you select to define your analysis in thousands and enter 10,


this unit is interpreted as 10,000.
dense dimension In block storage databases, a dimension

likely to contain data for every combination of dimension


members. For example, time dimensions are often dense
because they can contain all combinations of all members.
Contrast with sparse dimension.
dependent entity An entity that is owned by another entity in

the organization.
derived text measure In Essbase Studio, a text measure whose

values are governed by a predefined rule expressed as a


range. For example, a derived text measure, called "Sales
Performance Index," based on a measure Sales, could
consist of the values "High," "Medium," and "Low." This
derived text measure is defined to display "High,"
"Medium," and "Low" depending on the range in which the
corresponding sales values fall. See also text measure.

detail chart A chart that provides the detailed information

that you see in a Summary chart. Detail charts appear in the


Investigate Section in columns below the Summary charts.
If the Summary chart shows a Pie chart, then the Detail
charts below represent each piece of the pie.
dimension A data category used to organize business data for

the retrieval and preservation of values. Dimensions usually


contain hierarchies of related members grouped within
them. For example, a Year dimension often includes
members for each time period, such as quarters and months.
dimension build The process of adding dimensions and

members to an Essbase outline.


dimension build rules Specifications, similar to data load rules,

that Essbase uses to modify an outline. The modification is


based on data in an external data source file.
dimension tab In the Pivot section, the tab that enables you

to pivot data between rows and columns.


dimension table (1) A table that includes numerous attributes

about a specific business process. (2) In Essbase Integration


Services, a container in the OLAP model for one or more
relational tables that define a potential dimension in
Essbase.
dimension type A dimension property that enables the use of

predefined functionality. Dimensions tagged as time have a


predefined calendar functionality.

Glossary 313

dimensionality In MaxL DML, the represented dimensions

duplicate member outline A database outline containing

(and the order in which they are represented) in a set. For


example, the following set consists of two tuples of the same
dimensionality, because they both reflect the dimensions
(Region, Year): { (West, Feb), (East, Mar) }

duplicate member names.

direct rate A currency rate that you enter in the exchange-

rate table. The direct rate is used for currency conversion.


For example, to convert balances from JPY to USD, in the
exchange-rate table, enter a rate for the period/scenario
where the source currency is JPY and the destination
currency is USD.
dirty block A data block containing cells that have been

changed since the last calculation. Upper-level blocks are


marked as dirty if their child blocks are dirty (that is, if they
have been updated).
display type One of three Web Analysis formats saved to the

repository: spreadsheet, chart, and pinboard.


dog-ear The flipped page corner in the upper-right corner

of the chart header area.


domain In data mining, a variable representing a range of

navigation within data.


drill-down Navigation through the query result set using the

dimensional hierarchy. Drilling down moves the user


perspective from aggregated data to detail. For example,
drilling down can reveal hierarchical relationships between
years and quarters or quarters and months.
drill-through The navigation from a value in one data source

to corresponding data in another source.


driver In Profitability and Cost Management, an allocation

method that describes the mathematical relationship


between the sources that use the driver and the destinations
to which those sources allocate cost or revenue. For Business
Modeling, see also cost driver and activity driver.
duplicate alias name A name that occurs more than once in

an alias table and can be associated with more than one


member in a database outline. Duplicate alias names can be
used with duplicate member outlines only.

Dynamic Calc and Store members Members in a block storage

outline that Essbase calculates only upon the first retrieval


of the value. Essbase then stores the calculated value in the
database. Subsequent retrievals do not require calculating.
Dynamic Calc members Members in a block storage outline

that Essbase calculates only at retrieval time. Essbase


discards calculated values after completing the retrieval
request.
dynamic calculation In Essbase, a calculation that occurs only

when you retrieve data on a member that is tagged as


Dynamic Calc or Dynamic Calc and Store. The member's
values are calculated at retrieval time instead of being
precalculated during batch calculation.
dynamic hierarchy In aggregate storage database outlines

only, a hierarchy in which members are calculated at


retrieval time.
dynamic member list A system-created named member set

that is based on user-defined criteria. The list is refreshed


automatically whenever it is referenced in the application.
As dimension members are added and deleted, the list
automatically reapplies the criteria to reflect the changes.
dynamic reference A pointer in the rules file to header records

in a data source.
dynamic report A report containing data that is updated when

you run the report.


Dynamic Time Series A process that performs period-to-date

reporting in block storage databases.


dynamic view account An account type indicating that

account values are calculated dynamically from the data that


is displayed.
Eliminated Account An account that does not appear in the

consolidated file.
elimination The process of zeroing out (eliminating)

transactions between entities within an organization.

duplicate member name Multiple occurrences of a member

employee A user responsible for, or associated with, specific

name in a database, with each occurrence representing a


different member. For example, a database has two
members named New York. One member represents New
York state and the other member represents New York city.

business objects. Employees need not work for an


organization; for example, they can be consultants.
Employees must be associated with user accounts, for
authorization purposes.

314 Glossary

encoding A method for mapping bit combinations to

exceptions Values that satisfy predefined conditions. You

characters for creating, storing, and displaying text. Each


encoding has a name; for example, UTF-8. Within an
encoding, each character maps to a specific bit combination;
for example, in UTF-8, uppercase A maps to HEX41. See
also code page, locale.

can define formatting indicators or notify subscribing users


when exceptions are generated.
exchange rate type An identifier for an exchange rate.

in a chart. For example, an ending period of "month"


produces a chart showing information through the end of
the current month.

Different rate types are used because there may be multiple


rates for a period and year. Users traditionally define rates
at period end for the average rate of the period and for the
end of the period. Additional rate types are historical rates,
budget rates, forecast rates, and so on. A rate type applies to
a specific time.

Enterprise View An Administration Services feature that

expense account An account that stores periodic and year-

enables management of the Essbase environment from a


graphical tree view. From Enterprise View, you can operate
directly on Essbase artifacts.

to-date values that decrease net worth if they are positive.

ending period A period enabling you to adjust the date range

entity A dimension representing organizational units.

Examples: divisions, subsidiaries, plants, regions, products,


or other financial reporting units.
EPM Oracle home A subdirectory of Middleware home

containing the files required by EPM System products. The


EPM Oracle home location is specified during installation
with EPM System Installer.
Equity Beta The riskiness of a stock, measured by the

variance between its return and the market return, indicated


by an index called "beta." For example, if a stock's return
normally moves up or down 1.2% when the market moves
up or down 1%, the stock has a beta of 1.2.
essbase.cfg An optional configuration file for Essbase.

Administrators may edit this file to customize Essbase


Server functionality. Some configuration settings may also
be used with Essbase clients to override Essbase Server
settings.
EssCell A function entered into a cell in Essbase Spreadsheet

Add-in to retrieve a value representing an intersection of


specific Essbase database members.
ESSCMD A command-line interface for performing Essbase

operations interactively or through batch script files.


ESSLANG The Essbase environment variable that defines the

encoding used to interpret text characters. See also


encoding.
ESSMSH See MaxL Shell.

Extensible Markup Language (XML) A language comprising a set

of tags used to assign attributes to data that can be


interpreted between applications according to a schema.
external authentication Logging on to Oracle EPM System

products with user information stored outside the


application. The user account is maintained by the EPM
System, but password administration and user
authentication are performed by an external service, using
a corporate directory such as Oracle Internet Directory
(OID) or Microsoft Active Directory (MSAD).
externally triggered events Non-time-based events for

scheduling job runs.


Extract, Transform, and Load (ETL) Data-source-specific

programs for extracting data and migrating it to


applications.
extraction command An Essbase reporting command that

handles the selection, orientation, grouping, and ordering


of raw data extracted from a database; begins with the lessthan (<) character.
fact table The central table in a star join schema,

characterized by a foreign key and elements drawn from a


dimension table. This table typically contains numeric data
that can be related to all other tables in the schema.
failover The ability to switch automatically to a redundant

standby database, server, or network if the primary


database, server, or network fails or is shut down. A system
that is clustered for failover provides high availability and
fault tolerance through server redundancy and faulttolerant hardware, such as shared disks.

Glossary 315

Favorites gadget A gadget that contains links to Reporting

generation A layer in a hierarchical tree structure that defines

and Analysis documents and URLs. See also gadget.

member relationships in a database. Generations are


ordered incrementally from the top member of the
dimension (generation 1) down to the child members. Use
the unique generation name to identify a layer in the
hierarchical tree structure.

file delimiter A character, such as a comma or tab, that

separates fields in a data source.


filter A constraint on data sets that restricts values to specific

criteria; for example, to exclude certain tables, metadata, or


values, or to control access.
flow account An unsigned account that stores periodic and

year-to-date values.
footer Text or images at the bottom of report pages,

containing dynamic functions or static text such as page


numbers, dates, logos, titles or file names, and author
names.
format string 1) In Essbase, a method for transforming the

way cell values are displayed. 2) In FDM, a parameter of a


Format or Formatted Date derived property that indicates
the format in which a property value should be returned.

generic jobs Non-SQR Production Reporting or non-

Interactive Reporting jobs.


global report command A command in a running report script

that is effective until it is replaced by another global


command or the file ends.
grid POV A means for specifying dimension members on a

grid without placing dimensions in rows, columns, or page


intersections. A report designer can set POV values at the
grid level, preventing user POVs from affecting the grid. If
a dimension has one grid value, you put the dimension into
the grid POV instead of the row, column, or page.
group A container for assigning similar access permissions

formula In Data Relationship Management, business logic

to multiple users.

used by a derived property to dynamically calculate a


property value.

GUI Graphical user interface

frame An area on the desktop. Two main areas: the

navigation and workspace frames.


free-form grid An object for presenting, entering, and

integrating data from different sources for dynamic


calculations.
free-form reporting Creating reports by entering dimension

members or report script commands in worksheets.


function In Data Relationship Management, a syntactic

element of a derived property formula that accepts


parameters and returns dynamic values.
gadget A simple, specialized, lightweight application that

provides easy viewing of EPM content and enables access to


core Reporting and Analysis functionality.
geneology data Additional data that is optionally generated

after allocation calculations. This data enables reporting on


all cost or revenue flows from start to finish through all
allocation steps.

hardware cluster a collection of computers that provides a

single view of network services (for example, an IP address)


or application services (such as databases and Web servers)
to clients of these services. Each node in a hardware cluster
is a standalone server that runs its own processes. These
processes can communicate with one another to form what
looks like a single system that cooperatively provides
applications, system resources, and data to users.
high availability A system attribute that enables an

application to continue to provide services in the presence


of failures. This is achieved through removal of single points
of failure, with fault-tolerant hardware, as well as server
clusters; if one server fails, processing requests are routed to
another server.
Historical Average An average for an account over a number

of historical periods.
holding company An entity that is part of a legal entity group,

with direct or indirect investments in all entities in the


group.
horizontal application server cluster A cluster with application

server instances on different machines.

316 Glossary

host A server on which applications and services are

index file An Essbase file storing block storage data retrieval

installed.

information, residing on disk, and containing index pages.

host properties Properties pertaining to a host, or if the host

index page A subdivision in an index file. An index page

has multiple Oracle EPM homes, to an Oracle EPM home.

contains pointers to data blocks.

Hybrid Analysis An analysis mapping low-level data stored in

input data Data loaded from a source rather than calculated.

a relational database to summary-level data stored in


Essbase, combining the mass scalability of relational systems
with multidimensional data.
hyperlink A link to a file, a Web page, or an intranet HTML

page.
Hypertext Markup Language (HTML) A programming language

specifying how Web browsers display data.


identity A unique identification for a user or group in

external authentication.
image bookmarks Graphic links to Web pages or repository

items.
IMPACTED status A status that indicates changes in child

entities consolidating into parent entities.


implied share A member with one or more children but only

one that is consolidated, so the parent and child share a


value.
import format In FDM, the definition of the structure of the

source file that enables the loading of a source data file to


an FDM data-load location.
inactive group A group for which an administrator has

deactivated system access.


INACTIVE status A status that indicates entities deactivated

installation assemblies Product installation files that plug in

to EPM System Installer.


integration A process that is run to move data between

Oracle's Hyperion applications using Shared Services. Data


integration definitions specify the data moving between a
source application and a destination application, and they
enable the data movements to be grouped, ordered, and
scheduled.
intelligent calculation A calculation method tracking updated

data blocks since the last calculation.


Interactive Reporting connection file (.oce) Files encapsulating

database connection information, including the database


API (ODBC, SQL*Net, and so on), database software, the
database server network address, and database user name.
Administrators create and publish Interactive Reporting
connection (.oce) files.
intercompany elimination See elimination.
intercompany matching The process of comparing balances

for pairs of intercompany accounts within an application.


Intercompany receivables are compared to intercompany
payables for matches. Matching accounts are used to
eliminate intercompany transactions from an
organization's consolidated totals.

from consolidation for the current period.

intercompany matching report A report that compares

inactive user A user whose account was deactivated by an

intercompany account balances and indicates whether the


accounts are in balance.

administrator.
income account An account storing periodic and year-to-

date values that, if positive, increase net worth.


index (1) A method where Essbase uses sparse-data

combinations to retrieve data in block storage databases. (2)


The index file.
index cache A buffer containing index pages.
index entry A pointer to an intersection of sparse dimensions.

Index entries point to data blocks on disk and use offsets to


locate cells.

interdimensional irrelevance A situation in which a dimension

does not intersect with other dimensions. Because the data


in the dimension cannot be accessed from the
nonintersecting dimensions, the nonintersecting
dimensions are not relevant to that dimension.
intersection A unit of data representing the intersection of

dimensions in a multidimensional database; also, a


worksheet cell.
intrastage assignment An assignment in the financial flow to

an object within the same stage.

Glossary 317

introspection A deep inspection of a data source to discover

layer (1) The horizontal location of members in a

hierarchies based on the inherent relationships in the


database. Contrast with scraping.

lock and commit behavior of database operations. Choices


are: committed access and uncommitted access.

hierarchical structure, specified by generation (top down)


or level (bottom up). (2) Position of objects relative to other
objects. For example, in the Sample Basic database, Qtr1 and
Qtr4 are in the same layer, so they are also in the same
generation, but in a database with a ragged hierarchy, Qtr1
and Qtr4 might not be in same layer, though they are in the
same generation.

iteration A pass of the budget or planning cycle in which the

layout area An area on a Workspace Page where content can

same version of data is revised and promoted.

be placed.

Java application server cluster An active-active application

legend box A box containing labels that identify the data

server cluster of Java Virtual Machines (JVMs).

categories of a dimension.

Java Database Connectivity (JDBC) A client-server

level A layer in a hierarchical tree structure that defines

communication protocol used by Java-based clients and


relational databases. The JDBC interface provides a calllevel API for SQL-based database access.

database member relationships. Levels are ordered from the


bottom dimension member (level 0) up to the parent
members.

job output Files or reports produced from running a job.

level 0 block A data block for combinations of sparse, level 0

Investigation See drill-through.


isolation level An Essbase Kernel setting that determines the

jobs Documents with special properties that can be

launched to generate output. A job can contain Interactive


Reporting, SQR Production Reporting, or generic
documents.
join A link between two relational database tables or topics

based on common content in a column or row. A join


typically occurs between identical or similar items within
different tables or topics. For example, a record in the
Customer table is joined to a record in the Orders table
because the Customer ID value is the same in each table.

members.
level 0 member A member that has no children.
liability account An account type that stores "point in time"

balances of a company's liabilities. Examples: accrued


expenses, accounts payable, and long-term debt.
lifecycle management The process of migrating an

application, a repository, or individual artifacts across


product environments.
line item detail The lowest level of detail in an account.

journal entry (JE) A set of debit-credit adjustments to account

lineage The relationship between different metadata

balances for a scenario and period.

elements showing how one metadata element is derived


from one or more other metadata elements, ultimately
tracing the metadata element to its physical source. In
Essbase Studio, a lineage viewer displays the relationships
graphically. See also traceability.

JSP Java Server Page.


KeyContacts gadget A gadget that contains a group of Smart

Space users and provides access to Smart Space


Collaborator. For example, you can have a KeyContacts
gadget for your marketing team and another for your
development team. See also gadget.
latest A spreadsheet keyword used to extract data values

from the member defined as the latest time period.

link (1) A reference to a repository object. Links can

reference folders, files, shortcuts, and other links. (2) In a


taskflow, the point where the activity in one stage ends and
another begins.
link condition A logical expression evaluated by the taskflow

engine to determine the sequence of launching taskflow


stages.
linked data model Documents that are linked to a master copy

in a repository

318 Glossary

linked partition A shared partition that enables you to use a

LOCKED status A consolidation status indicating that an

data cell to link two databases. When a user clicks a linked


cell in a worksheet, Essbase opens a new sheet displaying the
dimensions in the linked database. The user can then drill
down those dimensions.

entity contains data that cannot be modified.

linked reporting object (LRO) A cell-based link to an external

file such as cell notes, URLs, or files with text, audio, video,
or pictures. (Only cell notes are supported for Essbase LROs
in Financial Reporting.) Contrast with local report object.
load balancer Hardware or software that directs the requests

to individual application servers in a cluster and is the only


point of entry into the system.
load balancing Distribution of requests across a group of

servers, which helps to ensure optimal end user


performance.
local currency An input currency type. When an input

currency type is not specified, the local currency matches


the entity's base currency.
local report object A report object that is not linked to a

Financial Reporting report object in Explorer. Contrast with


linked reporting object.
local results A data model's query results. Results can be used

in local joins by dragging them into the data model. Local


results are displayed in the catalog when requested.
locale A computer setting that specifies a location's

language, currency and date formatting, data sort order, and


the character set encoding used on the computer. Essbase
uses only the encoding portion. See also encoding,
ESSLANG.
locale header record A text record at the beginning of some

non-Unicode-encoded text files, such as scripts, that


identifies the encoding locale.
location alias A descriptor that identifies a data source. The

location alias specifies a server, application, database, user


name, and password. Location aliases are set by DBAs at the
database level using Administration Services Console,
ESSCMD, or the API.

Log Analyzer An Administration Services feature that enables

filtering, searching, and analysis of Essbase logs.


logic group In FDM, one or more logic accounts generated

after a source file is loaded into FDM. Logic accounts are


calculated accounts derived from the source data.
logical Web application An aliased reference used to identify

the internal host name, port, and context of a Web


application. In a clustered or high-availability environment,
this is the alias name that establishes a single internal
reference for the distributed components. In EPM System,
a nonclustered logical Web application defaults to the
physical host running the Web application.
LRO See linked reporting object.
managed server An application server process running in its

own Java Virtual Machine (JVM).


manual stage A stage that requires human intervention.
Map File A file that stores the definition for sending data to

or retrieving data from an external database. Map files have


different extensions (.mps to send data; .mpr to retrieve
data).
Map Navigator A feature that displays your current position

on a Strategy, Accountability, or Cause and Effect map,


indicated by a red outline.
Marginal Tax Rate The rate used to calculate the after-tax cost

of debt; represents the tax rate applied to the last earned


income dollar (the rate from the highest tax bracket into
which income falls) and includes federal, state, and local
taxes. Based on current level of taxable income and tax
bracket, you can predict marginal tax rate.
Market Risk Premium The additional rate of return paid over

the risk-free rate to persuade investors to hold "riskier"


investments than government securities. Calculated by
subtracting the risk-free rate from the expected market
return. These figures should closely model future market
conditions.

locked A user-invoked process that prevents users and

processes from modifying data.


locked data model A data model that cannot be modified by

a user.

Glossary 319

master data model An independent data model that is

member list A named system- or user-defined group that

referenced as a source by multiple queries. When used,


"Locked Data Model" is displayed in the Query section's
Content pane; the data model is linked to the master data
model displayed in the Data Model section, which an
administrator may hide.

references members, functions, or member lists within a


dimension.

mathematical operator A symbol that defines how data is

calculated in formulas and outlines. Can be any of the


standard mathematical or Boolean operators; for example,
+, -, *, /, and %.
MaxL The multidimensional database access language for

Essbase, consisting of a data definition language (MaxL


DDL) and a data manipulation language (MaxL DML). See
also MaxL DDL, MaxL DML, and MaxL Shell
MaxL DDL The data definition language used by Essbase for

batch or interactive system-administration tasks.


MaxL DML The data manipulation language used in Essbase

for data query and extraction.


MaxL Perl Module A Perl module (essbase.pm) that is part of

member load In Essbase Integration Services, the process of

adding dimensions and members (without data) to Essbase


outlines.
member selection report command A type of Report Writer

command that selects member ranges based on outline


relationships, such as sibling, generation, and level.
member-specific report command A type of Report Writer

formatting command that is executed as it is encountered


in a report script. The command affects only its associated
member and executes the format command before
processing the member.
merge A data load option that clears values only from the

accounts specified in the data load file and replaces them


with values in the data load file.
metadata A set of data that defines and describes the

Essbase MaxL DDL. This module can be added to the Perl


package to provide access to Essbase databases from Perl
programs.

properties and attributes of the data stored in a database or


used by an application. Examples of metadata are
dimension names, member names, properties, time
periods, and security.

MaxL Script Editor A script-development environment in

metadata elements Metadata derived from data sources and

Administration Services Console. MaxL Script Editor is an


alternative to using a text editor and the MaxL Shell for
administering Essbase with MaxL scripts.

other metadata that is stored and cataloged for Essbase


Studio use.

MaxL Shell An interface for passing MaxL statements to

members in a dimension in a drill-down operation.

Essbase Server. The MaxL Shell executable file is located in


the Essbase bin directory (UNIX: essmsh; Windows:
essmsh.exe).
MDX (multidimensional expression) A language used for

querying and calculation in multidimensional-compliant


databases.
measures Numeric values in an OLAP database cube that are

available for analysis. Measures are margin, cost of goods


sold, unit sales, budget amount, and so on. See also fact
table.
member A discrete component within a dimension. A

member identifies and differentiates the organization of


similar units. For example, a time dimension might include
members Jan, Feb, and Qtr1.

320 Glossary

metadata sampling The process of retrieving a sample of

metadata security Security set at the member level to restrict

users from accessing certain outline members.


metaoutline In Essbase Integration Services, a template

containing the structure and rules for creating an Essbase


outline from an OLAP model.
Middleware home A directory that includes the Oracle

WebLogic Server home and can also include the EPM Oracle
home and other Oracle homes. A Middleware home can
reside on a local file system or on a remote shared disk that
is accessible through NFS.
migration audit report A report generated from the migration

log that provides tracking information for an application


migration.

migration definition file (.mdf) A file that contains migration

My Workspace Page Customizable Workspace Pages created

parameters for an application migration, enabling batch


script processing.

by users. They are marked specially so that they can be easily


accessed from one single place without having to navigate
the repository.

migration log A log file that captures all application migration

actions and messages.

named set In MaxL DML, a set with its logic defined in the

migration snapshot A snapshot of an application migration

optional WITH section of a MaxL DML query. The named


set can be referenced multiple times in the query.

that is captured in the migration log.


MIME Type An attribute that describes the data format of an

item, so that the system knows which application should


open the object. A file's MIME (Multipurpose Internet Mail
Extension) type is determined by the file extension or HTTP
header. Plug-ins tell browsers which MIME types they
support and which file extensions correspond to each
MIME type.
mining attribute In data mining, a class of values used as a

factor in analysis of a set of data.


minireport A report component that includes layout,

content, hyperlinks, and the query or queries to load the


report. Each report can include one or more minireports.
minischema A graphical representation of a subset of tables

from a data source that represents a data modeling context.


missing data (#MISSING) A marker indicating that data in the

labeled location does not exist, contains no value, or was


never entered or loaded. For example, missing data exists
when an account contains data for a previous or future
period but not for the current period.
model 1) In data mining, a collection of an algorithm's

findings about examined data. A model can be applied


against a wider data set to generate useful information about
that data. 2) A file or content string containing an
application-specific representation of data. Models are the
basic data managed by Shared Services, of two major types:
dimensional and nondimensional application objects. 3) In
Business Modeling, a network of boxes connected to
represent and calculate the operational and financial flow
through the area being examined.
multidimensional database A method of organizing, storing,

and referencing data through three or more dimensions. An


individual value is the intersection point for a set of
dimensions. Contrast with relational database.

native authentication The process of authenticating a user

name and password from within the server or application.


nested column headings A report column heading format that

displays data from multiple dimensions. For example, a


column heading that contains Year and Scenario members
is a nested column. The nested column heading shows Q1
(from the Year dimension) in the top line of the heading,
qualified by Actual and Budget (from the Scenario
dimension) in the bottom line of the heading.
NO DATA status A consolidation status indicating that this

entity contains no data for the specified period and account.


non-dimensional model A Shared Services model type that

includes application objects such as security files, member


lists, calculation scripts, and Web forms.
non-unique member name See duplicate member name.
null value A value that is absent of data. Null values are not

equal to zero.
numeric attribute range A feature used to associate a base

dimension member that has a discrete numeric value with


an attribute that represents a value range. For example, to
classify customers by age, an Age Group attribute dimension
can contain members for the following age ranges: 0-20,
21-40, 41-60, and 61-80. Each Customer dimension
member can be associated with an Age Group range. Data
can be retrieved based on the age ranges rather than on
individual age values.
ODBC Open Database Connectivity. A database access

method used from any application regardless of how the


database management system (DBMS) processes the
information.
OK status A consolidation status indicating that an entity has

already been consolidated, and that data has not changed


below it in the organization structure.

Multiload An FDM feature that allows the simultaneous

loading of multiple periods, categories, and locations.

Glossary 321

OLAP Metadata Catalog In Essbase Integration Services, a

page heading A report heading type that lists members

relational database containing metadata describing the


nature, source, location, and type of data that is pulled from
the relational data source.

represented on the current page of the report. All data values


on the page have the members in the page heading as a
common attribute.

OLAP model In Essbase Integration Services, a logical model

page member A member that determines the page axis.

(star schema) that is created from tables and columns in a


relational database. The OLAP model is then used to
generate the structure of a multidimensional database. See
also online analytical processing (OLAP).
online analytical processing (OLAP) A multidimensional,

multiuser, client-server computing environment for users


who analyze consolidated enterprise data in real time. OLAP
systems feature drill-down, data pivoting, complex
calculations, trend analysis, and modeling.

palette A JASC-compliant file with a .PAL extension. Each

palette contains 16 colors that complement each other and


can be used to set the dashboard color elements.
parallel calculation A calculation option. Essbase divides a

calculation into tasks and calculates some tasks


simultaneously.
parallel data load In Essbase, the concurrent execution of

data load stages by multiple process threads.

Open Database Connectivity (ODBC) Standardized application

parallel export The ability to export Essbase data to multiple

programming interface (API) technology that allows


applications to access multiple third-party databases.

files. This may be faster than exporting to a single file, and


it may resolve problems caused by a single data file
becoming too large for the operating system to handle.

Oracle home A directory containing the installed files

required by a specific product, and residing within the


directory structure of Middleware home. See also
Middleware home.

parent adjustments The journal entries that are posted to a

organization An entity hierarchy that defines each entity and

entities that report directly to them. Because parents are


entities associated with at least one node, they have entity,
node, and parent information associated with them.

their relationship to others in the hierarchy.


origin The intersection of two axes.
outline The database structure of a multidimensional

database, including all dimensions, members, tags, types,


consolidations, and mathematical relationships. Data is
stored in the database according to the structure defined in
the outline.
outline synchronization For partitioned databases, the process

of propagating outline changes from one database to


another database.
P&L accounts (P&L) Profit and loss accounts. P&L refers to a

child in relation to its parent.


parents The entities that contain one or more dependent

partition area A subcube within a database. A partition is

composed of one or more areas of cells from a portion of


the database. For replicated and transparent partitions, the
number of cells within an area must be the same for the data
source and target to ensure that the two partitions have the
same shape. If the data source area contains 18 cells, the data
target area must also contain 18 cells to accommodate the
number of values.
partitioning The process of defining areas of data that are

typical grouping of expense and income accounts that


comprise a company's income statement.

shared or linked between data models. Partitioning can


affect the performance and scalability of Essbase
applications.

page A display of information in a grid or table often

pattern matching The ability to match a value with any or all

represented by the Z-axis. A page can contain data from one


field, derived data from a calculation, or text.

characters of an item entered as a criterion. Missing


characters may be represented by wild-card values such as
a question mark (?) or an asterisk (*). For example, "Find
all instances of apple" returns apple, but "Find all instances
of apple*" returns apple, applesauce, applecranberry, and so
on.

page file An Essbase data file.

322 Glossary

percent consolidation The portion of a child's values that is

pivot Alter the perspective of retrieved data. When Essbase

consolidated to its parent.

first retrieves a dimension, it expands data into rows. You


can then pivot or rearrange the data to obtain a different
viewpoint.

percent control The extent to which an entity is controlled

within the context of its group.


percent ownership The extent to which an entity is owned by

its parent.
performance indicator An image file used to represent

measure and scorecard performance based on a range you


specify; also called a status symbol. You can use the default
performance indicators or create an unlimited number of
your own.
periodic value method (PVA) A process of currency conversion

that applies the periodic exchange rate values over time to


derive converted results.
permission A level of access granted to users and groups for

managing data or other users and groups.


persistence The continuance or longevity of effect for any

Essbase operation or setting. For example, an Essbase


administrator may limit the persistence of user name and
password validity.

planner A user who can input and submit data, use reports

that others create, execute business rules, use task lists,


enable email notification for themselves, and use Smart
View. Planners comprise the majority of users.
planning unit A data slice at the intersection of a scenario,

version, and entity; the basic unit for preparing, reviewing,


annotating, and approving plan data.
plot area The area bounded by X, Y, and Z axes; for pie

charts, the rectangular area surrounding the pie.


plug account An account in which the system stores any out-

of-balance differences between intercompany account pairs


during the elimination process.
post stage assignment Assignments in the allocation model

that are assigned to locations in a subsequent model stage.


POV (point of view) A feature for setting data focus by selecting

accessible only to the user who created them.

members that are not already assigned to row, column, or


page axes. For example, selectable POVs in FDM could
include location, period, category, and target category. In
another example, using POV as a filter in Smart View, you
could assign the Currency dimension to the POV and select
the Euro member. Selecting this POV in data forms displays
data in Euro values.

personal variable A named selection statement of complex

precalculation Calculating the database before user retrieval.

personal pages A personal window to repository

information. You select what information to display and its


layout and colors.
personal recurring time events Reusable time events that are

member selections.
perspective A category used to group measures on a

scorecard or strategic objectives within an application. A


perspective can represent a key stakeholder (such as a
customer, employee, or shareholder/financial) or a key
competency area (such as time, cost, or quality).
pinboard One of the three data object display types.

Pinboards are graphics composed of backgrounds and


interactive icons called pins. Pinboards require traffic
lighting definitions.

precision Number of decimal places displayed in numbers.


predefined drill paths Paths used to drill to the next level of

detail, as defined in the data model.


presentation A playlist of Web Analysis documents, enabling

reports to be grouped, organized, ordered, distributed, and


reviewed. Includes pointers referencing reports in the
repository.
preserve formulas User-created formulas kept within a

worksheet while retrieving data.

pins Interactive icons placed on graphic reports called

primary measure A high-priority measure important to your

pinboards. Pins are dynamic. They can change images and


traffic lighting color based on the underlying data values and
analysis tools criteria.

company and business needs. Displayed in the Contents


frame.

Glossary 323

Process Monitor Report A list of locations and their positions

recurring template A journal template for making identical

within the FDM data conversion process. You can use the
process monitor report to monitor the status of the closing
process. The report is time-stamped. Therefore, it can be
used to determine to which locations at which time data was
loaded.

adjustments in every period.

product In Shared Services, an application type, such as

recurring time event An event specifying a starting point and

the frequency for running a job.


redundant data Duplicate data blocks that Essbase retains

during transactions until Essbase commits updated blocks.

Planning or Performance Scorecard.

regular journal A feature for entering one-time adjustments

Production Reporting See SQR Production Reporting.

for a period. A regular journal can be balanced, balanced by


entity, or unbalanced.

project An instance of Oracle's Hyperion products grouped

together in an implementation. For example, a Planning


project may consist of a Planning application, an Essbase
cube, and a Financial Reporting Server instance.

Related Accounts Accounts related to the main account and

specific access permissions to resources.

grouped under the same main account number. The


account structure groups all main and related accounts
under the same main account number. The main account
is distinguished from related accounts by the first suffix of
the account number.

proxy server A server acting as an intermediary between

relational database A type of database that stores data in

workstation users and the Internet to ensure security.

related two-dimensional tables. Contrast with


multidimensional database.

provisioning The process of granting users and groups

public job parameters Reusable named job parameters created

by administrators and accessible to users with requisite


access privileges.
public recurring time events Reusable time events created by

administrators and accessible through the access control


system.
PVA See periodic value method.
qualified name A member name in a qualified format that

differentiates duplicate member names in a duplicate


member outline. For example, [Market].[East].[State].
[New York] or [Market].[East].[City].[New York].

replace A data load option that clears existing values from

all accounts for periods specified in the data load file and
loads values from the data load file. If an account is not
specified in the load file, its values for the specified periods
are cleared.
replicated partition A portion of a database, defined through

Partition Manager, used to propagate an update to data


mastered at one site to a copy of data stored at another site.
Users can access the data as though it were part of their local
database.
Report Extractor An Essbase component that retrieves report

query governor An Essbase Integration Server parameter or

data from the Essbase database when report scripts are run.

Essbase Server configuration setting that controls the


duration and size of queries made to data sources.

report object In report designs, a basic element with

reciprocal assignment An assignment in the financial flow

that also has the source as one of its destinations.

properties defining behavior or appearance, such as text


boxes, grids, images, and charts.
report script A text file containing Essbase Report Writer

reconfigure URL A URL that is used to reload servlet

commands that generate one or more production reports.

configuration settings dynamically when users are already


logged on to the Workspace.

Report Viewer An Essbase component that displays complete

record In a database, a group of fields making up one

complete entry. For example, a customer record may


contain fields for name, address, telephone number, and
sales data.

324 Glossary

reports after report scripts are run.


reporting currency The currency used to prepare financial

statements, and converted from local currencies to


reporting currencies.

repository Storage location for metadata, formatting, and

scope The area of data encompassed by any Essbase

annotation information for views and queries.

operation or setting; for example, the area of data affected


by a security setting. Most commonly, scope refers to three
levels of granularity, where higher levels encompass lower
levels. The levels, from highest to lowest: the entire system
(Essbase Server), applications on Essbase Server, or
databases within Essbase Server applications. See also
persistence.

resources Objects or services managed by the system, such

as roles, users, groups, files, and jobs.


restore An operation to reload data and structural

information after a database has been damaged or


destroyed, typically performed after shutting down and
restarting the database.
restructure An operation to regenerate or rebuild the

database index and, in some cases, data files.


result frequency The algorithm used to createa set of dates to

collect and display results.


review level A Process Management review status indicator

representing the process unit level, such as Not Started, First


Pass, Submitted, Approved, and Published.
Risk Free Rate The rate of return expected from "safer"

investments such as long-term U.S. government securities.


role The means by which access permissions are granted to

score The level at which targets are achieved, usually

expressed as a percentage of the target.


scorecard A business object that represents the progress of

an employee, strategy element, or accountability element


toward goals. Scorecards ascertain this progress based on
data collected for each measure and child scorecard added
to the scorecard.
scraping An inspection of a data source to derive the most

basic metadata elements from it. Contrast with


introspection.
secondary measure A low-priority measure, less important

roll-up See consolidation.

than primary measures. Secondary measures do not have


Performance reports but can be used on scorecards and to
create dimension measure templates.

root member The highest member in a dimension branch.

security agent A Web access management provider (for

runtime prompt A variable that users enter or select before a

example, Oracle Access Manager, Oracle Single Sign-On, or


CA SiteMinder) that protects corporate Web resources.

users and groups for resources.

business rule is run.


sampling The process of selecting a representative portion

of an entity to determine the entity's characteristics. See also


metadata sampling.
saved assumptions User-defined Planning assumptions that

drive key business calculations (for example, the cost per


square foot of office floor space).
scaling Scaling determines the display of values in whole

security platform A framework enabling Oracle EPM System

products to use external authentication and single sign-on.


serial calculation The default calculation setting. Divides a

calculation pass into tasks and calculates one task at a time.


services Resources that enable business items to be

retrieved, changed, added, or deleted. Examples:


Authorization and Authentication.

numbers, tens, hundreds, thousands, millions, and so on.

servlet A piece of compiled code executable by a Web server.

scenario A dimension for classifying data; for example,

shared disks See shared storage.

Actuals, Budget, Forecast1, or Forecast2.


schema In relational databases, a logical model that

represents the data and the relationships between the data.

shared member A member that shares storage space with

another member of the same name, preventing duplicate


calculation of members that occur multiple times in an
Essbase outline.

Glossary 325

Shared Services Registry The part of the Shared Services

SPF files Printer-independent files created by an SQR

repository that manages EPM System deployment


information for most EPM System products, including
installation directories, database settings, computer names,
ports, servers, URLs, and dependent service data.

Production Reporting server, containing a representation


of the actual formatted report output, including fonts,
spacing, headers, footers, and so on.

shared storage A set of disks containing data that must be

conditions.

available to all nodes of a failover cluster; also called shared


disks.

SQL spreadsheet A data object that displays the result set of

Shared Workspace Pages Workspace Pages shared across an

organization that are stored in a special System folder and


can be accessed by authorized users from the Shared
Workspace Pages Navigate menu.
sibling A child member at the same generation as another

child member and having the same immediate parent. For


example, the members Florida and New York are children
of East and each other's siblings.
silent response files Files providing data that an installation

administrator would otherwise be required to provide.


Response files enable EPM System Installer or EPM System
Configurator to run without user intervention or input.
single point of failure Any component in a system that, if it

fails, prevents users from accessing the normal


functionality.
single sign-on (SSO) The ability to log on once and then access

multiple applications without being prompted again for


authentication.
smart tags Keywords in Microsoft Office applications that

are associated with predefined actions available from the


Smart Tag menu. In Oracle EPM System products, smart
tags can also be used to import Reporting and Analysis
content and to access Financial Management and Essbase
functions.
SmartCut A link to a repository item, in URL form.
snapshot Read-only data from a specific time.
source currency The currency from which values originate

and are converted through exchange rates to the destination


currency.
sparse dimension In block storage databases, a dimension

unlikely to contain data for all member combinations when


compared to other dimensions. Contrast with dense
dimension. For example, not all customers have data for all
products.

326 Glossary

Spotlighter A tool that enables color coding based on selected

a SQL query.
SQR Production Reporting A specialized programming

language for data access, data manipulation, and creating


SQR Production Reporting documents.
stage 1) A task description that forms one logical step

within a taskflow, usually performed by an individual. A


stage can be manual or automated. 2) For Profitability,
logical divisions within the model that represent the steps
in the allocation process within your organization.
stage action For automated stages, the invoked action that

executes the stage.


staging area A database that you create to meet the needs of

a specific application. A staging area is a snapshot or


restructured version of one or more RDBMS.
staging table A database that you create to meet the needs of

a specific application. A staging area is a snapshot or


restructured version of one or more RDBMSs.
standard dimension A dimension that is not an attribute

dimension.
standard journal template A journal function used to post

adjustments that have common adjustment information for


each period. For example, you can create a standard
template that contains the common account IDs, entity IDs,
or amounts, and then use the template as the basis for many
regular journals.
Status bar The bar at the bottom of the screen that displays

helpful information about commands, accounts, and the


current status of your data file.
stored hierarchy In aggregate storage databases outlines only,

a hierarchy in which the members are aggregated according


to the outline structure. Stored hierarchy members have
certain restrictions; for example, they cannot contain
formulas.

strategic objective (SO) A long-term goal defined by

target Expected results of a measure for a specified period

measurable results. Each strategic objective is associated


with one perspective in the application, has one parent, the
entity, and is a parent to critical success factors or other
strategic objectives.

of time (day, quarter, and so on).

Strategy map Represents how the organization implements

high-level mission and vision statements into lower-level,


constituent strategic goals and objectives.

task list A detailed status list of tasks for a particular user.


taskflow The automation of a business process in which

tasks are passed from one taskflow participant to another


according to procedural rules.
taskflow definition Business processes in the taskflow

instructions to relational databases.

management system that consist of a network of stages and


their relationships; criteria indicating the start and end of
the taskflow; and information about individual stages, such
as participants, associated applications, associated activities,
and so on.

Subaccount Numbering A system for numbering subaccounts

taskflow instance A single instance of a taskflow including its

using nonsequential whole numbers.

state and associated data.

subscribe Flags an item or folder to receive automatic

taskflow management system A system that defines, creates,

notification whenever the item or folder is updated.

and manages the execution of a taskflow, including


definitions, user or application interactions, and
application executables.

structure view Displays a topic as a simple list of component

data items.
Structured Query Language A language used to process

Summary chart In the Investigates Section, a chart that rolls

up detail charts shown below in the same column, plotting


metrics at the summary level at the top of each chart column.
supervisor A user with full access to all applications,

databases, related files, and security mechanisms for a


server.
supporting detail Calculations and assumptions from which

the values of cells are derived.


suppress rows A setting that excludes rows containing

missing values and underscores characters from spreadsheet


reports.
symmetric multiprocessing (SMP) A server architecture that

enables multiprocessing and multithreading. Performance


is not significantly degraded when a large number of users
simultaneously connect to an single instance.
sync Synchronization of Shared Services and application

models.

taskflow participant The resource that performs the task

associated with the taskflow stage instance for both manual


and automated stages.
Taxes - Initial Balances Strategic Finance assumes that the

Initial Loss Balance, Initial Gain Balance, and Initial Balance


of Taxes Paid entries have taken place in the period before
the first Strategic Finance time period.
TCP/IP See Transmission Control Protocol/Internet

Protocol.
text measure In Essbase, a member tagged as Text in the

dimension where measures are represented. The cell values


are displayed as predefined text. For example, the text
measure Satisfaction Index may have the values Low,
Medium, and High. See also typed measure, text list, derived
text measure.
time dimension The time period that the data represents, such

synchronized The condition that exists when the latest

as fiscal or calendar periods.

version of a model resides in both the application and in


Shared Services. See also model.

time events Triggers for job execution.

system extract A feature that transfers data from application

metadata into an ASCII file.


tabs Navigable views of accounts and reports in Strategic

Finance.

time scale A scale that displays metrics by a specific time

span, such as monthly or quarterly.


time series reporting A process for reporting data based on a

calendar date (for example, year, quarter, month, or week).

Glossary 327

Timeline Viewer An FDM feature that enables users to view

Transmission Control Protocol/Internet Protocol (TCP/IP) A

dates and times of completed process flow steps for specific


locations.

standard set of communication protocols linking


computers with different operating systems and internal
architectures. TCP/IP utilities are used to exchange files,
send mail, and store data to various computers that are
connected to local and wide area networks.

Title bar A bar that displays the Strategic Finance name, the

file name, and the scenario name Version box.


toast message A message that fades in the lower-right corner

of the screen.
token An encrypted identification of one valid user or group

on an external authentication system.


top and side labels Column and row headings on the top and

sides of a Pivot report.


top-level member A dimension member at the top of the tree

in a dimension outline hierarchy, or the first member of the


dimension in sort order if there is no hierarchical
relationship among dimension members. If a hierarchical
relationship exists, the top-level member name is generally
the same as the dimension name.
trace allocations A Profitability feature that enables you to

visually follow the flow of financial data, either forwards or


backwards, from a single intersection throughout the
model.
trace level The level of detail captured in a log file.
traceability The ability to track a metadata element to its

transparent login A process that logs in authenticated users

without launching the login screen.


transparent partition A shared partition that enables users to

access and change data in a remote database as though it is


part of a local database.
triangulation A means of converting balances from one

currency to another through a third common currency. In


Europe, this currency is the euro for member countries. For
example, to convert from the French franc to the Italian lira,
the common currency is defined as the European euro.
Therefore, to convert balances from the French franc to the
Italian lira, balances are converted from the French franc to
the European euro and from the European euro to Italian
lira.
triggers An Essbase feature whereby data is monitored

according to user-specified criteria that, when met, cause


Essbase to alert the user or system administrator.
trusted user Authenticated user.

physical source. For example, in Essbase Studio, a cube


schema can be traced from its hierarchies and measure
hierarchies to its dimension elements, date/time elements,
measures, and, ultimately, to its physical source elements.
See also lineage.

tuple MDX syntax element that references a cell as an

traffic lighting Color-coding of report cells, or pins based on

two-pass An Essbase property that is used to recalculate

a comparison of two dimension members, or on fixed limits.

members that are dependent on the calculated values of


other members. Two-pass members are calculated during a
second pass through the outline.

transformation 1) A process that transforms artifacts so that

they function properly in the destination environment after


application migration. 2) In data mining, the modification
of data (bidirectionally) flowing between the cells in the
cube and the algorithm.
translation See currency conversion.

intersection of a member from each dimension. If a


dimension is omitted, its top member is implied. Examples:
(Jan); (Jan, Sales); ( [Jan], [Sales], [Cola], [Texas],
[Actual] ).

unary operator A mathematical indicator (+, -, *, /, %)

associated with an outline member. The unary operator


defines how the member is calculated during a database rollup.
Unicode-mode application An Essbase application wherein

character text is encoded in UTF-8, enabling users with


computers set up for different languages to share
application data.

328 Glossary

unique member name A nonshared member name that exists

vertical application server cluster A cluster with multiple

only once in a database outline.

application server instances on the same machine.

unique member outline A database outline that is not enabled

view A year-to-date or periodic display of data.

for duplicate member names.


upgrade The process of replacing a software release with a

visual cue A formatted style, such as a font or a color, that

newer release. The term upgrade does not apply to installing


a maintenance release. See also maintenance release,
migration.

highlights specific data value types. Data values may be


dimension members; parent, child, or shared members;
dynamic calculations; members containing a formula; readonly data cells; read-and-write data cells; or linked objects.

upper-level block A type of data block wherein at least one of

WebLogic Server home A subdirectory of Middleware home

the sparse members is a parent-level member.

containing installed files required by a WebLogic Server


instance. WebLogic Server home is a peer of Oracle homes.

user directory A centralized location for user and group

information, also known as a repository or provider.


Popular user directories include Oracle Internet Directory
(OID), Microsoft Active Directory (MSAD), and Sun Java
System Directory Server.
user variable A variable that ynamically renders data forms

based on a user's member selection, displaying only the


specified entity. For example, a user variable named
Department displays specific departments and employees.
user-defined attribute (UDA) An attribute, associated with

members of an outline to describe a characteristic of the


members, that can be used to return lists of members that
have the specified associated UDA.
user-defined member list A named, static set of members

within a dimension defined by the user.


validation The process of checking a business rule, report

script, or partition definition against the outline to ensure


that the object being checked is valid.
validation rules Rules used in FDM to enforce data integrity.

For example, in FDM, validation rules ensure that certain


conditions are met after data is loaded from FDM to the
target application.
value dimension A dimension that is used to define input

value, translated value, and consolidation detail.

weight A value assigned to an item on a scorecard that

indicates the relative importance of that item in the


calculation of the overall scorecard score. The weighting of
all items on a scorecard accumulates to 100%. For example,
to recognize the importance of developing new features for
a product, the measure for New Features Coded on a
developer's scorecard would be assigned a higher weighting
than a measure for Number of Minor Defect Fixes.
wild card Character that represents any single character (?)

or group of characters (*) in a search string.


WITH section In MaxL DML, an optional section of the query

used for creating reusable logic to define sets or members.


Sets or custom members can be defined once in the WITH
section and then referenced multiple times during a query.
workbook An entire spreadsheet file with many worksheets.
workflow The steps required to process data from start to

finish in FDM. The workflow consists of Import (loading


data from the GL file), Validate (ensures that all members
are mapped to a valid account), Export (loads the mapped
members to the target application), and Check (verifies
accuracy of data by processing data with user-defined
validation rules).
Workspace Page A page created with content from multiple

between planned and actual values).

sources including documents, URL, and other content


types. Enables a user to aggregate content from Oracle and
non-Oracle sources.

version A possible outcome used within the context of a

write-back The ability for a retrieval client, such as a

scenario of data. For example, Budget - Best Case and


Budget - Worst Case where Budget is scenario and Best Case
and Worst Case are versions.

spreadsheet, to update a database value.

variance The difference between two values (for example,

ws.conf A configuration file for Windows platforms.


wsconf_platform A configuration file for UNIX platforms.

Glossary 329

XML See Extensible Markup Language.


XOLAP An Essbase multidimensional database that stores

only the outline metadata and retrieves all data from a


relational database at query time. XOLAP supports
aggregate storage databases and applications that contain
duplicate member names.
Y axis scale A range of values on Y axis of charts displayed

in Investigate Section. For example, use a unique Y axis scale


for each chart, the same Y axis scale for all Detail charts, or
the same Y axis scale for all charts in the column. Often,
using a common Y axis improves your ability to compare
charts at a glance.
Zero Administration A software tool that identifies version

number of the most up-to-date plug-in on the server.


ZoomChart A tool for viewing detailed information by

enlarging a chart. A ZoomChart enables you to see detailed


numeric information on the metric that is displayed in the
chart.

330 Glossary

Index

Symbols
<>, 149
=, 149
\<, 149
\<=, 149
\>, 149
\>=, 149

A
access permissions
BQY documents, setting, 74
defined, 70
descriptions of, 73
setting, 70
access, setting access, 70
accessing relational data, 18
actions, multiple-cycle Interactive Reporting jobs,
269
active preference, user interface, 27
adaptive states
BQY documents, 74
adding
Exceptions Dashboard to Personal Page, 100
exceptions to Exceptions Dashboard, 77
file content windows on Personal Pages, 94
image bookmarks, Hyperion Foundation items, 97
My Bookmarks, 96
Personal Page content, 93
schedules, 254
sections, 121
versions, 80
Adjusting Data Type, 134
Administer Module toolbar, buttons defined, 22
Alert dialog, 114
alias
table, 228
using, 228

Allow Relational Aggregation, 227


APIs, exceptions, 293
applets in parameter forms, 295
area charts, 164
Arithmetic Operator, 135
artifacts
setting access permissions, 70
ASK parameters, 300
attributes, 195
auto-delete
Browse web module, 77
output for Interactive Reporting jobs, 259
Auto-Refresh Query, 226
Automatic data type, 134, 155
autosizing columns, 145

B
background jobs
set, 259
bar charts, 160
bar-line charts, 167
basic elements of parameter forms. . See parameter
forms
basics
Browse, 48
BEGINS WITH, 149
BETWEEN, 149
BLOB data type, 134
BLOB Images, 131
bookmarks
creating, 96
defined, 20, 91
image
items, 97
items, 96
My, 20, 91
BQY, 115

Index 331

document sections, embedding Personal Pages, 94


documents
setting access permissions on, 74
files, properties of, 78
section on a Personal Page, embedding a, 95, 96
break totals, in Results, 152
Broadcast Messages
as Personal Page element, 91
Broadcast Messages, Personal Page element, 20
Browse
basics of, 48
Content pane, 48
Building Interactive Reporting > Queries, 130
buttons
replacing, 80
Byte data type, 134

C
calendar, selection, 261
changing, colors on Personal Pages, 101
chart dimensions, 156
Chart section, 155
chart types
multi-dimensional, 162
charts
adding items, 168
focusing and hiding items, 169
removing items, 169
types of, 158
clustered bar charts, 163
columns
adding in Results section, 145
autosizing, 145
deleting in Results section, 145
sorting, 146
combination charts, 167
Comparison Operator, 136
conditional elements
in parameter forms[conditional elements
parameter forms], 298
connecting to data sources, Interactive Reporting
documents, 260
CONTAINS, 149
content
adding or removing from Personal Pages, 93
customizing Personal Page, 92
displaying HTML on Personal Pages, 93
332 Index

publishing, 67
viewing, 50
Content pane, 48
content windows
defined, 90
rearranging, 101
Controlling the size of the query result set, 18
copying
Personal Pages, 103
creating
bookmarks, 96
collection, 52
document, 52
folders, 51
Personal Pages, 102
personal recurring time events, 247
CubeQuery
Catalog, 195
CubeQuery section
missing label, 228
cumulative totals, 182
Custom Values, 150
customizing
Exceptions Dashboard, 100
Personal Page content, 92
cycle
defined, 258
cycles
actions, defined, 258
limits, 258
user defined, 261

D
Dashboard Home, 123
Dashboard, Exceptions, 97
data
accessing relational, 18
Data Function, 139
data function
pivot section, 183
data functions
compared to computed items, 138
in OLAP, 189
data labels in pivot tables, 178
data source
elements, 15
overview, 15

database connections, Planning Details, 18


Date command, 30
Date data type, 134
dedicated accounts, 291
default
folders, 26
permissions, 26
default job output format, 261
default parameter forms, 296
default Personal Page, setting the, 103
deleting
events, 249
files, 53
folders, 53
job output, 291
job parameters, 255
Personal Pages, 103
schedules, 254
deleting sections, 123
Dimensions, 187
dimensions and members, 192
displayed HTML files
on additional Personal Pages, 94
removing from Personal Pages, 94
displaying
HTML content on Personal Pages, 93
HTML files on Personal Pages, 93
secure job information, 292
documents, BQY, as Personal Page elements, 94
Download Database Totals, 224, 227
Downloading to Results in CubeQuey section, 214
drill anywhere, 186
drill down
in OLAP, 188
Drill Through, 209
drill up
in OLAP, 189
DrillDown, 186
Drilling in CubeQuery section, 205

E
elements
parameter forms
additional elements, 300
parameter display elements, 299
parameter list elements, 299
required elements, 299

types of, 298


elements, rearranging Personal Page, 101
email
linking, 54
recipient list, 54
email notifications, high priority item search, 90
embedding BQY sections on Personal Pages, 95, 96
Intelligence iServer, 94
ENDS WITH, 149
EQUAL, 149
events
creating a new personal recurring time, 247
defined, 241
deleting, 249
modifying, 249
viewing, 249
exceptions
supporting in generic report programs, 293
supporting in Production Reporting code, 292
Exceptions Dashboard, 292. See also
exceptions[Exceptions Dashboard:1]
add to Personal Pages, 100
customizing, 100
described, 258, 292
using, 97
explore
preferences, 26
Explore Module toolbar
buttons defined, 22
export
exceptions, 58
Production Reporting to Excel, 63
smart view options, 57
supported web applications, 57
exporting
items, 55
Smart View, 56
Exporting Data, 124

F
familial relationships, 193
favorites
overview, 19
Favorites Menu,commands defined, 23
features
Financial Management, 18
file content windows
Index 333

adding to Personal Pages, 94


removing from Personal Pages, 94
files
deleting, 53
HTML, 67
HTML files as Personal Page elements, 91
options of OCE, 79
owner, 76
properties of BQY, 78
publishing multiple, 67, 68
registering, 54, 55
renaming, 53
searching, 53
security mode, 291
size, 76
filter job list, 251
filtering member selections, 202
Browsing, 202
filters
in Results section, 147
deleting, 151
modifying, 150
Financial Management
features extended through Web Analysis, 18
overview, 18
studio features, 18
Financial Reporting Studio
database connections, 18
overview, 16
flag exception, 81
folders
creating, 51
deleting, 53
moving, 52
Production Reporting preferences, 28
renaming, 53
repository, 48
searching, 52, 53
subscribing to, 89
footer sections, in Personal Pages, 101

G
generations and levels, 194
generic report programs, support for exceptions, 293
grand total
in Results section, 152
GREATER OR EQUAL, 149
334 Index

GREATER THAN, 149


grouping and ungrouping
chart labels, 170
in pivot tables, 180

H
header sections, in Personal Pages, 101
hexadecimal color code settings in Personal Pages,
101
hide artifact, when publishing, 77
high priority. . See priority
HTML
default job output format, 261
displaying content on Personal Pages, 93
HTML files
as Personal Page elements, 91
publishing, 67
removing from Personal Pages, 94
security tags in, 290
Hyperion Reporting and Analysis
smart view export options, 57

I
icons
High priority, 293
modify properties, 292
image bookmark
item, adding an, 97
Personal Page elements, 91
image bookmark, Personal Page elements, 20
Impact Manager Module toolbar, buttons defined,
22
import
Interactive Reporting, 58
Include Consolidation Information, 227
INPUT parameters, parameter display elements, 300
installing
smart view from Workspace, 63
Integer (16bit) data type, 134
Integer (32bit) data type, 134
Integer command, 30
Intelligence Client sections . See sections.
Interactive Reporting
import, 58
jobs
action options for multiple-cycle, 269

properties, 259
setting job parameters for, 265
Interactive Reporting Studio, overview, 17
IS NULL, 149
item changes, subscribing to, 87
items
adding, image bookmark, 97
adding, My Bookmark, 96
exporting, 55

J
JavaScript, in parameter forms, 295
job defaults, Interactive Reporting jobs, 261
job output properties, modifying, 246
job parameters
defined, 241, 242
deleting, 255
modifying, 255
OLAP queries, 267
personal default, 244
setting Interactive Reporting, 265
setting SQR and generic, 247
when running a job, 244
job properties
generic, 286
Interactive Reporting, 259
Production Reporting, 276
jobs
action options for multiple-cycle Interactive
Reporting, 269
assigning forms to jobs, 296
deleting output, 291
filtering job list, 251
notification options when scheduling, 246
OLAP job parameters, 267
output as Personal Page elements, 91
properties of Interactive Reporting, 259
running, 243
scheduling, 244
secure Production Reporting jobs, 290
setting default job parameters, 244

K
Keep Only in CubeQuery section, 203
keywords
automatically generating, 77

L
layout of a Personal Page, modifying the, 100
layout styles, of Personal Pages, 100
legends, 157
LESS OR EQUAL, 149
LESS THAN, 149
LIKE, 149
line charts, 165
linking
Web Analysis Studio, 53
applications, 53
email, 54
links, graphic, 20, 91
lists
versions of file, 81
Logical Operators, 137
LongTtext, 134
looping elements
parameter forms elements, 298

M
measures, 189
Member Selection, 198
Browsing, 199
searching, 201
MIME types
defined, 77
unknown, 65
missing columns, 228
missing label, 228
missing rows, 227
modifying
events, 249
job output properties, 246
job parameters, 255
layout of Personal Pages, 100
properties of versions, viewing or, 81
schedule, 254
monitored exceptions
as Personal Page elements, 91
Month (for Add Date Groups) command, 30
moving between sections, 122
MS Excel, 125
multiple files, publishing, 67, 68
multiple-cycle Interactive Reporting jobs, action
options for, 269
My Bookmarks
Index 335

adding as Personal Page elements, 96


defined, 20, 91

N
Native File Format, 126
navigating sections, 120
no access label, 228
NOT (with operator), 149
NOT EQUAL, 149
notifications
deleting job, 250
options for job, 246
subscribe to items, 87
viewing an item when you receive, 90
number formats, default, 30
number formatting, 146
Number of members to display, 227

O
objects, security mode, 291
OCE files
defined, 262
options of, 79
OLAP job parameters, 267
OLAP section, 187
OLAP terminology, 187
OPEN statement (Production Reporting), 291
opening
documents, 43
files, 43
folders, 43
Operator, 135
operators, 149
options and properties, when publishing all artifacts,
75
options,import, 58
output from jobs
as Personal Page elements, 91
deleting, 291
permissions, 290
security mode, 291
output properties, modifying job, 246

P
Packed Real data type, 134
Paging Icons, 113
336 Index

parameter forms
additional elements, 300
assigning default, 296
assigning to jobs, 296
basic, conditional, and looping elements, 298
examples and tips, 305
importing files, 299
parameter display elements, 299
parameter list elements, 299
required elements, 299
submit for processing code snippet, 299
switching to default form, 296
tags, 297
parameter lists
parameter display elements, 299
parameter forms elements, 299
parameters
deleting job, 255
modifying job, 255
setting
Interactive Reporting job, 265
SQR and generic job, 247
pass-through
Interactive Reporting jobs, 258
Production Reporting and generic jobs, 278
using multiple OCE files, 262
PDF, 124
permissions
default, 26
permissions, setting access permissions, 70
Personal Pages
adding a file content window on additional, 94
adding Exceptions Dashboard, 100
changing colors, 101
content, adding or removing, 93
content, customizing, 92
creating, 102
default, 103
deleting, 103
displaying HTML files, 93
elements, rearranging, 101
embedding BQY sections, 95, 96
headers and footers, 101
modifying the layout, 100
publishing, 104
removing file content window, 94
restoring, 103

setting the default, 103


personal pages, overview, 20
personal recurring time events, creating, 247
personalizing
masthead, 31
view pane and content area, 31
Workspace, 30
pie charts
described, 159
pivot dimension, 178
Pivot Facts, 182
Pivot Section
paging, 184
Pivot section, 178
adding, 178
adding items, 179
sorting by labels, 185
pivot tables
components, 178
deleting pivot items, 179
focusing and hiding items, 180
swing feature, 181
working with, 178
Planning Details ADM driver, 18
preferences
explore, 26
Interactive Reporting, 29
module, 25
Production Reporting, 28
priority, set, 81
process options, Interactive Reporting multiple-cycle
jobs, 268
Production Reporting
jobs
OPEN statement, 291
secure and nonsecure output from same job,
291
secure jobs, 290
permissions, 290291
recommendations, 291
security mode, 291
security tags in , 290
viewing security information, 292
Production Reporting jobs
secure Production Reporting jobs, 290
Production Reporting preferences
folders, 28

Production Reporting programs


exceptions support, 292
Production Reporting Studio, overview, 17
Production Reporting toolbar,buttons defined, 21
Production ReportingProgramOutput object, 291
properties
BQY files, 78
generic job, 286
modifying job output, 246
Production Reporting job, 276
security mode, 291
versions, 81
versions, viewing or modifying, 81
Properties dialog box, 296, 297
publishing
about, 65
add to Exceptions Dashboard, 77
auto-delete, 77
content, 67
default job output format, 261
hide artifact, 77
HTML files, 67
jobs
pass-through, Production Reporting, 278
multiple files, 67, 68
Personal Pages, 104

Q
queries
refreshing, 143
Query Options, 226

R
Ragged Hierarchies, 218
Real command, 30
Real data type, 134
recurring time events, creating new personal, 247
Reference Line General Properties, 175
Reference Line Label Format Properties, 175
Reference Lines, 171
referential items
in Chart and Pivot sections, 185
Refreshing a Query, 143
relational data, access, 18
Remove Only in CubeQuery section, 204
removing

Index 337

embedded BQY sections, 96


file content windows from Personal Pages, 94
Personal Page contents, adding or, 93
subscriptions, 89
removing Request items, 131
removing Request line items, 131
renaming
files, 53
folders, 53
renaming sections, 122
replacing
BQY jobs and OCE files, 80
buttons, 80
Report section, 233
repository
folders, 48
shortcuts, 47
URLs, 47
user preferences, 44
Request items, 131
required files
for generic jobs, 278
for Production Reporting jobs, 278
ribbon charts, 167
role, access permissions, 44
row-level security, 66
rows
deleting in Results section, 145
running jobs, 243

S
saving
file, 51
saving files locally, 126
Schedule toolbar,buttons defined, 22
schedules
adding, 254
defined, 241
deleting, 254
modifying, 254
scheduling jobs
general, 244
Search Services
indexing keywords, 36
introduction, 35
search syntax, 38
security, 41
338 Index

supported MIME types, 39


using Advanced Search, 37
using the Search Service, 36
searching, 202
files, 53
folders, 53
sections
adding, 121
deleting, 123
moving between, 122
renaming, 122
sections, BQY documents, as Personal Page elements,
94
Secure jobs, security tags, 77
Secure mode, 292
secure Production Reporting jobs. . See Production
Reporting
security
Production Reporting job recommendations, 291
row-level, 66
viewing security information, 292
security tags
in secure Production Reporting programs, 292
Select A Formatting Locale command, 30
setting
access permissions, 70
default Personal Page, 103
Shared Members, 209
shared members, 227
Shortcut Menus, 114
shortcuts
repository, 47
Show Values, 148
show, latest version, 81
Showing Negative and Positive Values, 160
Showing Pie Percent, 160
Smart View
exporting, 56
smart view
installing, 63
SmartCuts
defined and location, 76
sorting
charts and pivot tables, 185
in OLAP, 188
in Pivot and Chart sections, 185
sorting by

functions, 185
labels, 185
values, 185
SPF file format, 285
SPF files
publishing as jobs, 290
recommendations for security, 291
secure Production Reporting jobs, 290
SPFFileOutputCollection object, 291
SQR and generic job parameters, setting, 247
stacked area charts, 165
stacked bar charts, 164
Standard toolbar, 21
String data type, 135, 155
subscribing
about, 83
items, 87
subscriptions
removing, 89
substitution variables, 200
Suppressing Missing and Zero Values, 204
surface values, 183
Swing, 210
swing feature, in pivot tables, 181

Web Analysis Studio, overview, 16


windows, rearranging content, 101
Workspace
file permissions, 44
installing smart view, 63
personalizing, 30
Workspace Pages, Using, 19, 104

templates:Workspace Pages, 105


termination conditions in parameter forms, 299
three-dimensional charts, viewing, 163
Time Aware Axis, 166
Time command, 30
Time data type, 135
time events
creating new personal recurring, 247
defined, 242
Timestamp command, 30
TimeStamp data type, 135
Topics and topic items, 128
totals
cumulative totals, 182
in Results section, 151
pivot total function, 182
surface values, 183
Trend Line general properties, 173
Trend Line Label format properties, 174
Trend Lines, 172

URLs,repository, 47
user interface
active preference, 27
resizing the masthead, 31
resizing the view pane and content area, 31
using data source elements, 15

V
Variable Filter, 141
variables in CubeQuery section, 201
versions
adding, 80
flag exception, 81
setting priority, 81
showing latest, 81
working with, 79
viewing
content, 50
events, 249
items when receiving notification, 90
properties of versions, 81

Z
zero columns, 228
zero rows, 227

Index 339

340 Index

You might also like