Professional Documents
Culture Documents
System
Oracle Hyperion Reporting and Analysis Framework
User's Guide
Release 11.1.2.2
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
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
Contents
vii
viii
Contents
Contents
ix
Contents
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.
13
14
Documentation Accessibility
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.
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.
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
Data restriction
Data edits
Suppression of rows that contain #MISSING values, zero values, and shared members
Relational drill-through
17
Organization by period
User-defined fields
Relational drill-through
Repository
18
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.
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
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.
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.
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
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
Creating bookmarks
20
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
Description
Create documents, such as Financial Reporting books and batches, Web Analysis
documents, Interactive Reporting document, and Workspace Pages
NA
NA
21
Explore Toolbar
Table 2
Button
Description
Creates folders
NA
Open the Properties dialog box, used to set file properties; for example, file permissions
Schedule Toolbar
Schedule module toolbars enable you to perform the following tasks:
l
22
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
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
Description
Go Up A Level
New Folder
Open
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
Collapse
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
23
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
Copy
Paste
Delete
For Interactive Reporting documents, delete items with job outputs, if there are outputs
Rename
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
Create Shortcut
Create document shortcuts, for example, create shortcuts to Interactive Reporting, PDF, and HTML
documents
Retrieve
Schedule Job
Add to Favorites
Refresh
Edit Permissions
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
Setting Preferences
Subtopics
l
l
l
l
l
l
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.
In User Name, enter the user name you want to use for Pass-Through.
Click OK.
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.
26
Generic jobs
Folders
Click OK or Cancel.
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
Formatting Options
Description
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
Positive Suffix
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
Numeric Formatting
Grouped Thousands Check Box
Minimum Decimals
Maximum Decimals
Scale
Samples
Update Samples
Updates the samples panel based on the most recent formatting selections
28
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.
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.
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
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.
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
Table 6
Field
Description
Date
Timestamp
Time
Default month format for the month used in Add Date Groups
Real Number
Integer
Null
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 Task
Modules
All modules
Show/hide Masthead
All modules
All modules
Explore
Explore
30
Customization Task
Modules
Explore
Explore
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.
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.
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.
arrows.
Setting Preferences
31
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.
Optional: For the list of file type groups, you can select only one file type group from the list.
Table 8
32
Option
Description
All Jobs
External Links
Microsoft Word, Excel, Power Point, and Project files. It also displays files with the file extensions .mht, .
mhtml, or .nws
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 Images
Hyperion
.gif
.jpeg
.png
.bmp
.tiff
.xbm
.xwb
Financial Reporting reports, snapshot reports, books, snapshot books and batches
All jobs
All connections
HTML files
Setting Preferences
33
Option
Description
Standard
Other
.xls
.doc
.mpp
.ppt
.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
.html
.txt
.xml
.zip
.rtf
34
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
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
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
Description
Document type
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.
Click the Advanced Search link on the Search Results page, or select Tools, then Advanced Search.
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.
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
Table 9
Search Term
Request
"sales +LanguageCodes:de"
Documents that contain the term sales and the language to be German
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
Syntax
Description
AND
NOT
()
38
Syntax
Description
[]
*, ?
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 sales but not oracle, or sales but not radio:
+sales (oracle radio)
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]
39
Table 11
MIME Types
MIME Type
Description
application/hyperion-analyzer-presentation
Presentation
application/hyperion-analyzer-report
application/hyperion-annotation
Annotations
application/hyperion-reports-batch
application/hyperion-reports-book
application/hyperion-reports-chart
application/hyperion-reports-grid
application/hyperion-reports-image
application/hyperion-reports-report
application/hyperion-reports-row_column
application/hyperion-reports-snapshot_book
application/hyperion-reports-snapshot_report
application/hyperion-reports-text
application/msword
application/pdf
application/rtf
application/sqr_viewer
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/x-brioquery
application/x-SQR
BrioQueryJob
OCEFile
text/html
text/im-javascript
text/plain
40
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
3
In This Chapter
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
Interactive HTML
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
44
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
Type
Description
Created in
File Extension
Production Reporting
document
.spf
Interactive Reporting
document
.bqy
Web Analysis
document
.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
Type
Description
Created in
File Extension
Job Output
EPM Workspace
Books
EPM Workspace
.kbk
Snapshot Books
EPM Workspace
.kbt
Batches
EPM Workspace
.bch
Presentation
.apt
Supporting Files
The following tables lists EPM Workspace supporting files used when authoring or managing
documents or collections.
46
Table 14
Workspace Supported File Types, Descriptions,Studio Created in, and File Extensions
Type
Description
Job
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.
.oce
Folder
not applicable
none
Shortcut
not applicable
none
URL
not applicable
none
Grid
Reporting Studio
.rog
Chart
Reporting Studio
.roc
Image
Reporting Studio
.roi
Text
Reporting Studio
.rot
.ros
Items
47
Type
l
Studio created in
File Extension
.adc
Description
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
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.
Priorities
File Type
Description
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
Exceptions
File Type
Exceptions
Programmatically enable jobs to generate exceptions. The exception icon is not displayed next to the
job. See Using Exceptions on page 97.
49
Managing Files
Subtopics
l
l
l
l
l
l
l
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 view or interact with the opened item, see Using Different File Types on page 84.
50
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.
Click Options.
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
Snapshot Book
Book
Batch
Workspace Page
To save a file:
1
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
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: \,%,?,+,<,>,|,`,*,".
Interactive Reporting, see Using the Interactive Reporting Toolbars on page 112
Book or Snapshot book, see Oracle Hyperion Financial Reporting Workspace User's Guide
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
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
Select
Select the folder where you want to copy or move the item.
52
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.
Select Explore.
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.
53
Link to Web Analysis Studio by selecting Tools, and then Links. For more information, see
the Hyperion Web Analysis Workspace User's Guide.
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 must select and send email links one item at a time.
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.
Optional: Update the Subject text associated with the email message.
Click Send.
Note: You cannot recall a message after it is sent.
54
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
.
.
To open and view the item, see Opening or Selecting Files or Folders on page 50.
Exporting Items
From Explore, only Financial Reporting items have an export option. Export items for the
following usages:
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
Navigate to items:
l
To filter the list of items, from the Type list, select the file type.
Click Save.
Navigate to the location where you want to save the exported file.
Click Save.
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
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
Note: Review the Oracle Hyperion Enterprise Performance Management System Certification
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
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
Web Applications
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
57
Web Applications
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.
Responding to prompts
User POV
Grid POV
Page members
Expansion.
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
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
Select a Document
Select an Action
Specify Filters
Preview
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.
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.
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.
Click Finish.
If the Interactive Reporting document requires a user a variable filter value, click Next.
60
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.
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.
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.
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.
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
2. Click Next.
61
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 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.
In Select a Document, expand the repository and select the job to import.
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
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.
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.
By default, the installation wizard installs Smart View program files to C:\Hyperion
\SmartView. You can specify an alternative installation directory.
Select Navigate , then Explore and choose File, then Import, and then File as job.
Proceed through the pages in the wizard. When you get to the last page, select Excel (.xls) as the output
option.
63
64
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
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.
Importing
65
Table 18
Reporting and
Analysis Product
Financial
Reporting
Description
l
Books (*.kbk)
Note: To import these files, you must use the Import, then Financial Reports menu item.
Production
Reporting
Interactive
Reporting
Web Analysis
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.
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
Function
File
66
Importing Artifacts
Job
Function
File
Job
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
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.
Enter a description, click Next or select Finish without specifying any Advanced options. If you select
Finish, skip the following steps.
Complete permissions, , see Setting Permissions and Pushing Artifacts on page 70.
Click Finish.
Note: To return to a previous pages, click Back.
From Explore, navigate to the folder in which you want the files to reside.
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.
68
Importing Artifacts
create generic jobs. Schedule, set options on and execute the job using the Schedule module, see
Scheduling Jobs on page 241.
From Explore, navigate to the folder where you want to place the artifact.
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.
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.
Complete step 3, Permissions. To specify permissions for the artifact, see step 1.
Importing Artifacts
69
Click Finish.
Select Import.
Setting Permissions
Subtopics
l
l
Access permissions define your level of access - view, modify, full control. When you import
artifacts, you:
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
To apply permissions to artifacts within folders, you need proper permission and role.
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.
To complete Apply Permissions to Children dialog, see Applying Permissions to Children of the Selected
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
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.
Control permission.
Example of Inherit Permission
The following is an example of a BQY file and permissions set in the Permissions dialog.
UserA:
l
GroupA:
l
RoleA:
l
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.
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
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
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
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.
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
name to be removed.
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
74
Adaptive State
Description
Inherit
Not set to anything. This permission defaults to View Only if this is the only permission set.
View Only
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.
Create and modify charts, pivots and reports in the document and refresh data. Cannot modify the query.
Create and modify charts, pivots and reports in the document and refresh data. Can build and limit queries
before processing.
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
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
Creating Shortcuts
75
General Properties
Most artifacts have these general properties:
Table 21
General Properties
Definitions
File
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.
Size
SmartCut
(Read-only)
AURL pointing to a file.
Shortcut To Folder
Set this when you import to store the file in WinZip format. This saves disk space, but slows down viewing.
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
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.
(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
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
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
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.
77
Advanced Properties
Definitions
Used to delete job output after a specified time interval. The job output is deleted when all of these conditions
are met:
l
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.
Setting Permissions
Set rights for users to access files. See Setting Permissions and Pushing Artifacts on page 70.
Descriptions
Character encoding
78
Importing Artifacts
URL Properties
In addition to General Properties and Advanced Properties, URLs have these properties:
Table 24
URL Properties
URL Properties
Descriptions
Character encoding
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.
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.
79
Note: To change imported versions for Interactive Reporting jobs or Interactive Reporting
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
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.
80
Importing Artifacts
From Explore, click the artifact whose version you want to edit.
Select Versions.
Select Modify.
The only changeable properties are Description, Flag as an Exception, and Message, see
Version Properties on page 81.
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
Last modified
(Read-only) Date the version was changed. Changing versions includes replacing or modifying its properties.
Modified By
Priority
indicates high priority. Users can sort on priority, and search for high-
This property is available if your administrator activated the priority feature on your system.
Size
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.
81
Deleting Versions
Delete one or more versions together.
To delete versions:
1
From Explore, navigate to the artifact whose version you want to delete.
Click OK.
82
Importing Artifacts
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
Web Analysis documents, see Hyperion Web Analysis Workspace User's Guide
Interactive Reporting documents, see Interacting with Interactive Reporting Documents
on page 115
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.
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.
Using Favorites
Subtopics
l
l
l
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.
Add folders then use Favorites to access that folder; you cannot access items within the folder
directly.
Using Favorites
85
artifact.
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
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.
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.
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
86
after highlighting
Managing Favorites
Manage items in Favorites:
1
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
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.
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.
Select Explore, and navigate to the item you want to subscribe to.
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
Click OK.
Select Explore, and navigate to the item you want to subscribe to.
From Personal Pages tab, click Add Sections of Interactive Reporting document.
Click OK.
From EPM Workspace, select Favorites, and then Show Subscribed Items.
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.
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.
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.
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
HTML files
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
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.
91
Figure 1
Note: If your administrator configured the use of heading bars, each content windows title is
Broadcast Messages Heading BarFormat the Heading bar for each content window.
Exceptions DashboardLists job exceptions and notification messages or items that are
flagged for exceptions.
File Content WindowDisplays the contents of an HTML file.
92
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.
From Explore, navigate the folders until you find the document to add to your Personal Page.
If this option is not available, this file/output cannot be displayed as a file content window.
93
Optional: To add the file content window to a personal page, click the desired personal page.
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.
Select OK.
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.
Select Explore, and navigate to the Interactive Reporting document or job output file.
Click Add.
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.
Select Navigation Only, to have the first page, previous page, next page, and last
page toolbar buttons only.
95
Select Standard, to have all toolbar buttons except for the Interactive Reporting
Server help button.
Select None, to have no toolbar displayed.
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.
Select Explore, and navigate the folders until you find the item containing the embedded sections you
want to remove from your Personal Page.
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.
The new bookmark is displayed on every Personal Page that includes the My Bookmarks
item.
Select OK.
96
On Subscribe Settings, select Add As Image Bookmark, and specify the following information:
Select OK.
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.
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:
97
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.
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.
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.
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.
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.
Select Explore, and navigate to the item that has an exception you want to monitor.
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.
Right-click the item, and from the shortcut menu, select Subscribe.
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.
99
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
To put content windows in a section across the top or bottom of the Personal Page, click Show Header
Section or Show Footer Section.
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.
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.
Select
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.
Change all my Personal Pages to use this Color SchemeApplies the specified color
scheme to all your existing Personal Pages.
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.
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.
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
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
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 the personal page(s) you want to copy from the list, select Finish.
Select
Select the Personal Page you want to delete from My Personal Pages.
Select Restore Settings to restore the deleted Personal Page to the list.
Setting Defaults
The first personal page in the list is the default personal page.
Use the up arrow to move this page to the top of the list.
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
Favorites
Alerts or Exceptions
Applications
URL
Text files
Image files
HTML files
XML files
RTF files
PDF files
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
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.
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
11 Optional: Select
to maximize the content to consume the entire content area. Once maximized, you
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
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.
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.
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.
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.
Recently Opened
l
Stores recently opened items for each user provisioned in EPM Workspace
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
To set the EPM Workspace start page back to Home page installed in the Shared Workspace
Pages folder:
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
Use the Standard and Interactive Reporting toolbars to navigate through theEPM Workspace
and work with common commands.
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
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]
[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.
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)
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
Click Finish.
A new Interactive Reporting document file (BQY) is created based on the selected Interactive
Reporting document.
EPM Workspace
Relational
Yes
No
CubeQuery
Yes
Yes
OLAPQuery
Yes
No
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.
Click Finish.
A new Interactive Reporting document file (BQY) is created based on the selected Interactive
Reporting database connection file.
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 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.
Click OK.
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 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.
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.
To save an Interactive Reporting document file to the EPM Workspace Repository, select
File, and then Save.
Optional: You can also click
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
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:
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.
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.
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.
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
You can also select the section to be renamed and choose Edit, then Edit, and then Rename.
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
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.
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.
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
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.
Optional: You can also print an Interactive Reporting document file to PDF by selecting File,
then Print via PDF.
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 Save.
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.
Query Section
Subtopics
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
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).
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.
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.
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
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.
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).
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.
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
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
To apply a sort, drag a topic item from the Request pane to the Sort pane.
Select
If you add more items than the Request pane can display, resize the browser.
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.
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.
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
See also:
l
section), which is particularly useful when they are added to the report group headers (via
outliner).
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.
Select an item in the Request pane and choose Actions, and then Computed Item.
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.
Enter the definition of the computed item in the Definition text box.
l
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.
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
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
Data Type
Specification
String
Time
TimeStamp
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
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
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
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
Operator
==
!=
Operator
<
<=
>
>=
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}
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 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.
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
Query
Sum
Sum of underlying values. This is the default in Results and report sections.
All
Average
All
Non-Null Average
Minimum
All
Maximum
All
Count
All
CountDistinct
Number of distinct values in a column. This function is not supported by all database servers
Query
Null Count
Non-Null Count
Standard Deviation
Standard deviation of values. This function is not supported by all database servers.
Query
Variance
Query
Weight
Query
% of Column
Pivot
% of Row
Pivot
% of Grand
Pivot, Chart
Function
Returns
Availability
% of Category
Report
Increase
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.
aggregate filter line is read only and a new aggregate filter cannot be created.
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.
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 Set.
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.
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.
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.
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 Set.
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.
Drag one or more items in the Request pane and drop them into the Sort Pane.
Drag one or more items in the Request pane and drop them into the Sort pane.
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.
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
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.
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
Drag Results items from the Catalog list to the Table Data Layout.
Adding a Column
Deleting a Column
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
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.
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.
To sort a column:
1
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
Currency
Option
Description
Percentage
Table 34
Option
Description
Example
()
$%
Adds the respective character to numeric values in the same position relative
to the decimal point.
m d yy
Apply mm dd yy to show 05 07 99
-/
Show Values
Custom Values
Custom SQL
Modifying Filters
Deleting Filters
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.
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 Set.
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.
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.
Operator
Equal (=)
Begins With
Begins with the specified value(s) up to and including the end value.
Contains
Ends With
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.
Click Set.
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.
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.
In the Values field, enter the values to which you want to set as a filter.
To remove a value from the Values panel, highlight the item in the Values pane and click
the - (subtraction sign).
Click Set.
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.
Type your SQL where clause containing the expression to use for the filter in the Values pane.
Click Set.
Modifying Filters
Once a filter exists for data in your query or results, you can later add or modify filter conditions.
To modify a filter:
1
The following table provides a quick reference to the Modify Filter option:
Command
Description
Set
Ignore Filter
Cancel
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.
See also:
l
Returns the:
Sum
Average
Maximum
Minimum
Count
Select the column and choose Grand Total on the shortcut menu.
The grand total is displayed in a new row at the bottom of the last page in the selected column.
Select a column to which a grand total was applied and choose Grand Total on the shortcut menu.
Select the row to which a grand total was applied and choose Grand Total on the shortcut menu.
Select Delete.
Data Function
Description
Sum
Average
Maximum
Minimum
Count
Select the column and choose Break Total on the shortcut menu.
Select the row to which a break total was applied and choose Break Total on the shortcut menu.
Select Delete.
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
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.
Select an item in the Request pane and choose Actions, and then Add Computed Item(s).
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 (_).
Table 36
Data Type
Specification
Automatic
A data type is determined automatically given the data type of the reference items and the computations performed
Number
String
Date
Picture
Picture (Blob) data types for image formats such as: jpeg, bmp, gif, and png.
Paging Option
Description
Current Page
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
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.
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.
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:
In the third example, the legend has been set on the z axis:
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
Pie Charts
Bar Charts
Scatter Charts
Bubble Charts
Area Charts
Line Charts
Ribbon Charts
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.
To toggle the display of negative values, select a slice of the pie and select Show Negative
Values on the shortcut menu.
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.
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 Hide feature hides the whole data series in a scatter chart, and an individual item cannot
be hidden.
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 that defines the size or width dimension of a bubble in proportion to the amount of
data
Data functions are not available (this type of chart relies on non-aggregated data)
Hide hides the whole data series in a bubble chart; an individual item cannot be hidden.
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.
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
Area Charts
Line Charts
Ribbon Charts
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.
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.
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.
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.
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.
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
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.
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).
Adding a Chart
To create a Chart based on the Results section data:
1
Drag Results items from the Catalog List to the Chart data layout.
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 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.
Select the item to be removed in the Chart from the data layout.
The chart is redrawn to reflect the new configuration of items in the chart.
To refresh chart values manually, click anywhere on the chart and select Refresh Chart on
the shortcut menu.
To show all items in a chart, select a chart item and choose Show Hidden on the shortcut
menu.
To show hidden items, select a chart item and choose Show Hidden on the shortcut menu.
(You can group contiguous or discontiguous labels, but the labels must be part of the same
dimension item or axis.)
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 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.
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.
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.
For more information about general reference lines, see Reference Line General
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.
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.
To add a trend line, select a chart item that represents a data fact and on the shortcut menu,
select Add Trend Line.
Table 39
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
Bring to front
Send to back
Property
Description
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>)
{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
Equation Type
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.
Property
Description
Fixed
(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
Bring to front
Send to back
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.
Property
Description
(Custom
Format)
[FC]fact name
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
Function
Value
Shows the value of the reference line, for example: Value = 0.7348.
Table 43
Data Function
Returns the:
Sum
Average
Count
Count Distinct
Maximum
Minimum
Perc of Grand
NonNullCount
Each column is recalculated according to the data function applied to the underlying value.
Paging Option
Description
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.
Pivot Section
Subtopics
l
l
l
l
l
l
l
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.
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
Auto-Sizing a Column
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.
From the Catalog list, select any item and click Add Items on the shortcut menu.
Select the item to be removed from the Facts, Rows or Columns data layout.
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
To show all items, select a dimensional label and choose Show All on the shortcut menu.
To hide pivoted data:
1
Select an item.
To restore a selected hidden item, select a pivot item and choose Show Hidden on the shortcut
menu.
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.
(You can group contiguous or discontiguous labels, but the labels must be part of the same
dimension item or axis.)
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.
Select a direction.
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.
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
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).
Selecting the outermost label creates a total; selecting an inner label creates a subtotal.
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.
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.
Select a column in which a cume has already been place in the pivot tables data grid.
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.
Data Function
Returns the:
Sum
Average
Data Function
Returns the:
Count
Count Distinct
Null Count
Non-Null Count
Maximum
Minimum
% of Row
% of Column
% of Grand
Select a function.
Each column is recalculated according to the data function applied to the underlying value.
Paging Option
Description
Current Page
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.
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).
To specify a sort:
1
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.
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
Because the drill-down into feature is not context sensitive, access the drill-down from any
label shown.
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.
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.
The report is redisplayed, reversing the drill-down and displaying the original item.
OLAPQuery Section
Subtopics
l
l
The OLAPQuery section is designed for viewing and analyzing queries based on
multidimensional databases (MDD).
OLAP Terminology
Auto-Sizing a Column
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
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
To specify a sort:
1
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.
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.
Select a label.
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
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
Optional: You can also select a label and choose Action, then Drill Down.
Table 47
Data Function
Returns the:
Sum
Average
Count
Number of values
Maximum
Highest value
Minimum
Lowest value
% of Row
% of Column
% of Grand
Each column is recalculated according to the data function applied to the underlying value.
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
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
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
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.
Number
Description
Ancestor
Parent
Child
Descendent
LevelsCounted from bottom to top: Level 0, Level 1, Level 2, and so on. In the following
figure, states are at Level 0
Number
Description
Ancestor
Parent
Child
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 + .
Slicer
Filters
Side
Rows
Top
Columns
One filter member can be selected per dimension. Filters for multiple
members within the same dimension are not supported.
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.
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).
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.
Specify a user name and password, and any appropriate data source access settings.
Click Finish.
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.
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.
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.
Check Existing Essbase Connection to select the current Interactive Reporting database connection
file (.oce), or select another from the drop-down and click OK.
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.
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.
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.
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.
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
Dynamic Function
Description
Member
Children
Descendants
Icon
Dynamic Function
Description
Bottom
Siblings
Same Level
Same Generation
Browsing Members
Use the Member Selection Browse tab to navigate through and select individual members to
include in the query.
In the data layout, on the shortcut menu, select a dimension member and select Edit.
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
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
Click OK.
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.
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.
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.
Select a member in the data layout and select Edit on the shortcut menu.
Select Browse.
To include a substitution variable, select the member in the Available pane and click
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.
Click OK.
Searching Members
To search for members:
1
Select Search.
NameMember 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
.
Click OK.
In the Filter pane of the data layout, select a dimension member and select Edit on the shortcut menu.
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
To include a member as a dynamic function, in the Available pane, select the member and select
Member on the shortcut menu.
Click OK.
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
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.
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
Navigating CubeQuery
For navigating and maintaining data in the CubeQuery section, see:
l
Keep Only
Remove Only
Drilling
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.
Select a dimension label and select Keep Only on the shortcut menu.
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.
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.
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).
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.
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
DownDrills down to more dimension detail using the default drill level defined in
Query Options.
UpDrills up to less dimension detail.
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.
The following topic mappings are defined for the drill through:
Table 48
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:
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
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.
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.
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.
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.
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:
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:
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
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.
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
2963
3079
3149
2834
Sarsaparilla
1153
1231
1159
1093
Birch Beer
908
986
814
1384
6721
7030
7005
7198
Root Beer
Table 50
Results Set
Category
Product SKU
Year
Profit
Colas
Cola
Qtr1
5096
Colas
Diet Cola
Qtr1
1359
Colas
Qtr1
593
Root Beer
Old Fashioned
Qtr1
1697
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
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
2963
3079
3149
2834
Sarsaparilla
1153
1231
1159
1093
Birch Beer
908
986
814
1384
Dark Cream
2544
3231
3355
3065
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
Qtr1
593
Qtr2
446
Qtr3
400
Qtr4
544
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
1493
1606
Product SKU
Quarter
Sales
COGS
Cola
Qtr1
14585
5681
Diet Cola
Qtr1
7276
3496
Qtr1
3187
1493
If no Measures are in the row, column or filter, all data values appear in a Value column.
Table 55
Product SKU
Quarter
Value
Cola
Qtr1
14585
Diet Cola
Qtr1
7276
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.
Table 56
Product
Jan
8024
Feb
8346
Mar
8333
Qtr1
24703
Qtr2
27107
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
Quarter
Month
Gen1,Product
Value
Qtr1
Jan
Product
8024
Qtr1
Feb
Product
8346
Qtr1
Mar
Product
8333
Qtr4
Dec
Product
8780
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
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
Qtr1
20020
2963
30030
2695
Diet
7017
Product
Table 61
24703
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.
Table 62
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
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
10020
10020
Actual
Actual
100
10010
Qtr1
5096
Actual
Actual
100
10020
Qtr1
1359
Scenario, Gen2
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
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
Gen1, Product
Category
Product SKU
Quarter
Value
Product
100
10010
Qtr1
5096
Product
100
10020
Qtr1
1359
Product
100
10030
Qtr1
593
...
Category, 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
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.
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.
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
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.
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.
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 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.
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.
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
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.
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.
Removes all dimension groups that are not in the selected group.
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.
The Reference sub dialog box of the Computed Item dialog box is not available.
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.
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.
Sort Ascending
Sort Descending
Auto-size Column
Drill Anywhere (with sub-menu listing available columns from parent Results/Table)
Drill Up
Focus on Items
Hide Items
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
Drill Anywhere
Drill Up
Focus on Items
Hide Items
(Un)Group
Show Label
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
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 Option
Description
Current Page
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.
7
In This Chapter
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:
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.
Icon
Description
Displays the report in a Portable Document Format (PDF) and launches it in a new browser
window.
Downloads the report data in a Comma Separated Value format (CSV) and displays it in a
new browser window.
Downloads the report data in a Brio Query Data format (BQD) format and displays it in a
new browser window.
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
Table 69
Icon
Description
Go to First Page
Displays the first page of the report in the current browser window.
Go to Previous Page
Go to Page
Go to Next Page
Go to Last Page
Scheduling Jobs
8
In This Chapter
Overview
In EPM Workspace, you use the Schedule module to perform the following tasks:
l
Overview 239
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.
For Interactive Reporting jobs, a link to the output in the folder where the job resides
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
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
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.
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
Schedule Status
Description
active
active
active
inactive
inactive
active
inactive
inactive
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
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.
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.
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.
For Production Reporting and Generic jobs, browse to specify a folder destination for the job output.
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.
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.
From Explore, navigate to the job you want to run, right-click, then select Run Job.
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.
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
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 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.
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.
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.
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.
From Explore, right-click the job output file, and then select 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
To manage events:
1
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.
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.
Triggered Event.
The Create Personal Recurring Time Event dialog wizard is displayed. Enter the time event name and
description.
the events active status by using the Manage Events panel in the Scheduler.
Select the calendar you want to use for this time event.
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.
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.
Repeat step 1 through step 10 above. The only exception is to select Externally Triggered 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.
Viewing Events
You can view all your events from the Manage Events panel in the Schedule module.
To view events:
1
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
To filter the events list, select Filter from the toolbar area. Complete the Filter dialog and select Apply.
Change properties.
Click OK.
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
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
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:
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.
To delete one notification, select the job, right-click, then select Delete.
To delete all notifications, select the jobs, right-click, then select Delete.
Filter the job list shown in the Consolidated Job Status List, see Filtering Consolidated Job
Status List on page 251.
Run Now. Run the scheduled job again with parameters used previously when the job failed.
See Run a Scheduled Job Now on page 252.
Select the Navigate, then Schedule, and then Consolidated Job Status.
l
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.
To set filters and sort criteria for the Consolidated Job Status List:
1
If default filter settings do not exist, select filter settings by selecting Filter from the toolbar. Filter dialog
is displayed..
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
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.
Select After, Between, or Before from the drop-down list and the year, month, and day for your selection.
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.
Artifact
Job Type
User Rights
Generic Job
Simple
Administrator
Generic Job
Simple
Generic Job
With Parameters
Simple
Artifact
Job Type
User Rights
With parameters
Administrator
Simple
Simple
With parameters
Administrator
With DB connection
With DB connection
Administrator
Select a job which had been run successfully by the schedule with notifications enabled.
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.
Review Job Parameters information, select a job, right-click and select Show Parameters.
l
DescriptionParameter description
OwnershipOwner of parameter
Modifying Schedules
When your schedule needs changes, you can modify it.
To modify a schedule:
1
Change properties.
To deactivate or activate the schedule on the General Properties page toggle Active.
Deleting Schedules
To delete a schedule:
1
Under Job Name, locate the schedule, right-click and select Delete.
Adding Schedules
To add a schedule:
1
Retrieving Jobs
You can retrieve a Production Reporting job and its associated files.
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
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.)
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.
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
Option
Description
MIME Type
Hidden File
Select a time period and enter a number to specify when output is automatically deleted
Deleted job output after a specified time. Enter a number, and select a time element:
l
Minutes
Hours
Days
Weeks
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
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
To access general properties, from Properties, select 3:Interactive Reporting Job Properties
from the left pane.
Table 73
General Properties
Property
Description
Calendar
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
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.
To access Job Defaults, from Properties, select 4. Job Defaults from the left pane.
Table 75
Job Defaults
Default
Description
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 Locale
(Interactive Reporting)
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.
Caution!
Option
Description
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.
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
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.
Table 78
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.
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.
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.
Under Job Parameters next to Define Job Parameters starting with and just to the right of Go, click
Edit.
Select the new owner and click OK. For additional information, see Changing Ownership of Artifacts
on page 76.
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.
jobs.
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.
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.
The connection file and database to which you are connected determine whether you can
process the results to a database table.
Select Action.
Click OK.
Filter Options
Process Options
Action Options for Multiple-Cycle Jobs
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:
To access properties:
1
Properties is displayed.
Option
Description
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
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
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.
per filter.
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)
Modify Filter
Lists OLAP Query Name/Filter On values. Toggles filter list to filters applied for selected OLAP Query section and filter.
Operator
Type
Select By Measure
Top N
Bottom N
Top Sum
Bottom Sum
Top N%
Bottom N%
Select Members
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.
Table 80
Process Options
Option
Description
For storing the job output in the folder containing the job
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
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.)
For creating a table for each job run and appending the date to its name
For deleting the old table and creates a table for each job run (Runs use the same table name.
)
For creating a table on the initial run and adding data to the table
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.)
Option
Description
Section
Filename
Format
Excel (*.xls)
HTML (*.htm)
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
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
Message
Attach File
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.
To import sample1.bqy:
1
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,
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
Adaptive stateView
e. Click Finish.
Permissions is displayed.
Under Add a(n) (blank) Action to this Cycle, select Email Document, and click Go.
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
Click Next.
19 Under Notification, select Display notification in Schedule Module, and click Finish.
The job is now scheduled to run.
10
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
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
Job Properties
Subtopics
l
l
l
l
l
l
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
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.
Required Files
Required-File Addition
Descriptions
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
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
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.
Job Properties
Descriptions
Type
Action
Add Files
Manually
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
File Parameters
Descriptions
Browse
Advanced Options
Description
Compile
Custom SQR.ini
Allows keywords generation during job execution. This is in support of searching for Production Reporting
jobs.
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.
Table 84
Parameter Properties
Parameter Properties
Descriptions
Default method for entering ASK and INPUT parameters . See Dependency Analysis Commands
on page 276(Parameters are listed as you add them.)
Option to enable automatic scenery of the Production Reporting job and the INPUT and ASK
parameters list
Select INPUT or ASKand click GO. See INPUT Parameters on page 281.
Prompt
Display
The display format (Text, SQL Choice, Choice Box) for the parameters (Default is Text.)
Default Value
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.)
ASK Parameters
ASK parameters can be entered as text or as an SQL query.
Table 85
Parameter Properties
Descriptions
Text Entry
Prompt
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.
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.
Table 86
Input Parameter
Properties
Descriptions
Display parameter on
form as:
Text Entry
Prompt
Data Type
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
Validation Type
Validation Mask
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.
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
Action
ReplaceReplace the file with one selected from your local system or the repository
DeleteDelete the file
Descriptions
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.
Output Options
Table 87
Output Options
Output
Options
Descriptions
Output
Options
HTML
Smart View
Adobe Acrobat
PowerPoint
PostScript
HP Printer
Excel
XML
Comma Delimited
Line Printer
Word
Excel
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
Descriptions
Write report output to one HTML file (Not available for a secure Production Reporting job)
Descriptions
Description
Allows users to embed job output contents (HTML only) in personal pages
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
Database password
ASK parameters
Modifes default values for ASK parameters required by the Production Reporting job
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.
Descriptions
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.
Properties of
Required Files
Descriptions
Action
Add Files
Manually
Descriptions
User name
Password
Descriptions
The Output Summary section, from which you can delete output, is available when you modify
properties.
SQR and Generic Job Properties
Descriptions
Output Formats
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.
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.
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
Descriptions
Email Address(es)
Email addresses for sending status reports; separate with semicolons, colons, space characters, commas, or
lines.
Zip Options
Default: HTML
l
HTMLDefault
Comma Delimited
Line Printer
Include Dependent FilesIncludes all email attachment files dependent on this job.
SPF
Smart View
Adobe Acrobat
Postscript
HP Printer
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
Descriptions
Output Directory
Status Report
HTML is automatically generated. These options work only if you select a directory from the list.
Email addresses for sending status reports; separate with semicolons, colons, space characters, commas,
or lines
Note: You can list all output formats using a delimiter (;) in the Other Formats text field for
an output directory.
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 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.
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.
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.
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.)
11
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
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
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
In the browser, navigate to the job, and right-click the job name.
If your form uses additional files, such as GIFs, select Show Required Files.
In the browser, navigate to the desired Production Reporting job, right-click the job name and select
Properties.
Select OK.
In the browser, navigate to the Production Reporting job, right-click the job name and select
Properties.
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.
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>
...
</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()
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.
<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>
Nonrequired Elements
For parameter forms, you can use nonrequired and required elements.
Table 92
Nonrequired Elements
Elements
Function
getEmbedParameterValidationRoutines()
isFormUsesParameterValidationCond()
isParameterValidationCond()
isParameterValidationMaskCond()
resetParameterPickList()
isParameterMultiValuesCond()
see getParameterType()
Elements
Function
getParameterType()
getParameterListPublisherDefaultsFieldName()
Returns the name of the HTML form field used for the Publisher
Defaults parameter list
processParameterPickListLoop()
getPickListParameterValue()
getParameterPickListValueSelected(String
presentationType)
getParameterValidationMask()
getParameterValidationName()
getPublisherDefaultsParameterValue()
isRequiredParameterCond()
getSaveDefaultsCheckboxFieldName()
Returns the name of the HTML form field that represents the
save default box
isShowFormsParameterListCond()
isShowFormsSaveMyDefaultsCond()
isShowParameterListPublisherDefaultsCond()
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
multiple
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()%>
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/>
Glossary
perform on a resource.
accessor Input and output data specifications for data-
mining algorithms.
account blocking The process by which accounts accept input
creates dynamically.
adapter Software that enables a program to integrate with
permission.
adjustment See journal entry.
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
than to Hold.
active-active high availability system A system in which all the
Glossary 307
a partition.
arithmetic data load A data load that performs operations on
members.
application.
Application Migration Utility A command-line utility for
components.
308 Glossary
authentication system.
auto-reversing journal A journal for entering adjustments that
total credits.
bang character (!) A character that terminates a series of
Glossary 309
of member values.
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
outline.
310 Glossary
in Workspace charts.
(.oce)
consolidated file (Parent) A file into which all of the business
file.
content browser A component that eanbles users to browse
website.
Glossary 311
data blocks.
312 Glossary
the organization.
derived text measure In Essbase Studio, a text measure whose
Glossary 313
in a data source.
dynamic report A report containing data that is updated when
consolidated file.
elimination The process of zeroing out (eliminating)
314 Glossary
Glossary 315
year-to-date values.
footer Text or images at the bottom of report pages,
to multiple users.
of historical periods.
holding company An entity that is part of a legal entity group,
316 Glossary
installed.
page.
Hypertext Markup Language (HTML) A programming language
external authentication.
image bookmarks Graphic links to Web pages or repository
items.
IMPACTED status A status that indicates changes in child
administrator.
income account An account storing periodic and year-to-
Glossary 317
be placed.
categories of a dimension.
members.
level 0 member A member that has no children.
liability account An account type that stores "point in time"
in a repository
318 Glossary
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
a user.
Glossary 319
320 Glossary
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
named set In MaxL DML, a set with its logic defined in the
equal to zero.
numeric attribute range A feature used to associate a base
Glossary 321
322 Glossary
its parent.
performance indicator An image file used to represent
planner A user who can input and submit data, use reports
member selections.
perspective A category used to group measures on a
Glossary 323
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.
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
data from the Essbase database when report scripts are run.
324 Glossary
Glossary 325
conditions.
326 Glossary
a SQL query.
SQR Production Reporting A specialized programming
dimension.
standard journal template A journal function used to post
data items.
Structured Query Language A language used to process
models.
Protocol.
text measure In Essbase, a member tagged as Text in the
Finance.
Glossary 327
Title bar A bar that displays the Strategic Finance name, the
of the screen.
token An encrypted identification of one valid user or group
328 Glossary
Glossary 329
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
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
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
E
elements
parameter forms
additional elements, 300
parameter display elements, 299
parameter list elements, 299
required elements, 299
F
familial relationships, 193
favorites
overview, 19
Favorites Menu,commands defined, 23
features
Financial Management, 18
file content windows
Index 333
G
generations and levels, 194
generic report programs, support for exceptions, 293
grand total
in Results section, 152
GREATER OR EQUAL, 149
334 Index
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
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
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
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
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
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