You are on page 1of 310

Hyperion Planning

Release 3.0

Administrator’s Guide

Hyperion Solutions Corporation

D450630000
Copyright 2001-2002 Hyperion Solutions Corporation. All rights reserved.

Hyperion and Essbase are registered trademarks, and the “H” logo and Hyperion Solutions are
trademarks of Hyperion Solutions Corporation.

U.S. Patent Number: 5,359,724

All other brand and product names are trademarks or registered trademarks of their respective
holders.

No portion of this manual may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying, recording, or information storage and
retrieval systems, for any purpose other than the purchaser’s personal use, without the express
written permission of Hyperion Solutions Corporation.

Notice: The information contained in this document is subject to change without


notice. Hyperion Solutions Corporation shall not be liable for errors contained herein or
consequential damages in connection with the furnishing, performance, or use of this material.

Hyperion Solutions Corporation


1344 Crossman Avenue
Sunnyvale, CA 94089

Printed in the U.S.A.


Contents

Preface ......................................................................................................................... xv
Chapter 1: Using Hyperion Planning............................................................ 23
Hyperion Planning ........................................................................................................... 23
Hyperion Planning Web Client ................................................................................ 24
Hyperion Planning Spreadsheet Add-in ................................................................... 24
Components of Hyperion Planning .................................................................................. 25
Hyperion Essbase ............................................................................................................. 25
Hyperion Reports ............................................................................................................. 25
Hyperion Application Link .............................................................................................. 26
Hyperion Business Rules ................................................................................................. 26
Hyperion Analyzer ........................................................................................................... 27
User Licensing for Third-Party Software......................................................................... 27
Hyperion Planning Usage Scenario ................................................................................. 28
Deployment .............................................................................................................. 28
Setting Up the Application ....................................................................................... 29
Creating Metadata ............................................................................................ 30
Setting Up Users and Security ......................................................................... 31
Creating and Refreshing the Application ......................................................... 32
Designing Data Entry Forms............................................................................ 33
Designing Spreadsheets.................................................................................... 34
Populating the Application with Data .............................................................. 35
Creating Business Rules................................................................................... 35
Setting Targets.................................................................................................. 36
Reporting .......................................................................................................... 37
Initializing the Planning Cycle ......................................................................... 38

Hyperion Planning Administrator’s Guide ■ iii


Contents

Building a Plan.......................................................................................................... 38
Launching Business Rules ........................................................................................ 40
Starting the Budget Review Process ......................................................................... 41
Post-Planning Activities............................................................................................ 43

Chapter 2: Getting Started with Hyperion Planning ............................. 45


Starting Hyperion Essbase ................................................................................................ 45
Starting the Relational Database....................................................................................... 45
Optimizing an SQL Relational Database .................................................................. 45
Creating the Properties File....................................................................................... 46
Configuring JDBC Connection Pooling ................................................................... 46
Starting Hyperion Planning on the Desktop ..................................................................... 47
Using the Toolbar, Status Bar, and Navigation Frame ............................................. 47
Starting Hyperion Planning on the Web ........................................................................... 49
Using Application Servers ................................................................................................ 49
Registering a Server .................................................................................................. 50
Unregistering a Server .............................................................................................. 50
Closing Hyperion Planning and Hyperion Essbase .......................................................... 51

Chapter 3: Creating an Application ............................................................... 53


Prerequisites...................................................................................................................... 53
Overview........................................................................................................................... 53
Creating Applications with the Setup Assistant ............................................................... 54
Using the Select Workspace Frame .......................................................................... 55
Creating the Calendar................................................................................................ 56
Defining the Base Time Period and Monthly Distribution Spread .................. 56
Defining the Calendar Range............................................................................ 57
Setting Up Currencies ............................................................................................... 58
Setting Up Plan Types............................................................................................... 59
Saving the Application .............................................................................................. 59
Creating Additional Applications ..................................................................................... 60
Using Applications ........................................................................................................... 60
Opening Applications ............................................................................................... 60
Deleting Applications ............................................................................................... 61
Closing Applications................................................................................................. 63
Unlocking Applications ............................................................................................ 63

iv ■ Hyperion Planning Administrator’s Guide


Contents

Using Broadcast Messaging ............................................................................................. 64


Viewing Usage Statistics.................................................................................................. 66
Creating Application Databases ...................................................................................... 67
Optimizing the Performance of Currency Conversion Calc Scripts......................... 69
Refreshing Application Databases............................................................................ 70
Scheduling Application Databases to be Refreshed ................................................. 72
Optimizing Application Performance............................................................................... 76
Dense and Sparse Dimensions.................................................................................. 76
Allocating Memory for Supporting Detail Cache..................................................... 78
Backing Up Applications and Application Databases...................................................... 78
Backing Up the Application in Hyperion Essbase.................................................... 79
Backing Up the Application ............................................................................. 79
Backing up the Security File ............................................................................ 79
Backing up Configuration Settings .................................................................. 80
Backing Up the Relational Database for Hyperion Planning and Hyperion Reports 80
Backing Up the Microsoft SQL Server Repository.......................................... 80
Backing up IBM DB2 Repository .................................................................... 81
Backing Up an Oracle Repository .................................................................... 81
Backing Up the Required Components of Hyperion Planning................................. 82
Backing Up Hyperion Application Link................................................................... 83
Backing Up Hyperion Business Rules...................................................................... 83

Chapter 4: Moving and Copying Applications......................................... 85


Migrating an Application ................................................................................................. 85
Migrating a Hyperion Planning Application ............................................................ 85
Migrating Hyperion Business Rules Data ................................................................ 87
Migrating Hyperion Reports..................................................................................... 87
Copying a Hyperion Planning Application ...................................................................... 89

Chapter 5: Setting Up Security ........................................................................ 93


About Access Rights and Security ................................................................................... 93
About External Authentication Providers ........................................................................ 93
About Windows NT LAN Manager (NTLM) .......................................................... 94
About LDAP Authentication .................................................................................... 95
Configuring for External Authentication.......................................................................... 95
Editing the Application Properties............................................................................ 96

Hyperion Planning Administrator’s Guide ■ v


Contents

When the Web Application Server is Installed on a UNIX System ......................... 98


Configuring NTLM Authentication.................................................................. 99
Configuring the Properties File....................................................................... 100
Configuring the NTLM Authentication Server .............................................. 101
Modifying Properties for LDAP or MSAD ............................................................ 102
Configuring the Authentication Provider ....................................................... 102
Configuring the User Provider........................................................................ 104
Enabling LDAP Authentication...................................................................... 105
Configuring DCOM........................................................................................................ 105
About Hyperion Planning Security................................................................................. 106
User Types ...................................................................................................................... 107
Administrator .......................................................................................................... 107
Setting Up Multiple Administrators for an Application with One Owner ..... 108
Interactive User ....................................................................................................... 108
Planner .................................................................................................................... 109
View Users...................................................................................................... 109
User Types and Tasks ............................................................................................. 110
Setting Up Users ............................................................................................................ 111
Search Order for Users............................................................................................ 111
Adding Users From the Web .................................................................................. 112
Importing Users With a Utility ............................................................................... 113
Creating the Text File ..................................................................................... 113
Importing Users .............................................................................................. 114
Modifying Users ..................................................................................................... 115
Deleting Users......................................................................................................... 116
Implementing User Security ................................................................................... 116
Importing Access Rights................................................................................................. 117
Setting Up Groups .......................................................................................................... 119
Adding Groups........................................................................................................ 119
Modifying Groups................................................................................................... 120
Managing Groups.................................................................................................... 121
Deleting Groups ...................................................................................................... 121
Modifying Passwords ..................................................................................................... 122

vi ■ Hyperion Planning Administrator’s Guide


Contents

Assigning Access Rights ................................................................................................ 123


Setting Up Hyperion Essbase Security as Defined by Hyperion Planning............. 124
Setting Up Security for Business Rules.................................................................. 126
Setting Security on Business Rules in Hyperion Essbase .............................. 126
Setting Security on Business Rules in the HBR Repository .......................... 126
Setting Up Security in Hyperion Reports ............................................................... 127

Chapter 6: Setting Up Multiple Alias Tables ........................................... 129


About Alias Tables ......................................................................................................... 129
Adding Alias Tables ....................................................................................................... 130
Copying Alias Tables ..................................................................................................... 130
Clearing Alias Tables ..................................................................................................... 131
Renaming Alias Tables................................................................................................... 131
Deleting Alias Tables ..................................................................................................... 132
Selecting an Alias Table ................................................................................................. 132

Chapter 7: Setting Up the Calendar and Currencies .......................... 135


Customizing the Calendar .............................................................................................. 135
Defining How Calendars Roll Up........................................................................... 135
Creating Summary Time Periods............................................................................ 136
Modifying Summary Time Periods ........................................................................ 137
Deleting Summary Time Periods............................................................................ 138
Expanding and Collapsing the Hierarchy ............................................................... 139
Adding Years to the Calendar................................................................................. 139
Changing the Current Year or Period ..................................................................... 140
Converting Currency Values .......................................................................................... 140
Enabling Multiple Currencies......................................................................... 140
Working with Multiple Currencies................................................................. 141
About the Calculate Currencies Calc Script ................................................... 142
Exchange Rate Types ..................................................................................... 142
Triangulation .................................................................................................. 143
Scaling ............................................................................................................ 143
Number Formatting ........................................................................................ 143
Reporting Currencies...................................................................................... 144
Seeing How a Currency is Used ..................................................................... 145
Adding Currencies.......................................................................................... 145

Hyperion Planning Administrator’s Guide ■ vii


Contents

Modifying Currencies ..................................................................................... 147


Deleting Currencies ........................................................................................ 148
Setting Up Exchange Rates..................................................................................... 149
About Exchange Rate Tables.......................................................................... 149
Hsp_Rates Dimension..................................................................................... 150
Triangulation................................................................................................... 150
Calculation Method......................................................................................... 150
Setting Up Exchange Rate Tables .................................................................. 151
Modifying Exchange Rate Tables................................................................... 154
Deleting Exchange Rate Tables ...................................................................... 154

Chapter 8: Setting Up Custom Dimensions ............................................ 157


Working with Dimensions .............................................................................................. 157
About Dimensions and Members............................................................................ 157
About Sparse and Dense Dimensions ..................................................................... 157
About Dimension Hierarchies................................................................................. 158
Working with Custom Dimensions ................................................................................ 160
Aggregation Options ............................................................................................... 160
Storage Options....................................................................................................... 161
Expanding Dimensions and Members .................................................................... 162
Collapsing Dimensions and Members .................................................................... 162
Finding Dimensions or Members............................................................................ 163
Saving Changes to Dimensions and Members........................................................ 164
Restoring Dimension and Member Properties ........................................................ 164
Concurrent Usage.................................................................................................... 165
Working with the Entity Dimension ............................................................................... 165
Working with Shared Members .............................................................................. 165
Assigning Access Rights to Shared Members ................................................ 166
Entity Members and Plan Types ............................................................................. 167
Base Currency ......................................................................................................... 168
Adding Entity Members.......................................................................................... 168
Defining Advanced Properties for Entity Members ............................................... 170
Modifying Entity Members..................................................................................... 171
Deleting Entity Members ........................................................................................ 173

viii ■ Hyperion Planning Administrator’s Guide


Contents

Working with the Account Dimension........................................................................... 174


Account Members and Plan Types ......................................................................... 174
Account Types ........................................................................................................ 174
Saved Assumptions................................................................................................. 176
Data Type and Exchange Rate Type....................................................................... 177
Adding Account Members...................................................................................... 177
Defining Advanced Properties for Account Members ........................................... 180
Modifying Account Members................................................................................. 181
Deleting Account Members .................................................................................... 183
Working with User-Defined Custom Dimensions ......................................................... 184
Adding User-Defined Custom Dimensions ............................................................ 185
Modifying User-Defined Custom Dimensions ....................................................... 186
Adding User-Defined Custom Dimension Members ..................................... 187
Modifying User-Defined Custom Dimension Members ................................ 189
Deleting User-Defined Custom Dimension Members ................................... 190
Defining Advanced Properties for User-Defined Dimensions and Members ........ 191
Working with Members.................................................................................................. 191
Assigning Access Rights to Members .................................................................... 192
Modifying Access Rights ....................................................................................... 193
Deleting Access Rights........................................................................................... 194
Moving Members within the Dimension Hierarchy ............................................... 194
Working with Attributes................................................................................................. 195
Defining Attributes ................................................................................................. 196
Modifying Attributes .............................................................................................. 197
Deleting Attributes.................................................................................................. 197
Working with Attribute Values ...................................................................................... 198
Defining Attribute Values....................................................................................... 198
Assigning Attribute Values to Members ................................................................ 199
Modifying Attribute Values.................................................................................... 200
Deleting Attribute Values ....................................................................................... 201
Using Attributes and Attribute Values ........................................................................... 202
Using Attributes and Attribute Values in Hyperion Planning Data Entry Forms .. 202
Using Attributes and Attribute Values in Hyperion Application Link ................... 203

Hyperion Planning Administrator’s Guide ■ ix


Contents

Chapter 9: Setting Up Scenarios and Versions..................................... 205


About Scenarios and Versions........................................................................................ 205
Setting Up Scenarios....................................................................................................... 205
Creating Scenarios .................................................................................................. 206
Time Periods ................................................................................................... 206
Exchange Rate Table ...................................................................................... 206
Access Rights.................................................................................................. 207
Adding a Scenario........................................................................................... 207
Modifying a Scenario...................................................................................... 208
Deleting a Scenario ......................................................................................... 209
Copying a Scenario ......................................................................................... 209
Setting Up Versions........................................................................................................ 210
Target and Bottom Up Versions ..................................................................... 211
Adding a Version ............................................................................................ 211
Modifying a Version ....................................................................................... 212
Deleting a Version .......................................................................................... 213
Viewing Versions ........................................................................................... 214
Copying Versions ........................................................................................... 214
Setting Access Rights for Scenarios and Versions ......................................................... 215
Assigning Access Rights to Members ............................................................ 216
Modifying Access Rights for Members.......................................................... 216
Deleting Access Rights for a Member ............................................................ 217

Chapter 10: Loading Members and Data .................................................. 219


Importing Custom Dimension Members ........................................................................ 219
Quick Steps for Importing Custom Dimension Members ...................................... 220
Using Hyperion Application Link .................................................................................. 220
Using Flow Diagrams ............................................................................................. 221
Flow Diagram Workspace .............................................................................. 221
Creating an Adapter Process........................................................................... 222
Using the Hyperion Planning Adapter .................................................................... 222
Loading and Updating Shared Members ........................................................ 222
Loading Attribute Values................................................................................ 222
Adding a Hyperion Planning Adapter ............................................................ 223

x ■ Hyperion Planning Administrator’s Guide


Contents

Using the Hyperion Essbase Adapter ..................................................................... 224


Adding a Hyperion Essbase Adapter.............................................................. 224
Importing Multiple Currency Application Data ............................................. 225
Using the Flat File Adapter..................................................................................... 225
Flat File Load File .......................................................................................... 226
Adding a Flat File Adapter ............................................................................. 226
Connecting Ports..................................................................................................... 227
Running an Adapter Process................................................................................... 228
Importing Data................................................................................................................ 228
Loading Data Files.................................................................................................. 229
Data Load File Example ......................................................................................... 230

Chapter 11: Using Data Entry Forms.......................................................... 231


About Data Entry Forms ................................................................................................ 231
Forms and Plan Types ............................................................................................ 231
Forms and Access Rights........................................................................................ 232
Forms and Currencies ............................................................................................. 232
Designing a Form for Multiple Currencies............................................................. 233
Forms and Versions ................................................................................................ 233
Forms and Attributes .............................................................................................. 233
Forms and Shared Members ................................................................................... 233
Understanding the Composition of a Form .................................................................... 234
Point of View .......................................................................................................... 234
Page Axis ................................................................................................................ 234
Rows and Columns ................................................................................................. 234
Managing Forms and Folders......................................................................................... 234
Creating Form Folders ............................................................................................ 235
Moving Form Folders ............................................................................................. 236
Deleting Form Folders ............................................................................................ 236
Creating Forms ............................................................................................................... 237
Setting Form Properties .......................................................................................... 237
Setting the Row and Column Layout...................................................................... 238
Adding Column Definitions ................................................................................... 240
Adding Row Definitions......................................................................................... 240
Changing Column Definitions ................................................................................ 241

Hyperion Planning Administrator’s Guide ■ xi


Contents

Changing Row Definitions...................................................................................... 241


Selecting Members.................................................................................................. 241
Selecting Attribute Values as Members.................................................................. 244
Creating Asymmetric Rows and Columns.............................................................. 244
Defining the Page and POV .................................................................................... 245
Setting a Form’s Display Options........................................................................... 246
Adding Fonts................................................................................................... 249
Using Business Rules ..................................................................................................... 250
Selecting Business Rules ........................................................................................ 250
Setting Properties of Business Rules ...................................................................... 251
Using Run-Time Prompts ....................................................................................... 252
Enabling Run-Time Prompts .......................................................................... 253
Previewing a Form.......................................................................................................... 253
Assigning Access to a Form ........................................................................................... 253
Assigning Access to a Form.................................................................................... 254
Changing Access to a Form .................................................................................... 254
Modifying Forms ............................................................................................................ 255
Moving Forms ................................................................................................................ 256
Deleting Forms ............................................................................................................... 257

Chapter 12: Managing the Budgeting Process...................................... 259


About the Budgeting Process.......................................................................................... 259
Planning Units......................................................................................................... 259
Starting the Review Process.................................................................................... 262
Entity Hierarchy...................................................................................................... 262
Enabling E-mail Notification .................................................................................. 263

Chapter 13: Customizing Hyperion Planning Web Client ................ 265


Customizing the Hyperion Planning Web Home Page................................................... 265
Customizing Cascading Style Sheets.............................................................................. 266
Customizing Text............................................................................................................ 267
Customizing Text in Non-Latin Languages.................................................... 268
Restricted Characters .............................................................................................. 270
Customizing Hyperion Planning When Using WebLogic and UNIX .................... 270
Customizing Hyperion Planning When Using Apache Tomcat ............................. 270
Customizing Colors and Images ..................................................................................... 271

xii ■ Hyperion Planning Administrator’s Guide


Contents

Customizing the Colors, States, and Actions for Process Status.................................... 272
Customizing the Colors .......................................................................................... 273
Customizing the States ........................................................................................... 273
Customizing the Actions......................................................................................... 275

Chapter 14: Troubleshooting .......................................................................... 277


Currency Conversion Calc Script Failed ........................................................................ 277
500 Error Message.......................................................................................................... 277
JRun Server Connection Refused ................................................................................... 279
Manage Database Errors................................................................................................. 280
File Naming Convention ................................................................................ 281
Setting Environment Variables....................................................................... 282
Restore Navigation Icons in Hyperion Planning 2.0 ...................................................... 282
java/rmi/Naming Error ................................................................................................... 283
Missing Hyperion Planning Adapter.............................................................................. 284
Slow Performance When Opening Large Forms............................................................ 284
Unable to Create Application Error................................................................................ 285
Unsuccessful Login ........................................................................................................ 286
JRun Evaluation Period Expired, Outdated, or Missing................................. 286
Incorrect JDBC Driver (SQL) ........................................................................ 286
Incorrect JDBC Driver (Oracle) ..................................................................... 287
Classes Zip Files Missing (Oracle)................................................................. 287
Restore or Move an Application..................................................................................... 288
Unable to Find Properties File........................................................................................ 289
Error: "database locked by another administrator" ........................................................ 290

Glossary..................................................................................................................... 291
Index ............................................................................................................................ 301

Hyperion Planning Administrator’s Guide ■ xiii


Contents

xiv ■ Hyperion Planning Administrator’s Guide


Preface

Welcome to the Hyperion Planning Administrator’s Guide. This preface discusses


the following topics.
● “Purpose” on page xv
● “Audience” on page xvi
● “Document Structure” on page xvi
● “Related Documentation” on page xvii
● “Online Help” on page xviii
● “Online Guides” on page xviii
● “Conventions” on page xviii
● “Additional Support” on page xix

Purpose
This guide shows you how to create and maintain planning applications in
Hyperion Planning, as well as set up dimensions, scenarios, versions, the calendar,
currencies, exchange rates, alias tables, data entry forms, reports, budgeting
assumptions, users, groups, and security rights. The Hyperion Planning
Administrator’s Guide also steps you through uploading data from and
downloading data to Hyperion Planning. It explains the Hyperion Planning
concepts and procedures that you need to use the software.
Performance optimization information, troubleshooting information, and details
on how Hyperion Planning interacts with and is enhanced by other Hyperion
products is also included.

Hyperion Planning Administrator’s Guide ■ xv


Preface

Audience
This guidehelp system is for planning administrators who are responsible for the
following tasks:
● Creating and maintaining planning applications
● Setting up dimensions, scenarios, versions, currencies, exchange rates, alias
tables, the calendar, users, groups, and their security rights
● Initiating and managing the budget process
● Creating data entry forms, Spreadsheet Add-in worksheets, and reports
● Uploading data to and downloading data from Hyperion Planning
● Customizing the Web interface
Please note that at this time, customers in North America have access to the
Hyperion Download Center. Any references in the documentation to the Hyperion
Download Center apply only if you have access.

Document Structure
This document contains the following information:
Chapter 1, “Using Hyperion Planning,” introduces Hyperion Planning and other
Hyperion products that are used to enhance and extend Hyperion Planning’s
functionality and performance.
Chapter 2, “Getting Started with Hyperion Planning,” describes how to start
Hyperion Essbase server, start and navigate Hyperion Planning, and register
application servers for use with Hyperion Planning.
Chapter 3, “Creating an Application,” describes how to create an application in
Hyperion Planning using the Setup Assistant and how to schedule a refresh of
existing applications.
Chapter 4, “Moving and Copying Applications,” describes how to migrate an
existing Hyperion Planning application from one server to another and to copy and
rename an application on the same server.
Chapter 5, “Setting Up Security,” describes how to set up and enable the
authentication providers that Hyperion Planning supports, how to add users and
groups to an application, and how to assign access rights to those users and groups.

xvi ■ Hyperion Planning Administrator’s Guide


Preface

Chapter 7, “Setting Up the Calendar and Currencies,” describes how the calendar
rolls up, which currencies are used in an application, and how currencies are
converted.
Chapter 6, “Setting Up Multiple Alias Tables,” describes how to set up and
maintain multiple alias tables within a Hyperion Planning application.
Chapter 8, “Setting Up Custom Dimensions,” describes how to work with
user-defined custom dimensions, the Entity dimension, the Account dimension,
and the members, attributes, and attribute values within each of the dimensions.
Chapter 9, “Setting Up Scenarios and Versions,” describes how to create scenarios
to group the application into separate plans with their own review cycles. This
chapter also describes how to create versions, which allow for many iterations of
a plan.
Chapter 10, “Loading Members and Data,” describes how to populate Hyperion
Planning applications with members and data from external systems.
Chapter 11, “Using Data Entry Forms,” describes how to create, modify, and
manage data entry forms and the folders in which they are stored.
Chapter 12, “Managing the Budgeting Process,” describes the concept of a
planning unit and its life cycle through the review process.
Chapter 13, “Customizing Hyperion Planning Web Client,” describes how to
customize different aspects of the Hyperion Planning Web interface.
Chapter 14, “Troubleshooting,” describes common errors when using Hyperion
Planning and potential resolutions for those errors.
The Glossary defines terms related to Hyperion Planning.
The Index contains a list of Hyperion Planning terms with page references.

Related Documentation
The following documentation is available for Hyperion Planning:
● Hyperion Planning Installation Guide, which describes installing, upgrading,
and configuring Hyperion Planning.
● Hyperion Planning Installation Checklist, which provides a quick reference of
the installation process.
● Hyperion Planning Readme, which describes late-breaking product
information.

Hyperion Planning Administrator’s Guide ■ xvii


Preface

● Hyperion Planning New Features, which describes new features in this


release of the product.
● Hyperion Business Rules Administrator’s Guide, which describes creating and
launching business rules and integrations.

Online Help
To access online help from the Hyperion Planning Desktop, select Help >
Contents. To access online help from Hyperion Planning on the Web, click the
Help link. To print an online Help topic, display the topic and select File > Print
Topic.

Online Guides
The online guides are electronic versions of the printed documentation.

➤ To display an online guide, do one of the following:


● From the Hyperion Planning Desktop, select Help > Online Guide.
● Navigate to the directory where Hyperion Planning is installed. Select
Hyperion Planning\Documentation and double-click the .PDF file that you
want to display.
● From the Hyperion Planning Desktop, select Help > Contents. From the
online help table of contents, select Online Guide.

Conventions
The following table shows the conventions used in this document:

Table i: Conventions Used in This Document

Item Meaning

Arrows indicate the beginning of a procedure consisting


of sequential steps.
Brackets [ ] In examples, brackets indicate that the enclosed
elements are optional.

xviii ■ Hyperion Planning Administrator’s Guide


Preface

Table i: Conventions Used in This Document (Continued)

Item Meaning

Bold Bold text indicates words or characters that you type


exactly as they appear on the page. Bold in procedural
steps highlights major interface elements.
CAPITAL LETTERS Capital letters denote commands and various IDs.
(Example: CLEARBLOCK command)
Example text Courier font indicates that the material shown is a code
or syntax example.
Ctrl + 0 Keystroke combinations shown with the plus symbol
(+) indicate that you should press the first key and
hold it while you press the next key. Do not type
the + symbol.
Courier italics Courier italic text indicates a variable field in command
syntax. Substitute a value in place of the variable shown
in Courier italics.
Italics Italics in a product-related term in the body of a book
indicates that the term is also included in the glossary of
the book.
Ellipses (...) Ellipsis points indicate that text has been omitted from
an example.
Mouse orientation This document provides examples and procedures using
a right-handed mouse. If you use a left-handed mouse,
adjust the procedures accordingly.
Menu options Options in menus are shown in the following format:
Menu name > Menu command > Extended menu
command
For example: File > Desktop > Accounts
n, x The variable n indicates that you must supply a generic
number; the variable x indicates that you must supply a
generic letter.

Hyperion Planning Administrator’s Guide ■ xix


Preface

Additional Support
In addition to providing documentation and online help, Hyperion offers the
following support for product information.

How to Order Printed Documentation


To order printed documentation:
● Visit the Hyperion Solutions Web site at http://www.hyperion.com.
● In the United States, call Hyperion Solutions Customer Support at
877-901-4975.
● From outside the United States, including Canada, call Hyperion Solutions
Customer Support at 203-703-3600. Clients who are not serviced by support
from North America should call their local support centers.

Education Services
Hyperion offers a variety of training options, including instructor-led training,
custom training, and eTraining. This education covers all Hyperion applications
and technologies and is geared to administrators, end users, and information
systems (IS) professionals.
Instructor-led training is delivered in formats and in locations suited to Hyperion’s
diverse, global customers. Hyperion Authorized Training Centers are certified to
deliver courses developed by Hyperion. Custom Education Services—training on
the configured and tailored applications that employees use on the job—is another
option to enhance user productivity and to ensure smooth day-to-day operations.
A service called eTraining—including computer-based training, Web-based
training, and interactive Virtual Classroom training—provides a cost-effective
means of giving users a hands-on introduction to product features and functions.
Computer-based training (CBT) and Web-based training (WBT) provide
high-quality, self-paced training at the user’s convenience, regardless of location.
For more information about training, contact your Regional Education Manager
or visit the Hyperion Solutions Web site at http://www.hyperion.com to see
a list of all training classes.

xx ■ Hyperion Planning Administrator’s Guide


Preface

Consulting Services
Hyperion Consulting Services assists customers in maximizing the use of, and the
return on investment in, Hyperion products. Experienced Hyperion consultants
and Hyperion Alliance Partners assist organizations in tailoring solutions to their
particular requirements, such as reporting, analysis, modeling, and planning.
Specific services include implementation consulting, custom business solutions,
data integration, and technical consulting. Additionally, Hyperion offers a variety
of Services Packages and Reviews.
For more information about Consulting Services, Services Packages and Reviews,
as well as the services offered by Alliance Partners, contact your local consulting
services representative, or visit the Hyperion Solutions Web site at
http://www.hyperion.com to see a list of all Hyperion Alliance Partners.

Technical Support
Hyperion provides Web-based and telephone support to ensure that clients resolve
product issues quickly and accurately, This support is available for all Hyperion
products at no additional cost to clients with a current maintenance agreement.
● For Web-based support, or to see complete information on available support
options, visit the Hyperion Solutions Web site at http://www.hyperion.com.
● In the United States, call 877-901-4975 for Hyperion Solutions Customer
Support.
● From outside the United States, including Canada, call Hyperion Solutions
Customer Support at 203-703-3600. Clients who are not serviced by support
from North America should call their local support centers.

Hyperion Planning Administrator’s Guide ■ xxi


Preface

xxii ■ Hyperion Planning Administrator’s Guide


1
Chapter Using Hyperion Planning

1
This section introduces Hyperion Planning and other Hyperion products that are
used to enhance and extend Hyperion Planning’s functionality and performance.

Hyperion Planning
Hyperion Planning is a Web-based budgeting and planning solution that drives
collaborative, event-based operational planning processes throughout the
organization for a wide range of financial and operational needs. Hyperion
Planning is a comprehensive approach for the complete and closed-loop planning
process that drives continuous business improvement. With Hyperion Planning, all
decision makers and front-line managers can communicate which course of action
to take and get budget holders to collaborate so that the planning process is
optimized and efficient. When a material event occurs that causes a change in
direction, planners have the flexibility to adapt rapidly, ensuring that plans are
relevant and useful.
More specifically, Hyperion Planning:
● Facilitates collaboration, communication, and control across multi-divisional
global enterprises
● Provides a framework for perpetual planning, with attention to managing
volatility and frequent planning cycles
● Provides ease of use and deployment through the Web or the Hyperion
Planning Spreadsheet Add-in
● Lowers the total cost of ownership through a shorter roll out and
implementation phase, and easier maintenance for existing applications
● Enhances decision-making with reporting, analysis, and planning
● Promotes modeling by including complex business rules and allocations

Hyperion Planning Administrator’s Guide ■ 23


Using Hyperion Planning

● Integrates with other systems to load data (through Hyperion Application


Link)

Hyperion Planning Web Client


Hyperion Planning provides complete functionality for the Web user, including
reporting and analysis, process management, form design, and user and group
management. Hyperion Planning offers a Web interface so companies can easily
roll out the application to large, distributed planning organizations without having
to install software on client computers. For the Web interface users, all software
resides on the server. Built using a high-performance, scalable architecture,
Hyperion Planning lowers the total cost of ownership and simplifies deployment
to many users who have access to the application anytime, anywhere.

Hyperion Planning Spreadsheet Add-in


The Hyperion Planning Spreadsheet Add-in lets you design worksheets in
Microsoft Excel that you can use for entering, formatting, analyzing, and reporting
on data in a Hyperion Planning application.
The Hyperion Planning Spreadsheet Add-in:
● Lets you work with Hyperion Planning applications using a familiar
worksheet interface
● Provides user security, so you can see and change only data to which you have
access rights
● The Hyperion Planning Spreadsheet Add-in enforces the data security
overrides associated with the current owner of a planning unit, ensuring
controlled budget reviews and revisions
● Lets you work with data while offline (that is, while you are not logged on to
a Hyperion Planning application). For example, you can manipulate and
analyze data based on various scenarios until you commit the data to the
Hyperion Planning application by logging on to it and saving and calculating
the values

Note: Hyperion Planning Spreadsheet Add-in is not recommended for deployment and
connectivity on a wide area network (WAN).

24 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
Components of Hyperion Planning
To extend the power and flexibility of Hyperion Planning, you can use it with the
following Hyperion products, which are included with Hyperion Planning:
● Hyperion Essbase
● Hyperion Reports
● Hyperion Application Link
● Hyperion Business Rules
You can also use Hyperion Planning with Hyperion Analyzer, which you can
purchase separately.

Hyperion Essbase
Hyperion Planning runs on top of Hyperion Essbase and leverages Hyperion
Essbase’s robust analytic and calculation capabilities, security filters, APIs,
pre-built financial intelligence, calculation functions and multi-cube application
support. Hyperion Planning capitalizes on OLAP and data warehouse technologies
by embedding powerful analysis, enhanced scalability, and data management
functionality into a purpose-built planning application. Hyperion Planning stores
the application definition in a relational database and then uses this information to
create the necessary Hyperion Essbase databases and security privileges for your
application.

Hyperion Reports
Hyperion Reports is a management reporting solution for analysis applications
that transforms data into meaningful business information by delivering highly
formatted reports to the organization. Users can build their own reports without IT
assistance and deliver them through a variety of channels, including the Internet.
Hyperion Reports meets a wide range of reporting needs on multidimensional
data, including profit-and-loss statements, balance sheets and statutory reporting.
Hyperion Reports integrates with and extends the capabilities of Hyperion
Planning.
Hyperion Planning users can use Hyperion Reports to manage reporting tasks and
carry out all aspects of plan review and analysis. Users can easily create reports
featuring text, grids of data, charts, graphs, and images. Hyperion Reports makes

Hyperion Planning Administrator’s Guide ■ 25


Using Hyperion Planning

it easy to carry out real-time, ad hoc variance reporting and quickly produce a
variety of sophisticated financial reports, which can be viewed online or printed
with production-quality formatting.

Hyperion Application Link


Hyperion Application Link is a suite of application integration services that
dramatically reduces the time and expense of integrating external source data with
Hyperion’s business analysis software. Using Hyperion Application Link,
organizations can quickly deploy flexible, adaptable, and reusable integration
solutions that seamlessly and transparently connect Hyperion’s business analysis
software with various data sources.
You can use Hyperion Application Link to load data values, accounts, entities, and
custom dimensions from any flat file or ODBC-compliant database into Hyperion
Planning. You can also use Hyperion Application Link to load the same data into
Hyperion Planning directly from an Enterprise Resource Planning (ERP) system
such as SAP, J.D. Edwards World, or J.D. Edwards OneWorld.
Hyperion Application Link provides you with a graphical user interface that makes
it easy to seamlessly integrate data from your source system into Hyperion
Planning. It includes a wizard, called Hyperion Translation Manager, that helps
you map your source data into Hyperion Planning equivalents.

Hyperion Business Rules


Hyperion Business Rules is an underlying component of Hyperion Planning,
which provides comprehensive support for planning needs of global finance
organizations. Hyperion Business Rules is a graphical tool that guides users
through the creation, maintenance, customization, documentation, and execution
of sophisticated calculations and business models in a variety of analytic
applications, such as product and customer profitability, budgeting and planning,
financial management, and customer relationship management.
Hyperion Planning users can use Hyperion Business Rules to create, launch, edit,
and organize allocation processes and business rules. Business users select and
initiate allocations, create new data, and analyze results. Hyperion Business Rules
offers the following benefits:
● Ease of use - the clear and intuitive graphical interface simplifies the creation
of complex business rules

26 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
● Enhanced calculation scripts - run-time prompts that include valid inputs and
guidelines for budget preparers
● Documentation - automatic creation of printable documentation of business
rules and calculations
● Time-saving methods - pre-defined and re-usable formulas to define unique
cost and revenue business rules
● Low maintenance - logical organization and naming of business rules into sets

Hyperion Analyzer
Hyperion Analyzer is an online analytical processing (OLAP) analysis,
presentation, and reporting solution for the enterprise. Using Hyperion Analyzer
with Hyperion Planning enables organizations to quickly deploy a wealth of highly
graphical, interactive analysis applications for sales analysis, key performance
measurement, product profitability analysis, forecasting, and promotional
effectiveness across multiple operations.
Hyperion Analyzer provides the ease of use, analytical power, and deployability
that is required to globally implement analysis applications. By leveraging the
performance, scalability, and power of Hyperion Planning and Hyperion Essbase,
Hyperion Analyzer allows organizations to deliver information to large user
communities at a low cost.

User Licensing for Third-Party Software


To use Hyperion Planning, you are required to purchase licenses from the
appropriate third-party vendors. Examples of necessary third-party software
include:
● Relational database such as Oracle, IBM DB2, or Microsoft SQL Server
● Web application servers (such as JRun, WebLogic, WebSphere, and Tomcat)
● JDBC drivers
● Adobe Acrobat Writer

Hyperion Planning Administrator’s Guide ■ 27


Using Hyperion Planning

Hyperion Planning Usage Scenario


The following section outlines the ways in which Hyperion Planning may be used,
and the type of users that perform the various tasks.

Deployment
The IT professional at the customer site is responsible for the installation and
configuration of Hyperion Planning on both the server computers and the client
workstations. The IT professional should have experience administering relational
databases, installing client/server and Web server software, and configuring
authentication security.
The following table lists the installation and configuration tasks that need to be
performed on the server computers.
Table 1: Server Installation Users and Tasks

User Type Task

IT professional Installs all Hyperion Planning system requirements,


including operating systems, relational database, Web
server, application server, and browser
IT professional Installs Hyperion Essbase
IT professional Sets up the data source name (DSN) for the OLAP and
relational databases
IT professional Installs Hyperion Planning, as well as Hyperion Reports,
Hyperion Application Link, and Hyperion Business Rules
IT professional Creates necessary relational databases and connections
IT professional Configures the Web server
IT professional Sets up users in an external authentication provider
IT professional Optional: Creates a test application and adds users
IT professional Tests the installation and configuration

28 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
The following table lists the installation and configuration tasks that need to be
performed on the client computers.
Table 2: Client Installation Users and Tasks

User Type Task

IT professional Installs the Hyperion Planning remote Windows client, as


well as the Hyperion Essbase run-time client, the
Hyperion Planning Spreadsheet Add-in, Microsoft Excel
2000, Hyperion Business Rules, Hyperion Reports, and
Hyperion Application Link
IT professional Installs a Web browser
IT professional Tests the connection from both the Web and the network

Setting Up the Application


Setting up the application consists of the following activities:
● Creating metadata
● Setting up users and security
● Generating the database
● Designing data entry forms
● Designing spreadsheets (optional)
● Populating the application with data
● Creating business rules
● Setting the planning targets
● Reporting on the data
● Starting the planning cycle
The following sections provide more detail on each aspect of setting up the
application.

Hyperion Planning Administrator’s Guide ■ 29


Using Hyperion Planning

Creating Metadata
Hyperion consulting partners and the Hyperion Planning administrator work
together to design an application. Once a design is agreed upon, an application
framework is created using the Setup Application task on the Hyperion Planning
Desktop. The person who creates the application is by default the application
owner. There is only one application owner per application. However, the owner
may grant ownership to another administrator. The application framework
includes:
● Application name
● Number of plan types and the names of the plan types
● Calendar structure
● Whether or not the application is a multi-currency application
● Default currency
After the application framework is created, dimensions and members are added to
the application and assigned to the appropriate plan type. There are up to eight
required dimensions in an application:
● Currency (for multi-currency applications)
● HSP_RATES (for multi-currency applications)
● Accounts
● Entities
● Scenarios
● Versions
● Time Periods
● Years
Some examples of additional custom dimensions include Products, Customers,
Employees, Sales Channels, and Projects.
Dimensions can be added manually through the tasks in Hyperion Planning
Desktop. However, the metadata typically exists in another external system, such
as a general ledger, and can be transformed and uploaded into Hyperion Planning
using Hyperion Application Link and the Hyperion Planning Adapter.

30 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
The administrator is involved in creating the metadata for Hyperion Planning
applications.
Table 3: Creating Metadata - Users and Tasks

User Type Task

Administrator Designs and creates an application in Hyperion Planning


Administrator Defines metadata (currencies, scenarios, versions,
calendar)
Administrator Enters exchange rates
Administrator Defines attribute dimensions and members
Administrator Loads custom dimensions using Hyperion Application
Link

Setting Up Users and Security


An IT professional must set up users in and configure an external authentication
provider before you add or import users in a Hyperion Planning application. For
information, see “About External Authentication Providers” on page 93.
When accessing a Hyperion Planning application through Hyperion Business
Rules or the Hyperion Planning Spreadsheet Add-in, the user is authenticated
against Microsoft Windows NTLM. In these instances, there is the option to use
the Windows password. Using Windows authentication also makes it easier to
maintain user IDs and passwords. Typically, the IT professional is responsible for
setting up and maintaining Windows security.
When you add users, there is an option to share the Windows password with
Hyperion Planning and Hyperion Essbase. After individual users have been added
to an application, user groups are usually set up within the application. Individual
users are then assigned to various groups, based on their data access requirements.
You assign individual users or groups to secured objects. Secured objects include:
● Scenarios
● Versions
● Accounts
● Entities
● Custom Dimensions

Hyperion Planning Administrator’s Guide ■ 31


Using Hyperion Planning

● Web forms
● Business Rules

Note: Business rules do not support user groups.

Table 4: Setting Up Users and Security - Users and Tasks

User Type Task

IT professional Sets up all Hyperion Planning users with a supported


external authentication provider
Administrator Add or imports externally-authenticated users in a
Hyperion Planning application
Administrator Sets up groups and assigns individual users to the groups.
Administrator Assigns security to secured objects

Creating and Refreshing the Application


The administrator creates and periodically refreshes the Hyperion Essbase OLAP
outline and security structure for the Hyperion Planning application. The Hyperion
Essbase OLAP outline and security structure are created based on the metadata
that is stored in the Hyperion Planning application’s relational database.
Hyperion Planning programatically creates:
● A Hyperion Essbase application
● Multiple Hyperion Essbase databases (one per plan type)
● Hyperion Essbase security filers
● Hyperion Essbase outlines (all metadata)
– Members
– Shared members (Entity dimension only)
– User-defined attributes
– Attribute dimensions

32 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
– Exchange rates
Table 5: Generating the Database - Users and Tasks

User Type Task

Administrator Creates and refreshes the Hyperion Planning application


based on the metadata that is stored in the application’s
relational database

Designing Data Entry Forms


Using the Web client, the administrators and interactive users can design, organize,
and maintain Web data entry forms. Form design includes the following tasks:
● Naming and describing the form
● Determining form layout (which dimensions are assigned to which axis:
columns, rows, POV, and page)
● Setting the precision of the displayed values
● Determining other form properties, including annotations on accounts,
displaying missing data as blank, suppressing missing data, and showing the
form fully expanded
● Selecting which members are assigned to the form
● Selecting members by their attributes
● Creating asymmetrical columns or rows
● Associating Hyperion Business Rules to a specific data entry form
● Creating form instructions
● Setting up the display or printing properties
● Assigning form access to Hyperion Planning users and/or groups
Table 6: Designing Data Entry Forms - Users and Tasks

User Type Task

Administrator and Creates and maintains data entry forms in Hyperion


interactive user Planning
Administrator and Creates and manages folders in Hyperion Planning for
interactive user form management

Hyperion Planning Administrator’s Guide ■ 33


Using Hyperion Planning

Table 6: Designing Data Entry Forms - Users and Tasks(Continued)

User Type Task

Administrator and Assigns access rights to forms


interactive user

Designing Spreadsheets
Any Hyperion Planning user can install the Hyperion Planning Spreadsheet
Add-in to create data entry worksheets. These worksheets enable users to leverage
their existing spreadsheet models, build custom formulas, and report formats in a
spreadsheet environment, or to work in a disconnected mode from Hyperion
Planning. Using the Spreadsheet Add-in, users can perform the following tasks:
● Design the worksheet layout (which dimensions are assigned to which form
axis - columns, rows, POV, and page).
● Select the members and aliases that are assigned to the worksheet.
● Create asymmetrical rows or columns.
● Associate Hyperion Business Rules to a specific worksheet.
Table 7: Designing Spreadsheets - Users and Tasks

User Task

Any user Creates and maintains worksheets using Hyperion


Planning Spreadsheet Add-in

34 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
Populating the Application with Data
Administrators are the primary type of user involved in pre-populating the
Hyperion Planning application with data. Interactive users can also assist in bulk
loading data directly into the applications.
Table 8: Populating the Application with Data - Users and Tasks

User Type Task

Administrator and Performs bulk loads of actuals data, previous forecasts,


interactive user and so forth, directly into Hyperion Planning databases
using Hyperion Application Link with the Hyperion
Essbase adapter or the Hyperion Essbase Application
Manager
Any user type Enters values for global saved planning assumptions that
are referenced in business rules
Any user type Enters data directly into the Hyperion Planning
application through a Web-based data entry form or the
Hyperion Planning Spreadsheet Add-in
Any user type Calculates and creates data using Hyperion Business
Rules or by using the Web-based copy version capabilities

Creating Business Rules


Both administrators and interactive users can design business rules using the
graphical user interface in Hyperion Business Rules. Business rules vary by
application, but typically they include:
● Allocation of costs among entities
● Revenue modeling
● Expense modeling
– Employee planning
– Depreciation planning
– Selling costs
– Manufacturing costs
● Balance sheet planning

Hyperion Planning Administrator’s Guide ■ 35


Using Hyperion Planning

– Capital expenditures
– Account receivables
● Sources and uses of cash
Business rules can be designed with run-time prompts and can also be set up to run
as an allocation sequence.
Business rules can be exported to the Hyperion Essbase database as calculation
scripts. Both calculation scripts and business rules that reside in the Hyperion
Business Rules repository can be launched from Hyperion Planning Web.
However, only calculation scripts can be launched from the Hyperion Planning
Spreadsheet Add-in.
Table 9: Creating Business Rules - Users and Tasks

User Task

Administrator and Creates models using Hyperion Business Rules


interactive user
Administrator and Assigns users access to the business rules
interactive user
Administrator and Exports business rules from the relational database to the
interactive user Hyperion Essbase database as calculation scripts
Administrator and Launches certain business rules to further populate the
interactive user Hyperion Planning application (for example, Budget2 =
Actual x 15%)

For more information on business rules, see “Using Business Rules” on page 250.
For information on setting up access to business rules, see “Setting Up Security for
Business Rules” on page 126.

Setting Targets
Administrators need to set up target type versions for the Hyperion Planning
application. A user’s access to target data is determined by their access right
assignments. Typically, target data is stored in the upper levels of metadata, such
as Business Unit, Product Family, or regional levels. The administrator needs to
configure the Hyperion Essbase database so that the target data is not replaced by
lower level #Missing values.

36 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
Target data is typically used as guidance for data entry and analysis. Target data
can be created by any type of user through various methods:
● Manual data entry
● Hyperion Application Link with the Hyperion Essbase adapter
● Modeling with Hyperion Business Rules
● Pushing targets down to lower level members using business rules.
Table 10: Setting the Target - Users and Tasks

User Type Task

Administrator Adds a standard target type version


Administrator Assigns users access to the target version (typically,
read-only access)
Administrator Configures the Hyperion Essbase database so that target
data is not replaced by lower level #Missing values
Any user Creates target data
Administrator Publishes targets using Hyperion Reports
Any user Displays targets on data entry forms for guidance or input

Reporting
Hyperion Reports allows you to create reports that can be used on a Windows
client or a Web-enabled client. Web-enabled reports are available to all Hyperion
Planning users who are using the Hyperion Reports Web Viewer.
Hyperion Reports works directly against the Hyperion Essbase databases and
adheres to the Hyperion Essbase security filters that are generated by Hyperion
Planning.
Table 11: Reporting - Users and Tasks

User Type Task

Administrator and Creates and launches management reports using Hyperion


interactive user Reports
Any user Prints reports to verify the bulk data loads and calculations

Hyperion Planning Administrator’s Guide ■ 37


Using Hyperion Planning

Table 11: Reporting - Users and Tasks(Continued)

User Type Task

Any user Views reports through the Hyperion Reports Web Viewer
throughout the planning cycle

Initializing the Planning Cycle


All users are involved in initializing the planning cycle at some level.
Table 12: Initializing the Planning Cycle - Users and Tasks

User Type Task

Administrator Selects which planning units are available for the iterative
review, analysis, and approval process
Any user Any user can indicate as a user preferences whether or not
they want to receive an e-mail when they become an
owner of a planning unit

At this point, the application setup is complete.

Building a Plan
Hyperion Planning users start the planning cycle by logging into an application
and opening the Web data entry forms to which they have access. Users read any
form instructions and review any historical or target data for guidance when
preparing the plan. Users can enter data directly into the form, including summary
time periods and spreading data values back to base time periods, adjusting
existing data values by a percentage value, copying data from one grid area to
another area, or copying data from one version to another version. Users can also
collapse or expand subtotals and scroll horizontally or vertically and maintain their
point of reference.
Users can enter annotations to document assumptions at the planning unit level or
on accounts. Certain Web data entry forms, based on the form design, provide for
shorter text annotations. For example, these may be used to describe variances to
targets or actuals.

38 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
Once data has been entered, users can save the data. Users can also select to restore
the data they have entered to the last saved version of the data. In this case, all data
that has been entered since the last save was performed is lost. Users may also save
a personal version of the data by using the copy version feature before promoting
the data for review and potential modifications. When data is saved, the following
events occur:
● The data is saved to the Hyperion Essbase database.
● The subtotals on the data entry form are calculated and stored if the Calculate
Form business rule is selected to run on save when the form is created. By
default, this option is not selected.
● Any business rules that are set up to calculate automatically when users select
to save is run.
The currently stored data values can be refreshed in the data entry form prior to
saving the data. Users can also click the Launch Business Rules button to display
all the associated business rules that can be launched from the form either before,
or after the data is saved.
Table 13: Building a Plan - Users and Tasks

User Type Task

Any user with the Accesses Web-based data entry forms


appropriate security
access
Any user with the Reads form-level instructions for planning guidelines, and
appropriate security reviews any historical or target data for guidance when
access preparing a plan
Any user with the Enters data
appropriate security
access
Any user with the Adjusts data values
appropriate security
access
Any user with the Enters annotations (for example, assumptions) for
appropriate security planning units
access

Hyperion Planning Administrator’s Guide ■ 39


Using Hyperion Planning

Table 13: Building a Plan - Users and Tasks(Continued)

User Type Task

Any user with the Calculates business rules


appropriate security
access
Any user with the Prints reports and analyses using the Hyperion Essbase
appropriate security Spreadsheet Add-in, Hyperion Reports, or third party
access reporting tools
Any user with the Copies the version of data to another version within the
appropriate security same scenario
access
Any user with the Saves the data
appropriate security
access

Launching Business Rules


The administrator or interactive user can create and launch business rules from the
Hyperion Planning Desktop. Business rules can be created with run-time prompts
or allocation sequences. After a business rule is exported to the Hyperion Essbase
database, it can be launched from the Hyperion Planning Web client or
Spreadsheet Add-in by any user. The business rules that are available to each user
depend on that user’s access rights. Administrators and interactive users have
access to all business rules in an application. Business rules that are associated
with a Web data entry form or a Spreadsheet Add-in worksheet can be launched
from that source.
Table 14: Launching Business Rules - Users and Tasks

User Task

Administrator and Launch business rules from the Hyperion Planning


interactive user with Desktop
the appropriate
security access
Any user with the Launch business rules from the Hyperion Planning Web
appropriate security client or Spreadsheet Add-in
access

40 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
Starting the Budget Review Process
The administrator initializes the review process by starting selected planning units,
or all planning units. The planning units that are started are considered to be in the
First Pass state. Data is typically promoted for review after the user enters data,
saves it, and calculates it. When users promote a planning unit, they enter an
annotation that records their assumptions and they select the next owner or
reviewer of the data. When a planning unit is promoted, the system automatically
does the following:
● Assigns ownership to the selected user
● Overrides the security on the planning unit to read-only for non-owners
● Changes the planning unit’s process status from 1st Pass to Under Review
● Updates the status of the upper level (or lower level) planning units to “under
review” as necessary
● Records an audit entry in the process history
● Optionally sends an e-mail notification to the new owner of the planning unit
● Optionally sends a copy of the e-mail to the application owner
During the review phase, the reviewer can make additional modifications or
annotations. Read-only users can continue to enter planning unit annotations and
short account annotations, but cannot enter data values. When the user keeps a
personal copy of the original data, it is easier to track the data that has been
modified. When a planning unit is promoted, the reviewer is the new owner and
typically does the following:
● Receives and opens e-mail notification and is directed to the Workflow Tasks
Web page in the Hyperion Planning application
● Sorts the Workflow Tasks status page by entity, current process state, or
current owner
● Reviews annotations and planning unit history
● Opens the data entry form and reviews, analyzes, modifies, and calculates data
● Makes additional annotations (including short account annotations)
● Promotes or rejects the planning unit; the system supports iterations until the
planning unit is approved

Hyperion Planning Administrator’s Guide ■ 41


Using Hyperion Planning

Once a planning unit is approved, the application owner becomes the planning unit
owner. An administrator is the only user who can reject a planning unit. To close
the review cycle, the application owner or administrator changes either the
scenario or version to read-only for all users so that no other data can be entered.
Table 15: Starting the Budget Review Process - Users and Tasks

User Task

Administrator Starts the planning unit for the planning cycle


Any user with the Enters data
appropriate security
access
Any user Calculates data
Any user Optionally, creates a copy of their submission
Any user Promotes data for review
Any user Enters additional annotations to support the review
process
Note: Until an owner is established for a planning unit,
multiple users with security access can update the same
planning unit. The system changes data access rights of
the non-owners to read-only when the planning unit is
promoted to the next reviewer.
Any user Notifies the reviewer that the planning unit is ready for
review
Any user Reviews data values of the promoted planning unit
Any user Reads and modifies promoted data through a Web-based
data entry form
Any user Saves and runs the business rules
Any user Reads promoted data using Hyperion Reports, Hyperion
Essbase Spreadsheet Add-in, or third party reporting tools

42 ■ Hyperion Planning Administrator’s Guide


Using Hyperion Planning
1
Table 15: Starting the Budget Review Process - Users and Tasks(Continued)

User Task

Any user Takes one or more of the following actions:


• Modifies data values
• Enters additional annotations
• Signs off on a planning unit, without changing
ownership
• Promotes the planning unit
• Rejects the planning unit
• Approves the planning unit
Administrator Checks the status of the planning process, by the planning
unit
Administrator Reads supporting annotations
Administrator Views the process history (audit trail)
Administrator Completes the planning cycle
Administrator Changes user access of scenarios and versions in
Hyperion Essbase to read-only
Administrator and Publishes reports using Hyperion Reports
interactive user

At this point, the process of building a plan is complete.

Post-Planning Activities
The administrator and the interactive user are involved during the post-planning
phase of using Hyperion Planning.
Table 16: Post-Planning Activities - Users and Tasks

User Type Task

Administrator and Uploads planning data by scenario to other applications,


interactive user such as Hyperion Financial Management, a general ledger,
or an ERP.
All users Copies a version of the newly completed plan to a new
version.

Hyperion Planning Administrator’s Guide ■ 43


Using Hyperion Planning

Table 16: Post-Planning Activities - Users and Tasks(Continued)

User Type Task

Administrator and Performs a bulk load of the new actual data into a
interactive user Hyperion Planning application to report on actual
performance versus plan (for example, actual results
versus budget).
All users Accesses a Web-based data entry form, Hyperion Reports,
Hyperion Planning Spreadsheet Add-in, Hyperion
Performance Scorecard, or third party reporting tools to
read updates to actuals and analysis of performance to
plan.

44 ■ Hyperion Planning Administrator’s Guide


Chapter Getting Started with Hyperion

2 Planning 2

This section describes how to start Hyperion Essbase server, start and navigate
Hyperion Planning, and register application servers for use with Hyperion
Planning.

Starting Hyperion Essbase


The data for Hyperion Planning applications resides on the Hyperion Essbase
server. Hyperion Essbase must be running before you can open Hyperion Planning
applications. After Hyperion Essbase is started, it can be minimized and run in the
background or run as a service.

Starting the Relational Database


A relational database must be running before you can open Hyperion Planning
applications. After the relational database has been started, it can be minimized
and run in the background or run as a service.

Optimizing an SQL Relational Database


You can configure the SQL timeout value through the SQLTimeOut registry key
setting. Depending on the size of your database records, some of the SQL queries
issued by Hyperion Planning could take longer to execute than the default ADO
timeout of 30 seconds. This could lead to a cube refresh failure. If you find this is
the case, you can change the SQL timeout value to decrease the likelihood of a
cube refresh failure.

➤ To optimize the SQL timeout value:


1. Select Start > Run.

Hyperion Planning Administrator’s Guide ■ 45


Getting Started with Hyperion Planning

2. In the Open text box, type regedit to open the Registry Editor.
3. Navigate to the following location:
HKEY_LOCAL_MACHINE\SOFTWARE\Hyperion Solutions\Hyperion
Planning\SQLTimeOut
If the Timeout registry key exists in the right pane, then the timeout value is set to
a corresponding value. If the Timeout registry key does not exist, the value is set
to the default.

Creating the Properties File


You must create the Properties file in order to configure JDBC connection pooling
parameters.

➤ To create the properties file:


1. Run the HspSetupSupport.exe file, which is located in the Program
Files\Hyperion Solutions\Hyperion Planning\Utils directory.

2. From the Application Server drop-down list, select the application server you
are using.
3. In the Hyperion Planning Path text box, enter the location of the new
properties file.
4. From the Select a JDBC Driver drop-down list, select the JDBC driver you
are using.
5. From the Select Database Language drop-down list, select the language of
the database you are using.
6. Click Launch.
7. The HspJSHome.properties file is located in the path you specified.
8. Click Exit.

Configuring JDBC Connection Pooling


You can determine the minimum and maximum number of JDBC connection
pools. How you configure these depends largely on the number of Hyperion
Planning users that are accessing the relational database. For example, you can
specify the minimum connection number in JDBC connection pool as one, and the
maximum as five. Doing this creates one connection when a user logs on to

46 ■ Hyperion Planning Administrator’s Guide


Getting Started with Hyperion Planning

Hyperion Planning. An additional connection is created for the next four users who
log on to Hyperion Planning, resulting in a total of five connections. Any
additional users who log on will share the five existing connections.
2
➤ To configure the JDBC connection pool parameters:
1. Open the HspJSHome.properties file, which is located in the
webapps\HyperionPlanning\Web-inf\classes directory within your
Web Application Server directory.

Note: If this file does not exist, see “Creating the Properties File” on page 46 for
instructions on creating the Properties file.

2. Change the minimum and maximum values in the following lines:


– JDBC_MIN_CONNECTIONS=1
– JDBC_MAX_CONNECTIONS=1
3. Save and close the properties file.

Starting Hyperion Planning on the Desktop


You can start Hyperion Planning from the Microsoft Windows Desktop. You
should have a basic understanding of the Microsoft Windows environment before
you start using Hyperion Planning. For information on using Microsoft Windows,
see the Microsoft Windows User's Guide.

➤ To start Hyperion Planning, do one of the following:


● From the Microsoft Windows Desktop, double-click the Hyperion Planning
icon.
● From the Microsoft Windows Desktop, select Start > Programs > Hyperion
Solutions > Hyperion Planning.

Using the Toolbar, Status Bar, and Navigation Frame


You can show or hide various components on the Hyperion Planning Desktop such
as the navigation frame, the toolbar, and the status bar. When a check mark
displays next to a menu option, the component is displayed. When there is no
check mark next to the menu option, the component is hidden.

Hyperion Planning Administrator’s Guide ■ 47


Getting Started with Hyperion Planning

You can also quickly expand and collapse the tasks in the navigation frame. Hiding
these components provides you with a larger workspace frame in which to use
Hyperion Planning. Showing these components provides you with access to
Hyperion Planning tasks. You must show the navigation frame to access any of the
Hyperion Planning tasks.
There are three types of nodes in the navigation frame.
● The top-level nodes contain category nodes. Hyperion Planning is an example
of a top-level node.
● The category nodes contain groupings of task nodes. Manage Dimensions is
an example of a category node in the Hyperion Planning navigation frame.
● The task nodes appear underneath category nodes. Task nodes can be
Hyperion applications, external applications, or external documents. Calendar
is an example of a task node.

Figure 1: Desktop Navigation Frame

➤ To show or hide components on the Desktop, do one or all of the following:


● Select View > Navigation Frame > Show/Hide, or click the Navigation
Frame toolbar button to show or hide the navigation frame.
● Select View > Toolbar to show or hide the toolbar.

48 ■ Hyperion Planning Administrator’s Guide


Getting Started with Hyperion Planning

● Select View > Status Bar to show or hide the status bar.

➤ To expand or collapse all tasks in the Desktop navigation frame, do one of the
following: 2
● Select View > Navigation Frame > Expand All, or click the Expand All
toolbar button to expand all tasks on the navigation frame.
● Select View > Navigation Frame > Collapse All, or click the Collapse All
toolbar button to collapse all tasks on the navigation frame.

➤ To expand or collapse some of the tasks on the desktop navigation frame, select
one of the category nodes and do one of the following:
● Select View > Navigation Frame > Expand Selected to expand the selected
category node.
● Select View > Navigation Frame > Collapse Selected to collapse the
selected category node.

Starting Hyperion Planning on the Web


To start Hyperion Planning on the Web, use your browser to access the URL where
the Web application server is installed and communicate this URL to all Web users
of Hyperion Planning applications. By default, the address is
http://<computer
name>[:port]/HyperionPlanning/LogOn.jsp where the
<computer name> is the name of the computer hosting the Hyperion Planning
Web server.
If you are using JRun, WebLogic, or Tomcat as an internal Web server, you need
to add a port number to the URL. For JRun, use port number 8300. For WebLogic,
use 7001. For Tomcat, use port number 8080.

Using Application Servers


You access Hyperion Planning applications through application servers. However,
before you can access applications, you must first register the application servers
on your workstation from within Hyperion Planning.

Hyperion Planning Administrator’s Guide ■ 49


Getting Started with Hyperion Planning

Registering a Server
➤ To register a server:
1. From the left navigation frame on the Hyperion Desktop, double-click
Hyperion Planning > Open Application.
2. From the Server drop-down list, select the server you want to register.

Note: A server must exist in the Windows NT domain before it can be registered.

3. Click Browse, .
4. In the Server text box, enter the name of the server you want to register.
5. Click Register.
6. Click Close.

Unregistering a Server
➤ To unregister a server:
1. From the left navigation frame on the Hyperion Desktop, double-click
Hyperion Planning > Open Application.
2. From the Server drop-down list, select the server you want to unregister.

3. Click Browse, .
4. In the Server text box, enter the name of the server you want to unregister.
5. Click Unregister.
6. Click Close.

50 ■ Hyperion Planning Administrator’s Guide


Getting Started with Hyperion Planning

Closing Hyperion Planning and Hyperion


Essbase
Before you can close Hyperion Planning on the Desktop, all task windows must be
2
closed. If they are not closed, the system prompts you to close them before exiting
Hyperion Planning. You should also close all Hyperion Planning applications.
However, keep in mind that this may affect other administrators who are currently
logged on to the application.
Closing Hyperion Planning returns you to the Microsoft Windows Desktop.

➤ To close Hyperion Planning from the Desktop, select File > Exit.

➤ To close Hyperion Essbase OLAP Server:


1. Maximize the Hyperion Essbase window.
2. Type Quit.

➤ To close Hyperion Planning on the Web, click Log Off.

Hyperion Planning Administrator’s Guide ■ 51


Getting Started with Hyperion Planning

52 ■ Hyperion Planning Administrator’s Guide


Chapter Creating an Application

3
3
This section describes how to create an application in Hyperion Planning using the
Setup Assistant and how to schedule a refresh of existing applications.

Prerequisites
Before you create an application, you need to make sure the following tasks are
completed:
● Create a relational database.
● Create a data source name (DSN).
● Create and configure a Microsoft Data Link (.UDL).
● Set System Properties for the Microsoft Data Link.
● Set the System Folder in Hyperion Server to a valid system folder.
For detailed instructions on performing these tasks, see the Hyperion Planning
Installation Guide.

Overview
An application is a related set of dimensions and dimension members that you use
to meet a specific set of planning needs. Each application has its own accounts,
entities, scenarios, and other data elements. For example, you might want to create
an application for your cost centers for budgeting operating expenses. You might
create a separate application that the finance department uses for revenue
planning.
Creating an application involves several steps and uses most of the Hyperion
Planning modules. The following is a list of the steps involved in creating an
application:

Hyperion Planning Administrator’s Guide ■ 53


Creating an Application

● Create an application with the Setup Application task.


● Create entities to reflect your organization’s budget structure.
● Create the accounts and additional dimensions required to gather planning
data.
● Create scenarios and versions.
● Create appropriate data entry forms to meet the needs of various users and
groups.
● Assign access rights to users and user groups.
● Set up the currencies and corresponding exchange rates for currency
conversions.
● Modify the calendar with the custom summary time periods your organization
needs.
● Use Hyperion Business Rules to build customized business rules.
● Use Hyperion Application Link to load data and copy versions from other
sources.
● Identify the review and approval process, its requirements, and its
participants.
● Create management reports. For more information about creating
management reports, see the Hyperion Reports System Administrator’s Guide.
This chapter covers only the first bullet item. The rest of the steps involved in
creating an application in Hyperion Planning are covered in subsequent chapters.

Creating Applications with the Setup Assistant


The Setup Application task in Hyperion Planning is the starting point for gathering
information that is essential to building the Hyperion Planning application and
creating its corresponding metadata. Setup Application guides you through the
steps necessary to create applications quickly and easily.
Creating an application involves the following steps:
● Using the Select Workspace Frame (see “Using the Select Workspace Frame”
on page 55)
● Creating the calendar (see “Creating the Calendar” on page 56)

54 ■ Hyperion Planning Administrator’s Guide


Creating an Application

● Defining the base time period and weekly distribution (see “Defining the Base
Time Period and Monthly Distribution Spread” on page 56)
● Defining the calendar range (see “Defining the Calendar Range” on page 57)
● Setting up currencies (see “Setting Up Currencies” on page 58)
● Setting up plan types (see “Setting Up Plan Types” on page 59)
● Saving the application (see “Saving the Application” on page 59)
3
Using the Select Workspace Frame
The Select workspace frame allows you to name the application, select its data
source, and select the application server on which it is located. The data source
connects to a relational database that is used to store information about the
application. Each application must have its own relational database and each
relational database must have a unique data source name (DSN). Data sources
cannot be shared among Hyperion Planning applications or relational databases.
Data sources are set up during the installation process. The IT administrator and
the Hyperion Planning budget administrator coordinate to ensure that data sources
are set up for all the Hyperion Planning applications that will be created.

➤ To use the Select workspace frame:


1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Manage Application > Setup Application.
2. From the Server drop-down list, select the server for the application.

Note: The server must first be registered for it to appear in the Server drop-down
list. If the desired server is not listed in the Server drop-down list, you may need to

register the server by clicking the Ellipsis button, . For more information about
registering a server, see “Registering a Server” on page 50.

3. Click Connect to Server.


4. In the Data Source text box, highlight the data source you want to use for this
application.

Note: A data source must be set up in advance for each new application. Data
sources cannot be shared among applications or relational databases.

Hyperion Planning Administrator’s Guide ■ 55


Creating an Application

5. In the Application text box, enter the name of the application.

Note: The maximum length of an application name is eight characters. An


application name cannot contain spaces, tabs, or characters that have a special
meaning to the relational database you are using. In addition, if Hyperion Essbase
is installed on a UNIX server, the application name cannot contain the underscore
character. We recommend limiting the application name to alpha-numeric
characters.

6. In the Description text box, enter a description for the application.


7. Click Next.

Creating the Calendar


The Calendar workspace frame allows you to establish the application’s base time
periods (monthly, quarterly, or custom), the starting fiscal year and month, and the
total number of years the application will contain. It also allows you to set up
weekly distribution patterns, which determine how values are spread when the
base time period is monthly.
The Calendar workspace frame contains two tabs, Define Basis and Define Range,
which are discussed in the following topics.
For more information about customizing the calendar after the application is
created, see “Customizing the Calendar” on page 135.

Defining the Base Time Period and Monthly


Distribution Spread
The Define Basis tab allows you to select the base time period and the monthly
distribution pattern, based on the number of fiscal weeks in a month. The base time
period options are the bottom-level time periods in the application. Pre-defined
options are quarters or months. You can also create a custom base time period, such
as weeks or days.
The options for monthly distribution patterns allow you to determine how data that
is entered into a summary time period is distributed or spread among the base time
period you select. During data entry, users can enter data into summary time
periods, such as years or quarters. Hyperion Planning then automatically
distributes the value the user enters over the base time periods that make up the
summary time period.

56 ■ Hyperion Planning Administrator’s Guide


Creating an Application

If you select a weekly distribution pattern other than Even Distribution, Hyperion
Planning treats quarterly values as if they were divided into 13 weeks, and
distributes the weeks according to the pattern you selected. For example, if you
select the 5-4-4 pattern, Hyperion Planning treats the first month in a quarter as if
it has five weeks, and the last two months in the quarter as if they have four weeks.

Note: The options for the weekly distribution pattern are available only if you select the
base time period option “12 Months.”

➤ To define the base time period and weekly distribution pattern: 3


1. From the Base Time Period area, select a base time period.
2. If you selected Custom, you must also perform the following tasks:
– In the Prefix text box, enter a prefix for the custom base time period. For
example, if you create a weekly base time period, you may want to enter
“WK-” as the prefix. The week number will be added to the prefix
automatically.
– In the Periods per Year text box, enter the number of periods per year in
the custom base time period.
3. From the 4-4-5 Weekly Distribution area, select a weekly distribution
pattern.

Note: The options in the Weekly Distribution area are available only if you have
selected the 12 Months base time period.

4. Select the Define Range tab.

Defining the Calendar Range


The Define Range tab allows you to specify the fiscal start year, the fiscal start
month, and the total number of years the application will contain. The fiscal start
year defines the starting fiscal year for the application. You cannot change this
after the application is created. When specifying the fiscal start year, you should
take into consideration how much historical data your organization needs and
wants in the application. The total number of years defines the number of years to
include in the calendar. You can add more years to your calendar at a later time.
An application can contain a maximum of 15 years.

Hyperion Planning Administrator’s Guide ■ 57


Creating an Application

➤ To define the calendar range:


1. In the Fiscal Start Year text box, type the year or use the drop-down list to
select the fiscal start year of the application.
2. From the Fiscal Start Month drop-down list, type the month or select the
month in which the fiscal year will start for the application.
3. In the Total Years text box, type the years or use the scroll arrows to select
the total number of years you want the application to contain.
4. Click Next.

Setting Up Currencies
The Currencies workspace frame allows you to specify the default currency for the
entities in the application and to establish if the application will support currency
conversions. Multiple currency support (also known as currency over-rides) is
available for level 0 members, regardless of their base currency.
For more information about currencies and currency conversions, see “Converting
Currency Values” on page 140.

➤ To set up currencies:
1. From the Default Application Currency drop-down list, select the default
currency for the application.
2. Do one of the following:
– Select Yes to indicate that the application will support more than one
currency. Once specified, this option cannot be changed.
– Select No to indicate that the application will not support more than one
currency, and will only support the default currency you previously
selected.

Note: If you specify that the application will support multiple currencies, two
additional dimensions are created, Currency and HSP_RATES dimensions.

3. Click Next.

58 ■ Hyperion Planning Administrator’s Guide


Creating an Application

Setting Up Plan Types


The Plan Types workspace frame allows you to include up to three plan types in
the application. A separate Hyperion Essbase database is created for each plan
type. As you create the accounts, entities, and other elements of the application,
you associate them with plan types, so that the database for each plan type contains
only the application dimensions, members, and data values relevant to that plan
type. This allows for optimal application design, size, and performance.
The number of plan types you include in the application depends on the needs of 3
your organization. For example, the sales department may be responsible for a
yearly revenue plan and the finance department may be responsible for a P&L
plan. You could then define two plan types, Revenue and P&L.
Data can be shared between the plan types as needed. For example, the Revenue
plan may include a number of sales detail accounts that roll up into a Total Product
Sales account. You can set up the P&L plan to include the Total Product Sales
account, but to omit the sales detail accounts. This allows you to bring the data
value for the Total Product Sales into your P&L plan, without all of the account
detail. This makes the database for your P&L plan smaller and more efficient.
You must set up at least one plan type, and you cannot change the number of plan
types or the plan type labels after the application has been created. Plan type labels
can be up to eight characters.

Note: If Hyperion Essbase is installed on a UNIX server, the plan type name cannot
contain the underscore character.

➤ To set up plan types:


1. Select the Plan Type 1 check box.
2. In the Name text box, enter the name of the plan type.
3. Repeat these steps for Plan Types 2 and 3 if desired.
4. Click Next.

Saving the Application


The Finish workspace frame allows you to save the application. The application is
saved in a relational database on the application server you specified.

➤ To save an application:
1. Click Finish.

Hyperion Planning Administrator’s Guide ■ 59


Creating an Application

2. In the Password text box on the Login dialog box, enter your Windows NT
password.

Note: When you generate or refresh the application using the Manage Database task,
the Hyperion Essbase dimensional outlines and alias tables are created and/or
updated, and exchange rate values are re-populated into the Hyperion Essbase
outlines.

Creating Additional Applications


Each time you want to create an additional Hyperion Planning application, you
need to perform the following tasks:
● Create a relational database.
● Create a data source name (DSN).
● Create and configure a Microsoft Data Link (.UDL).
● Create the application using the Setup Application task, which is described in
the previous section.

Using Applications
After you create an application, you can then open, delete, or close the application.

Opening Applications
You can open an application to work with its data or run reports. You can have
multiple applications that reside on the same server open at the same time.
However, this has the potential to slow performance, depending on server
configuration, the processor speed of your computer, and the amount of memory
available. For further assistance on determining server configuration, contact your
Hyperion consultant.

➤ To open an application:
1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Open Application.

60 ■ Hyperion Planning Administrator’s Guide


Creating an Application

2. From the Server drop-down list, select the server on which the application
resides.

Note: The server must first be registered for it to appear in the Server drop-down
list. If the desired server is not listed in the Server drop-down list, you may need to

register the server by clicking the Ellipsis button, . For more information about
registering a server, see “Registering a Server” on page 50.

3. Click Connect to Server. 3


4. From the Applications list box, select the application you want to open.
5. Click Open Application.
6. In the Password text box on the Logon dialog box, enter your Windows NT
password.
7. Click Logon.

Note: Once you are logged on, the server and application names appear in the
Connected To text box on the Open Application dialog box.

Deleting Applications
Only the application owner can delete a Hyperion Planning application. When the
application owner deletes an application, the Hyperion Essbase application is also
deleted and the application is no longer available to any Hyperion Planning user.
Before deleting an application, the application owner must be sure that no other
user is currently using the application. We recommend that you back up the
application’s system tables before you delete the application.

Tip: The default application owner is the administrator that created the application. The
application owner can later re-assign ownership to another administrator.

➤ To back up system tables:


1. Determine which SQL database is the first database created when the first
application for Hyperion Planning is created.
2. Select Start > Programs > Microsoft Server 7.0 > Enterprise Manager.
3. In SQL Server Enterprise Manager, expand the database name until the
Databases folder is displayed.
4. Right-click the Databases folder and select All Tasks > Restore Database.

Hyperion Planning Administrator’s Guide ■ 61


Creating an Application

5. On the General tab, type Sysdat in the Restore as database text box.
You can use any name you want, but it should be one that indicates where the
system tables are stored.
6. In the Restore area of the dialog box, select the Database option.
7. In the Parameters area of the dialog box, from the Show backups of
databases drop-down list, select the SQL database from which you want to
copy all the tables.
8. Click OK.
You should receive the message: “Restore of Database <name of database>
completed successfully.”
9. Create a UDL that links to the Sysdat database.
10. In the Hsxsysadmin.msc, change the System Data Link file to the Sysdat
UDL.

➤ To delete an application:
1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Open Application.
2. From the Server drop-down list, select the server on which the application
resides.

Note: The server must first be registered for it to appear in the Server drop-down
list. If the desired server is not listed in the Server drop-down list, you may need to

register the server by clicking the Ellipsis button, . For more information about
registering a server, see “Registering a Server” on page 50.

3. Click Connect to Server.


4. From the Application list box, select the application you want to delete.

Note: You must be logged on to the application for it to appear in the Application
list box.

5. Click Delete Application to delete the selected application from the server.
6. Click Yes to confirm the deletion.
7. In the Password text box on the Specify Administrator dialog box, enter your
Windows NT password.

62 ■ Hyperion Planning Administrator’s Guide


Creating an Application

8. Click OK.

Closing Applications
You can close a Hyperion Planning application at any time. When you close the
application, the system prompts you to save any changes you have made.

➤ To close an application:
1. From the navigation frame on the Hyperion Planning Desktop, double-click
3
Hyperion Planning > Open Application.
2. From the Server drop-down list, select the server on which the application
resides.

Note: The server must first be registered for it to appear in the Server drop-down
list. If the desired server is not listed in the Server drop-down list, you may need to

register the server by clicking the Ellipsis button, . For more information about
registering a server, see “Registering a Server” on page 50.

3. Click Connect to Server.


4. From the Application list box, select the application you want to close.

Note: You must be logged on to the application in order for it to appear in the
Application list box.

5. Click Close Application to close the selected application.

Unlocking Applications
Occasionally a Hyperion Planning application can become locked. This can be
caused by an event such as abnormally exiting the application and Hyperion
Planning. The Unlock Application utility lets you clear all records in the
HSP_LOCK table, which unlocks the application if there has been an interruption
to the Hyperion Planning application.
You must run the unlock application utility from the Hyperion Planning
application server. You can run it from the command line or by directly invoking
the executable.

Hyperion Planning Administrator’s Guide ■ 63


Creating an Application

It is a good idea to make sure there are no users in the Hyperion Planning Desktop
before running the utility. You can confirm this by launching the task manager on
the Hyperion Planning server and making sure there are no processes called
hsxser~1 (hsxserver) or hspds.

➤ To unlock a Hyperion Planning application:


1. Locate the UnlockApp utility by navigating to the Hyperion
Solutions\Hyperion Planning\Utils folder.

2. Double-click UnlockApp.exe.
3. Select the application to be unlocked, and then click OK.
4. Check the application event logs using the Event Viewer in Administrative
Tools to see whether a success or failure event has been reported.
Alternatively, you can launch the utility from the command line by navigating to
the Hyperion Solutions\Hyperion Planning\Utils folder and entering the
following command:
unlockapp.exe [<application name>]
where: <application name> is the name of the application you want to unlock.

Using Broadcast Messaging


You can use broadcast messaging to communicate a text message to all Hyperion
Planning users who are currently logged on to a specific application. You can
either do this through the Hyperion Planning Desktop or through a command line
utility. If you are sending a broadcast message through the Hyperion Planning
Desktop, the application is the same one to which you are currently logged on. If
you are sending a broadcast message through the command line utility, you can
specify any application, without being logged on to it. In addition, when using the
command line utility, you can schedule the broadcast message, using standard
operating system mechanisms. Broadcast messaging is helpful if you need to send
periodic messages about system availability or periodic maintenance, such as
application back ups.
For all users who are logged on to the application through the Windows client (for
example, remote administrators and Spreadsheet Add-in users), the broadcast
message displays as a pop-up message box on their desktop. For all users who are
logged on to the application through the Web client, the broadcast message

64 ■ Hyperion Planning Administrator’s Guide


Creating an Application

displays in their browser the next time they refresh the page or go to a different
page. This behavior applies whether you send the broadcast message through the
Hyperion Planning Desktop or the command line utility.
Only users who are currently logged on to the application see the broadcast
message. Users who are logged on to the application through Hyperion Reports,
Hyperion Application Link, Hyperion Business Rules, Hyperion Essbase
Application Manager, Hyperion Analyzer, or any other third-party reporting tools
do not receive broadcast messages.
3
➤ To send a broadcast message through the Hyperion Planning Desktop:
1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Manage Application > Manage Database.
2. Click Message.
3. In the Broadcast Message dialog box, type the message you want to
broadcast.
4. Click Send.

➤ To send a broadcast message using the broadcast message command line utility:
1. Use the Microsoft Windows Scheduled Tasks tool (or another scheduler that
accepts command line prompts) to enter the Broadcast Message command
line.

Note: The BroadcastMessage.exe is installed in the UTILS directory when you


install Hyperion Planning. BroadcastMessage.exe must be run on a server that is
registered by the Hyperion Planning application for which you want to send a
broadcast message.

2. The format and required arguments in the BroadcastMessage command line


are:
broadcastmessage.exe Server Name, Domain Name, Application
Name, User Name, Password, Message
● Server Name is assumed to be the localhost name.
● Domain Name is the name of the domain.
● Application Name is the name of the application to whose logged-on
users you want to send a message.

Hyperion Planning Administrator’s Guide ■ 65


Creating an Application

● User Name is the user who has rights to send a broadcast message. This
is always an administrator.
● Password is the password for the user you previously specified.
● Message is the text message of up to 127 characters that you want to send
to the users of the specified application.
3. View the results of the broadcast message, including any errors, in the
Windows Event Viewer Application Log.
The following is an example of a typical command line used to send a broadcast
message to all logged on users of a specified application:
broadcastmessage.exe
ABCserver,testdomain,testapp,Jsmith001,admin,Please log off the
application immediately for routine maintenance.

Viewing Usage Statistics


You can see how many and which Hyperion Planning Web users are logged on to
the current application, and how long it has been since each user last accessed the
application.
You can also see what percentage of the supporting detail detection cache is being
used. This helps you see whether an appropriate amount of RAM has been
allocated. If the number is very low, you should consider allocating less RAM. If
the number is very high, you should consider allocating more RAM. The default
value of 20 is created by the Properties File Creator (HspSetupSupport.exe) and
is stored in the HspJSHome.properties file. For more information on changing
the amount of RAM allocated to supporting detail cache, see “Allocating Memory
for Supporting Detail Cache” on page 78.
Those users who are logged on to the application through the Hyperion Planning
Windows client, Hyperion Reports, Hyperion Application Link, Hyperion
Planning Spreadsheet Add-in, Hyperion Business Rules, Hyperion Essbase
Application Manager, Hyperion Analyzer, or any other third-party reporting tools
are not included in the list of logged on-users.

➤ To view usage statistics:


1. From the Web client, log on to an application.
2. From the Hyperion Planning Home page, click Administration.

66 ■ Hyperion Planning Administrator’s Guide


Creating an Application

3. Click the Statistics link under the Administration link.

Creating Application Databases


After you create an application, you need to create the Hyperion Essbase
multidimensional databases that store the application data. A separate Hyperion
Essbase database is created to store data for each plan type in the application. The
databases are structured according to the dimensions, their hierarchical members, 3
attributes, and other data that is specified in an application. In addition, Hyperion
Essbase creates an encrypted data file (Essbase.sec) to store security
information.
You can create Hyperion Essbase databases for the application before completing
the structure of the application. However, when the structure is complete, you need
to refresh the Hyperion Essbase databases. When you make changes to the
application structure (for example, modify properties of an entity member, add a
scenario, or change user types and security profiles), those changes are stored in
Hyperion Planning’s relational database until you refresh the Hyperion Essbase
databases for the application. Planners using the Web client for data entry and
workflow tasks do not see the changes you make to an application until you refresh
the Hyperion Essbase databases for the application.
When you initially create the application databases, you can select to include all
information. Otherwise you must select the information to include in the following
manner:
● If you include security information, you must include database information.
● If you include currency conversion calc scripts, you must include database
information.
After the initial creation of the databases, you can refresh the information
separately. However we recommend that you always select to refresh the database
information in conjunction with both the security information and the currency
conversion calcscript information.

Note: All users must be logged off from the Hyperion Planning application before the
Hyperion Essbase databases can be refreshed.

➤ To create databases in Hyperion Essbase for an application:


1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Manage Application > Manage Database.

Hyperion Planning Administrator’s Guide ■ 67


Creating an Application

2. Select the Lock current application from other users option to prevent
users from logging on to the application while Hyperion Planning prepares to
create the databases.
3. Select one or more of the Create/Refresh Options.
● Select All to automatically include databases, security filters, and
currency conversion calc scripts.
● Select Database to create the Hyperion Essbase multidimensional
databases that store the application data.
● Select Security Filters to create an encrypted data file (Essbase.sec)
to store security information.

Tip: To generate security filters for all users in the application, select this
check box, but do not select the Validate Limit check box.

Note: To update only a few user security filters, you can do that with the
Implement Security task. For more information about updating individual user
security filters, see “Implementing User Security” on page 116.

Note:

● Select Shared Members if you are applying security to shared members


in addition to base members. If you are only applying security to base
members, deselect this option.
● Select Validate Limit to identify which (if any) security filters exceed the
Hyperion Essbase security filter limit of 4KB per row. Users who exceed
the security filter limit display in the Failed Security Filters dialog box.

Tip: This option validates the size of the security filters to make sure they do
not exceed the size limit before you actually transfer data to Hyperion
Essbase. Selecting Validate Limit does not generate security filters; to do so,
select only the Security Filters check box.

● Select Currency Conversion CalcScript to create a user-defined


currency conversion calcscript.

Note: Selecting the Currency Conversion CalcScript option does not launch
the calcscript. Additionally, only administrators can launch calculation scripts.

4. If you select the Currency Conversion CalcScript option, the Currency


Conversion CalcScript Parameters area is enabled. Set the following:

68 ■ Hyperion Planning Administrator’s Guide


Creating an Application

● In the CalcScript Name text box, enter a name for the application
currency conversion calcscript.
● In the Version Type area, select either Bottom-Up or Target. The
selection you make affects the versions that are listed in the Versions text
box.
● In the Currencies text box, select one or more currencies as parameters
for the application currency conversion calcscript. Or select All to include
all currencies. 3
● In the Scenarios text box, select one or more scenarios as parameters for
the application currency conversion calc script. Or select All to include all
scenarios.
● In the Versions text box, select one or more versions as parameters for the
application currency conversion calc script. Or select All to include all
versions.
5. Click Create.

CAUTION: When you click Create, the data in existing databases is


erased and the Hyperion Planning plan types are rebuilt. We recommend
that you back up the existing application before proceeding.

Optimizing the Performance of Currency Conversion Calc


Scripts
If multiple currencies are enabled for the Hyperion Planning application and you
have checked Currency Conversion Calc Script on the Manage Database task, a
currency conversion calc script is created, based on the selected scenarios,
versions, and currencies. (For more information on working with multiple
currencies, see “Enabling Multiple Currencies” on page 140.)
When the currency conversion calc script is created, a second calc script is
automatically generated by Hyperion Planning. Its purpose is to copy the
appropriate exchange rates to the account, based on the account rate type. The

Hyperion Planning Administrator’s Guide ■ 69


Creating an Application

copy calc script is named HSPCrtB.csc for bottom-up versions and


HspCrtT.csc for target versions. Running the copy calc script enables the
currency conversion calc script to run more efficiently.

Note: The selected scenarios, versions, and currencies must be able to store data in
the Hyperion Essbase database outline. Dynamic Calc, Dynamic Calc and Store, and
Label are virtual members that do not store data. There is no benefit to running the copy
of the currency conversion calc script if the target version has virtual members because
Hyperion Essbase will discard the results of the calculation for these members.

The first time a currency conversion is launched, administrators need to run both
the copy currency rates calc script and the currency conversion calc script.
To create the copy currency calc script for existing calc scripts, the administrator
needs to regenerate currency conversion calc scripts in the Manage Database task
on the Hyperion Planning Desktop. For more information, see “Creating
Application Databases” on page 67.
The calc scripts need not be run again unless there are changes to the database
outline, such as exchange rate or account rate type changes, or adding new
versions, scenarios, accounts, or user-defined dimensions.

Refreshing Application Databases


It is important to export existing data or back up calc scripts to separate files on a
local drive before refreshing the databases.
Hyperion Planning provides you with the flexibility to decide what information to
transfer to Hyperion Essbase databases, and when to transfer that information. You
can transfer the data for each plan type, security information, or application
currency conversion information at the same time, or separately. This allows you
to make data for each plan type quickly available to users for form creation and
data entry. You may then select to transfer the security information during
non-peak hours, which maximizes system availability.

➤ To refresh databases in Hyperion Essbase for an application:


1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Manage Application > Manage Database.
2. Select the Lock current application from other users option to prevent new
users from logging on to the application while Hyperion Planning prepares to
refresh the databases.

70 ■ Hyperion Planning Administrator’s Guide


Creating an Application

3. Select one or more of the Create/Refresh Options.


● Select All to automatically include databases, security filters, and
currency conversion calc scripts.
● Select Database to refresh the Hyperion Essbase multidimensional
databases that store the application data.
● Select Security Filters to create an encrypted data file (Essbase.sec) to
store security information.
3
● Select Shared Members if you are applying security to shared members
in addition to base members. If you are only applying security to base
members, deselect this option.
● Select Validate Limit to identify which (if any) security filters exceed the
Hyperion Essbase security filter limit of 4KB per row. Users who exceed
the security filter limit display in the Failed Security Filters dialog box.

Tip: This option can be used to validate security filter size limit before you
begin the actual transfer of data to Hyperion Essbase. To do so, select only
this option.

● Select Currency Conversion CalcScript to create a user-defined


currency conversion calcscript.

Note: Selecting the Currency Conversion CalcScript option does not launch
the calcscript. Additionally, only administrators can launch calculation scripts.

4. If you select the Currency Conversion CalcScript option, the Currency


Conversion CalcScript Parameters area is enabled. Complete the following
tasks:
● In the CalcScript Name text box, enter a name for the application
currency conversion calcscript.
● In the Version Type area, select either Bottom-Up or Target. The
selection you make affects the versions that are listed in the Versions text
box.
● In the Currencies text box, select one or more currencies as parameters
for the application currency conversion calcscript. Or select All to include
all currencies.

Hyperion Planning Administrator’s Guide ■ 71


Creating an Application

● In the Scenarios text box, select one or more scenarios as parameters for
the application currency conversion calcscript. Or select All to include all
scenarios.
● In the Versions text box, select one or more versions as parameters for the
application currency conversion calcscript. Or select All to include all
versions.
5. Click Refresh.

CAUTION: When you click Refresh, data may be removed, depending on


the changes to the application. It is recommended that you back up the
existing application before proceeding any further.

Scheduling Application Databases to be Refreshed


Hyperion Planning allows you to refresh applications at a scheduled time. This
allows you to schedule the refreshes at a time that is most convenient for your
users, or when the availability of the server resources is optimal. For example, you
may want to schedule the application refresh to take place after business hours, to
minimize the impact on users.
During a scheduled application refresh, the metadata for an existing Hyperion
Planning application is updated in the Hyperion Essbase database. The following
lists some of the items that are updated during a refresh:
● Accounts or any associated properties are propagated from the relational
database to the Hyperion Essbase database
● Hyperion Essbase security filters
● Currency conversion calcscripts
● Custom attributes and access rights are added, modified, and/or deleted in the
Hyperion Essbase database
● The exchange rate values are re-populated in the Hyperion Essbase outline to
incorporate additions, modifications, and deletions
● Member formulas for certain accounts are generated and/or updated
● Additions or changes to alias tables and their association to dimensions or
members are updated

72 ■ Hyperion Planning Administrator’s Guide


Creating an Application

● The Hyperion Essbase database is restructured


The amount of time it takes for an application to refresh depends on factors such
as the number of entities, users, and so on, that are in the application. As the
number of total users and security filters increases, the length of time it takes to
perform a refresh also increases.

Note: The application refresh utility verifies only the syntax of the argument you supply
to run the utility. It does not perform a check to verify that the members you supply in
the argument are valid. If you supply an invalid scenario, version, or currency for the 3
application or if you supply a non-reporting currency, the calc script is still generated,
but produces an error when it is run. Therefore, you must supply valid parameters in the
argument list for the calc script to run successfully.

➤ To create a batch file that creates or refreshes a Hyperion Planning application into
a Hyperion Essbase database:
1. Start Hyperion Essbase.
2. Use the Microsoft Windows Scheduled Tasks tool (or another scheduler that
accepts command line prompts) to enter the AppSchedule command line.

Note: The AppScheduler.exe is installed in the UTILS directory when you install
Hyperion Planning. AppScheduler.exe must be run on a server that has been
registered by the Hyperion Planning application you wish to refresh.

3. The format and required arguments in the AppSchedule command line are:
AppScheduler.exe([Server Name],Application Name,User
Name,User Password,Create/Refresh
Specification,Create/Refresh Options,Currency Conversion
CalcScript Name,Currency List,Scenario List,Versions
List,Version Type Specification, Security on Shared
Members)
● [Server Name] is optional. If you do not provide this argument, the
server name is assumed to be the localhost name.
● Application Name is the name of the application on which the
application create or refresh is to be run.
● User Name is the user who has rights to create or refresh the application.
This is always an administrator.
● User Password is the password for the user you previously specified.
● Create/Refresh Specification is the function to be performed on
the application.

Hyperion Planning Administrator’s Guide ■ 73


Creating an Application

● Use /C to create an application.


● Use /R to refresh an application.
● Create/Refresh Options are the items that will be created or
refreshed.
● Use 1 to specify the database.
● Use 2 to specify the security filters.
● Use 3 to specify the generation of currency conversion calcscripts.

Note: When specifying multiple options, use a semicolon as a delimiter. For


example, to specify the database and security filters, use 1;2.

● Currency Conversion CalcScript Name is the name of the


application currency conversion calcscript and is only necessary if you
specified to generate an application currency conversion calcscript.
● Currency List is the list of currencies to be included in the application
currency conversion calcscript. This option is only necessary if you
specified to generate an application currency conversion calcscript. Be
sure that the currencies you specify exist in the application.

Note: When specifying multiple currencies, use a semicolon as a delimiter.


For example, currency1;currency2;currency3.

● Scenarios List is the list of scenarios to be included in the application


currency conversion calcscript. This option is only necessary if you
specified to generate an application currency conversion calcscript. Be
sure that the scenarios you specify exist in the application.

Note: When specifying multiple scenarios, use a semicolon as a delimiter.


For example, scenario1;scenario2;scenario3.

● Versions List is the list of versions to be included in the application


currency conversion calcscript. This option is only necessary if you
specified to generate an application currency conversion calcscript. Be
sure that the versions you specify exist in the application.

Note: When specifying multiple versions, use a semicolon as a delimiter. For


example, version1;version2;version3.

74 ■ Hyperion Planning Administrator’s Guide


Creating an Application

● Version Type Specification is the indicator for the type of versions


that are included in the application currency conversion calcscript.
● Use 0 to indicate target versions.
● Use 1 to indicate bottom-up versions.
● Security on Shared Members is the indicator for whether or not you
want to enforce security on shared members. Enforce this parameter if
you are applying security to shared members in addition to base members.
If you are only applying security to base members, ignore security on 3
shared members.
In order to specify this parameter, you must have selected to specify
security filters in the Create\Refresh Options parameter.
● Use 0 to ignore security on shared members.
● Use 1 to enforce security on shared members.

Note: The first seven parameters are required and the last six parameters are
optional. The optional parameters are only necessary if you select to generate
currency conversion calcscripts or security filters during the application refresh.

4. View the results of the application refresh, including any errors, in the
Windows Event Viewer Application Log.
The following examples show typical command lines to both create and refresh an
application, either with or without generating currency conversion calcscripts.

Create Application without Generating Currency Conversion CalcScripts


appscheduler localhost,HYPERION,testApp,testUser,password,/C,1;2

Refresh Application without Generating Currency Conversion CalcScripts


appscheduler localhost,HYPERION,testApp,testUser,password,/R,1;2

Create Application and Generate Currency Conversion CalcScripts


appscheduler
localhost,HYPERION,testApp,testUser,password,/C,1;2;3,currencyconvcalcnam
e,currency1;currency2;currency3,scenario1;scenario2,version1;version2;version3
,0,1

Hyperion Planning Administrator’s Guide ■ 75


Creating an Application

Refresh Application and Generate Currency Conversion CalcScripts


appscheduler
localhost,HYPERION,testApp,testUser,password,/R,1;2;3,currencyconvcalcnam
e,currency1;currency2;currency3,scenario1;scenario2,version1;version2;version3
,1,1

Validating the Application Refresh


After the application database is refreshed, a message displays to indicate whether
the refresh was successful or not. An error code 1 indicates that the application
refresh failed and a zero indicates that the refresh was successful.

Optimizing Application Performance


You can optimize application performance in the following ways:
● Assigning dimensions as either dense or sparse
● Allocating memory for supporting detail cache

Dense and Sparse Dimensions


You can speed up data retrieval and minimize memory and disk space
requirements by assigning the dimensions to one of two types: dense dimensions
and sparse dimensions. If the dimension lacks data values for the majority of
member combinations, define it as a sparse dimension. If the dimension has data
values for the majority of member combinations, define it as a dense dimension.
Hyperion Essbase requires at least one dimension, and that it be set to dense. You
should also note that custom attributes cannot be assigned to dense dimensions.

➤ To speed up calculation time by ordering dimensions according to the following


guidelines:
1. Place the Account dimension first in the Dimension list.
2. Place the Time dimension second in the Dimension list.
3. Order all dimensions from the largest dense dimension to the smallest dense
dimension.
4. Order all dimensions from the smallest sparse dimension to the largest sparse
dimension.

76 ■ Hyperion Planning Administrator’s Guide


Creating an Application

For more information about dense and sparse dimensions, see “About Sparse and
Dense Dimensions” on page 157.

➤ To optimize performance of a Hyperion Planning application:


1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Manage Dimensions > Performance Settings.
2. From the Plan Type drop-down list, select a plan type and the dimensions that
belong to the plan type. Each application can have up to three plan types. 3
3. From the Dimensions list, select one or more dimensions.
4. Do one of the following:

● Click Move Up, , to move the dimension up in the list.

● Click Move Down, , to move the dimension down in the list.


5. Do one of the following:

● Click Sparse, , to designate the dimension as a sparse


dimension. A sparse dimension contains data values that are not smoothly
and randomly distributed, and that do not exist for the majority of member
combinations in the database.

● Click Dense, , to designate the dimension as a dense


dimension. A dense dimension contains data values that are smoothly and
randomly distributed, and that exist for the majority of the member
combinations in the database.
6. Click Save.

Note: When you save the performance settings, a validation check is performed
to ensure that you have designated at least one dense dimension in each plan type.
If the validation fails, an error message displays and you can change the
performance settings.

Hyperion Planning Administrator’s Guide ■ 77


Creating an Application

Allocating Memory for Supporting Detail Cache


You can specify the amount of memory you want to dedicate to detecting
supporting detail cache. Allocating the appropriate amount of memory improves
performance when users change the status of a planning unit. The default value of
20 is created by the Properties File Creator (HspSetupSupport.exe) and is stored
in the HspJSHome.properties file. By default, this file is in the following
location:
<WebAppServer>\<application directory>\Hyperion
Planning\Web-inf\classes

For example, if you are using Apache Tomcat, the HspJSHome.properties file is in
the following location:
C\:Program Files\Apache Tomcat\webapps\Hyperion
Planning\Web-inf\classes

➤ To change the default memory allocation for supporting detail cache:


1. Open the HspJSHome.properties file.

Note: If this file does not exist, see “Creating the Properties File” on page 46 for
instructions on creating the Properties file.

2. Change the SUPPORTING_DETAIL_CACHE_SIZE entry.


3. Save and close the properties file.
To view the supporting detail cache usage, see “Viewing Usage Statistics” on
page 66.

Backing Up Applications and Application


Databases
You should back up your applications and application databases on a daily basis.
Specific instances of when you need to back up your applications and application
databases include:
● Before refreshing an existing application (Hyperion Planning prompts you to
perform a backup first)
● Before moving an application to a new server
● Before upgrading an application

78 ■ Hyperion Planning Administrator’s Guide


Creating an Application

● As your business dictates (for example, at key planning milestones)


Backing up an application and its related application databases is a three part
process, consisting of the following steps:
● Backing up the application specifics in Hyperion Essbase
● Backing up the relational databases
● Backing up the required components of Hyperion Planning
3
Backing Up the Application in Hyperion Essbase
There are three pieces of information that must be backed up for an application in
Hyperion Essbase: the actual application, the security file, and the configuration
settings.

Backing Up the Application


To back up the application in Hyperion Essbase, you must copy the directory in
which the application resides and place it in a backup directory of your choice.
Usually, this directory is in the App directory under the directory in which
Hyperion Essbase is installed (for example, C:\Program Files\Hyperion
Essbase\App).

For example, to backup the application PlanApp, you copy the directory with the
same name (PlanApp) under the Hyperion Essbase\App directory. This
procedure must be followed for every application that needs to be backed up. To
restore the application, you paste the backed up directory under the App directory.
If all the Hyperion Essbase applications are to be backed up, the entire Hyperion
Essbase directory (where Hyperion Essbase is installed) can be copied and stored
under the backup directory and can be restored when necessary.

Backing up the Security File


To back up the Hyperion Essbase file, you must copy the Essbase.sec file and
paste it in the backup directory. The Essbase.sec file resides in the Bin
directory, under the directory in which Hyperion Essbase is installed (for example,
C:\Program Files\Hyperion Essbase\Bin).

Hyperion Planning Administrator’s Guide ■ 79


Creating an Application

Backing up Configuration Settings


To back up the configuration settings for Hyperion Essbase, you must copy the
Essbase.cfg file and paste it in the backup directory. The Essbase.cfg file
resides in the Bin directory, under the directory in which Hyperion Essbase is
installed (for example, C:\Program Files\Hyperion Essbase\Bin).

Backing Up the Relational Database for Hyperion Planning


and Hyperion Reports
The database you need to back up is the database to which the UDL file associated
with the application points. After determining the database you need to back up,
you have to back up the database for complete restoration of the application at a
later time. In addition to this database, you also have to backup the database in
which the HSX_DATASOURCES table resides. This table is built into the schema
of the database pointed at by the system UDL.
The following section contains procedures for backing up your repository and
repository tables for the following Databases:
● Microsoft SQL Server
● IBM DB2
● Oracle

Backing Up the Microsoft SQL Server Repository


This section contains an example for backing up a Microsoft SQL Server
Repository. This is only an example. Refer to your Microsoft SQL Server
documentation for detailed information on performing database backups, or
contact your Microsoft SQL Server administrator.

➤ To back up repository tables for Microsoft SQL Server:


1. Select Start > Programs > Microsoft SQL Server > Enterprise Manager.
2. Expand SQL Server Group.
3. Expand a server.
4. Expand Databases.
5. Right-click on the database that contains your Hyperion Planning repository
tables.

80 ■ Hyperion Planning Administrator’s Guide


Creating an Application

6. In the Context menu, select All Tasks > Backup Database.


7. Select a backup device, and assign a file name or media.
8. Click OK.
9. Repeat this procedure to back up the Hyperion Reports repository tables.

Backing up IBM DB2 Repository


This section contains an example for backing up an IBM DB2 Repository. This is
3
only an example. Refer to your IBM DB2 documentation for detailed information
on performing database backups, or contact your IBM DB2 administrator.

➤ To back up repository tables for IBM DB2:


1. Open a Windows command prompt or UNIX shell as the DB2 instance owner.
2. Stop DB2 applications by issuing the following command:
db2 force applications all

3. Verify that DB2 application processing has stopped by issuing the following
command:
db2 list applications show detail

4. Back up the database that contains the Hyperion Planning Repository tables
by issuing a command similar to the following:
db2 backup database MyDB to C:\\

where MyDB is the name of your database, and C:\\ is the location where the
backup should be saved.
5. Repeat this procedure to backup the Hyperion Reports repository tables.

Backing Up an Oracle Repository


This section contains an example for backing up an Oracle Repository. This is only
an example. Refer to your Oracle documentation for detailed information on
performing database backups, or contact your Oracle administrator.

➤ To back up repository tables for Oracle:


1. Open a Windows command prompt or UNIX shell as a user with access to the
Oracle client software.

Hyperion Planning Administrator’s Guide ■ 81


Creating an Application

2. Export the Hyperion Planning repository tables using the exp command. Type
exp –HELP for a list of command parameters.
For example:
exp SYS@TNS_ENTRY FILE= C:\Temp\hr_expdat.dmp LOG=
C:\Temp\hr_expdat.log OWNER=HR_OWNER GRANTS=Y INDEXES=Y
ROWS=Y CONSTRAINTS=Y

Parameter Description
SYS The Oracle user with permission to export another user’s tables
(you can use a different account)
TNS_ENTRY The TNS alias defined in tnsnames.ora (set up via Net8 Assistant)
for the Oracle Instance containing the Hyperion Planning
Repository
FILE The absolute path to the file that contains the backup
LOG The absolute path to the file where output from exp is logged
OWNER The name of the Oracle user that owns the Hyperion Planning
Repository tables

3. Repeat this procedure to back up the Hyperion Reports repository tables.

Backing Up the Required Components of Hyperion


Planning
For a complete restoration of all applications, you must back up all the UDL files
associated with the applications. To do this, you copy the UDL files into the backup
directory. In addition to the UDL files, you must also back up all the spreadsheets
associated with the applications that you want to restore at a later time.
● To back up registry entries, export the registry key entries under
‘HKEY_LOCAL_MACHINE\Software\Hyperion Solutions’, and save it
in the backup directory.
● To restore registry entries, import the stored registration file into the registry
from the backup directory.

82 ■ Hyperion Planning Administrator’s Guide


Creating an Application

Backing Up Hyperion Application Link


There are no specific backup procedures for Hyperion Application Link. Hyperion
Application Link data should be imported to Hyperion Planning or Hyperion
Essbase and the backup procedures for those applications should be followed to
back up data.
Before opening an integration created with an earlier version of the Hyperion
Planning Adapter, make a back up copy of the integration (.prp) file.
3
Note: Once the integration is opened and run or saved with the new version of the
Adapter, it can no longer be used with the old version.

Backing Up Hyperion Business Rules


There are no specific backup procedures for Hyperion Business Rules. To back up
user data, the Hyperion Essbase data and the database where the Hyperion
Business Rules repository is located should be backed up.
● For backing up Hyperion Essbase, follow the Hyperion Essbase backup
instructions (see “Backing Up the Application in Hyperion Essbase” on
page 79).
● For backing up the Hyperion Business Rules repository, follow database
specific backup procedures. For Microsoft Access, backup the .mdb file. For
other relational databases, follow the standard backup procedures for the
specific database.

Hyperion Planning Administrator’s Guide ■ 83


Creating an Application

84 ■ Hyperion Planning Administrator’s Guide


Chapter Moving and Copying

4 Applications

This chapter details the steps and considerations for moving a Hyperion Planning
application from one server to another (for example, moving from a test
environment to a production environment) or copying and renaming an application
on the same server. 4

Migrating an Application
To migrate an application means to move it to a different environment while
keeping its name intact.
This topic assumes the following:
● Each environment already has all the necessary components installed.
● The test and production environments exist on the same domain and contain
the same users.

Migrating a Hyperion Planning Application


➤ To migrate a Hyperion Planning application:
1. Find the application owner of the application you want to migrate.
To do this, look at the relational database table
HSP_HYPPLAN_SECHEADER, where HYPPLAN is the name of the
application. This table contains one entry that has the application owner’s
name.

Note: When migrating an application, it is important that the application owner be


a domain account and not a local computer account. If the account is a local
machine account, you should change the application owner in the Hyperion
Planning application to a domain account.

Hyperion Planning Administrator’s Guide ■ 85


Moving and Copying Applications

2. Create a new Hyperion Planning application on the production Hyperion


Planning server (PRODPLAN) and name the application PLNTEST.
Keep in mind to create the application as the domain user that owns the
existing application in the development environment.
3. Perform an application Refresh so that the application is pushed to Hyperion
Essbase.
4. Open the newly created PLNTEST application in the production environment
and add users to the application.
For information on adding users, see “Setting Up Users” on page 111.

Tip: The PLNTEST application is created only for the purpose of adding users to
Essbase. Users are added to Essbase as soon as they are imported or added with
the Users tab on Hyperion Planning Web.

5. Refresh the database from the Manage Database task on the development
server.
Verify that no records exist in the HSP_PENDING_EXACTS relational
database table for the application. Make a backup of the relational database for
the development application (for example, hypplan.bak). Create a new
relational database on the production server (for example, HYPPLANDB) and
restore the development database to a new database in the production
environment.
6. Create a UDL (PLANPROD.UDL) and a DSN (PLANPROD) for the
application.
Verify that the PLANPROD.UDL points to the new HYPPLANDB database
and the DSN uses PLANPROD.UDL.
7. Open the Hyperion Planning system database and open the table
HSX_DATASOURCE.
8. Insert a new row into the table.
9. Add the product name (PLANNING), application name (HYPPLAN),
description, and DSN (PLANPROD).

Note: The application name is the name that displays in the HSP_[APPLICATION
NAME]_ROLEACCESS table in the restored relational database.

10. Log on to Essbase Application Manager on the production server and create
an application named HYPPLAN.

86 ■ Hyperion Planning Administrator’s Guide


Moving and Copying Applications

11. Note the user that has the same name as the application owner, with the
addition of an underscore at the end of the user name. Make this user an
Application Designer of the application.
12. Open Hyperion Planning and open the application.
13. Use the Manage Database task to create the Essbase outline.

Note: If you have custom Essbase outlines (.otl), calc scripts (.csc), or load rules
(.rul), you can stop the Essbase application and copy the files to Essbase. You can
then load any data from the development application. Selecting Create from the
Manage Database task overwrites all .otl, .csc, .rul, and data values that exist in the
database. If any of these files have been copied from the development server, you
should only select to Refresh the database on the production server. Otherwise,
the files need to be copied from the development server again.
4
Migrating Hyperion Business Rules Data
➤ To migrate Hyperion Business Rules data:
1. Configure the production business rules repository.
2. Restore the development business rules repository over the new production
business rules repository.
3. In the restored database, locate the HBR_ALLOCPROCS table.
The server field contains the name of the Essbase server. Change the server
field from the development Essbase server to the production Essbase server.
4. Open each business rule on the production server and apply the appropriate
security rights.

Migrating Hyperion Reports


➤ To migrate Hyperion Reports data:
1. Configure the production reports server and make sure you can create and run
a sample report.
2. Restore the development reports relational database over the production
reports relational database.
3. On the development server, run the following program:

Hyperion Planning Administrator’s Guide ■ 87


Moving and Copying Applications

C:\Program Files\Hyperion Solutions\Hyperion


Reports\bin\ViewRegistry.cmd

Note: The location of this program may vary, depending on where you installed
Hyperion Reports.

4. Navigate to HKEY_LOCAL_MACHINE\Common
Components\HAAS\SecurityInfo\HsSecurityAdmin and make note of
the HsSecurityAdmin Schema ID value.
5. Navigate to HKEY_LOCAL_MACHINE\Common
Components\HAAS\ManagedServices\HsAuthenticator\Security
Info\HsSecurityAdmin and make note of the HsSecurityAdmin
SchemaID value.
6. Close the registry editor.
7. On the production server, run the following program:
C:\Program Files\Hyperion Solutions\Hyperion
Reports\bin\ViewRegistry.cmd

Note: The location of this program may vary, depending on where you installed
Hyperion Reports.

8. Navigate to HKEY_LOCAL_MACHINE\Common
Components\HAAS\SecurityInfo\HsSecurityAdmin and change the
HsSecurityAdmin Schema ID value to the value on the development server.
9. Navigate to HKEY_LOCAL_MACHINE\Common
Components\HAAS\ManagedServices\HsAuthenticator\Security
Info\HsSecurityAdmin and change the HsSecurityAdmin SchemaID
value to the value on the development server.
10. Select File > Save.
11. Select File > Exit.
12. Restart the Hyperion Reports server.

88 ■ Hyperion Planning Administrator’s Guide


Moving and Copying Applications

Copying a Hyperion Planning Application


To set up an application more quickly, you can copy an existing application to the
same application server. Because the new application will run on the same
application server, you must give it a different name. The name of the new
application can be a maximum of eight characters.
You cannot copy an application and then use the application on a server that does
not recognize the users in the original application.

Note: For information on migrating an application from one application server to


another, see “Migrating an Application” on page 85.

If you have calculation scripts or member formulas in the application you are
copying, see the Hyperion Essbase documentation for information on copying 4
these components.
The following procedures is based on copying a Microsoft SQL application.

➤ To copy a Hyperion Planning application, do the following:


1. Back up the relational database to which the application is connected.

Note: The .UDL file connects a relational database to an application. You must
make a complete backup of the database.

For information on backing up SQL, Oracle, and DB2 databases, see “Backing
Up Applications and Application Databases” on page 78.
2. Create a new relational database for the new application.
See “Installing and Creating a Relational Database” in the Installation Guide.
3. Restore the backup of the original application to the new database repository.

Note: When you restore the backup to the new database, you may get an error that
physical files cannot be overwritten because they are in use by the original
application. In this case, you need to rename the physical file names for both Data
and Log files to reflect the name of the new database.

4. Create and configure a UDL pointing to the new relational database.

Hyperion Planning Administrator’s Guide ■ 89


Moving and Copying Applications

See “Creating the Microsoft Data Link UDL” in the Installation Guide.

Figure 1: Data Link Properties Dialog Box

5. Create and configure a data source pointing to the new relational database.
See “Creating a Data Source” in the Installation Guide.
6. Create a new entry for the application in the HSX_DATASOURCES table by
doing the following:
a. Open the HSX_DATASOURCES table and insert a new line.

Note: This table is found in the database to which the .UDL links the
application.

90 ■ Hyperion Planning Administrator’s Guide


Moving and Copying Applications

b. In the new line, enter information into the following fields: Product,
AppName, Description, and DSN.
c. Close or commit the table after you edit it.
7. Open Essbase Application Manager and connect to the Essbase server to
which the DSN is pointing.
8. Create an Essbase Application for the new application.

Note: Users on the Essbase server that hosts the original application need to
already be defined on the Essbase server for the new application.

9. In Essbase security, modify the underscore user for the application owner of
the original application to be the App Designer for the new application.
10. Open the new application in Hyperion Planning and refresh to Essbase.
4
Note: If Essbase outlines have been copied to the new application, perform a
Cube Refresh. If Essbase outlines have not been copied to the new application in
Essbase, perform a Cube Create.

You need to run HSPsetupsupport to display the new application on the Web.

Hyperion Planning Administrator’s Guide ■ 91


Moving and Copying Applications

92 ■ Hyperion Planning Administrator’s Guide


Chapter Setting Up Security

5
This section describes how to set up and enable the authentication providers that
Hyperion Planning supports, how to add users and groups to an application, and
how to assign access rights to those users and groups.
5
About Access Rights and Security
Security and access rights enable you to control access to Hyperion Planning
applications and application elements. Setting up security lets you protect data and
prevent unauthorized users from changing data. For example, you can restrict
access to certain data elements or forms within an application.
Security exists at two levels:
● Authentication by an external provider. For more information, see “About
External Authentication Providers” on page 93.
● Hyperion Planning security, in which users and groups are assigned to
applications and application elements. For more information, see “Setting Up
Users” on page 111, “Setting Up Groups” on page 119, and “Assigning
Access Rights” on page 123.
Before using Hyperion Planning, you must also configure the application’s
Distributed Component Object Model (DCOM) settings. For more information,
see “Configuring DCOM” on page 105.

About External Authentication Providers


Authentication confirms the identity of each user by matching a user name to a
password. Hyperion Planning determines whether a user can access applications
by relying on any of these external authentication providers:

Hyperion Planning Administrator’s Guide ■ 93


Setting Up Security

● Microsoft Windows NT LAN Manager (NTLM). By default, Hyperion


Planning supports NTLM authentication. If you plan to use NTML
authentication, see “About Windows NT LAN Manager (NTLM)” on page 94
and follow the instructions in the Hyperion Planning Installation Guide on
assigning rights.
● Lightweight Directory Access Protocol (LDAP) using iPlanet. If you plan to
use LDAP authentication, see “About LDAP Authentication” on page 95.
● Microsoft Active Directory (MSAD). If you plan to use MSAD
authentication, see “About LDAP Authentication” on page 95.
External authentication providers create the following:
● Users and their passwords
● Groups of users
● Authentication (setting user policies and access rights)
Administrators can then assign roles and access to the users from these repositories
into Hyperion Planning applications. Groups that are created outside of Hyperion
Planning cannot be directly added to Hyperion Planning applications.

About Windows NT LAN Manager (NTLM)


By default, Hyperion Planning supports Microsoft Windows NT LAN Manager
(NTLM) security. The Microsoft Windows operating system’s security subsystem
creates and manages the repository.
In Microsoft Windows Server, users and groups are organized by domains. A
domain is an administrative grouping of networked computers and all the
associated users and resources. The domain controller computer in a domain stores
and authenticates all users in the domain for network resource access. This means
the user and password database is stored and managed by the domain controller
computer.
For large installations, you can organize multiple domains in one or more trusted
relationships. This enables all users in one domain to access resources in another
domain. This provides a degree of separation between the functions of
user-account administration and resource management.
For example, you have users in New York on domain A, users in Boston on domain
B, and the server is located in Washington on domain C. A trust relationship must
exist between the server on domain C and all other domains (in this case, domain
A and domain B). Users on domain A and B must be able to log on to domain C

94 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

to be added to Hyperion Planning applications. However, it is not necessary for


those users to be able to access the server on domain C through a Microsoft
Windows interactive logon.
Typically, Microsoft Windows security is configured by an IT professional at your
company. For more information about setting up Microsoft Windows security, see
the Hyperion Planning Installation Guide.

About LDAP Authentication


By default, Hyperion Planning supports NTLM authentication. To use or enable
LDAP authentication (using iPlanet or Microsoft Active Directory), you need to:
1. Select the installation option LDAP Authentication when installing Hyperion
Planning. For more information, see the Hyperion Planning Installation 5
Guide.
2. Configure and rename the CSS.PROPERTIES.SAMPLE file. To
authenticate users against LDAP providers, you need to edit and rename this
sample property file. For more information, see “Configuring for External
Authentication” on page 95.
3. Enable LDAP authentication by running the HsxSysAdmin.msc file and
entering the name of the modified CSS.PROPERTIES file. For more
information, see “Enabling LDAP Authentication” on page 105.

Note: The documentation refers to the edited and renamed


CSS.PROPERTIES.SAMPLE file as CSS.PROPERTIES. If you have named the modified
file something else, substitute that file name.

Configuring for External Authentication


When installing Hyperion Planning, if you selected the option LDAP
Authentication, a file called CSS.PROPERTIES.SAMPLE was installed. To
authenticate users against LDAP providers, you need to edit key-value pairs in the
sample properties file and rename the file. It is installed in \Program
Files\Hyperion Solutions\Hyperion Planning\CSS.
This file contains three configuration sections, for NTLM, LDAP, and MSAD. For
each supported authentication provider, there are one or more properties to edit in
the CSS.PROPERTIES.SAMPLE file, depending on the deployment scenario. The
properties specify:

Hyperion Planning Administrator’s Guide ■ 95


Setting Up Security

● The location of the authentication provider’s Java classes that will act as
Authentication Factories for supporting NTLM, LDAP, and MSAD
repositories.
● The location of the authentication provider’s Java classes that will act as a
User Group Factory for user and group creation, deletion, renaming, and
updating.
● The search order to use. Search order specifies the order (in terms of named,
supported authentication repositories) in which to search for the existence of
a user when multiple authentication repositories are used.
Instructions for, and examples of, modifying the file are included in the properties
file.

Note: We recommend that you include the path to the CSS.PROPERTIES file in the
application server CLASSPATH.

Editing the Application Properties


➤ To configure the properties file for external authentication:
1. Rename the file CSS.PROPERTIES.SAMPLE to CSS.PROPERTIES.
The CSS.PROPERTIES.SAMPLE file is located in the folder Program
Files\Hyperion Solutions\Hyperion Planning\CSS.

Note: The documentation refers to the edited and renamed


CSS.PROPERTIES.SAMPLE file as CSS.PROPERTIES. If you name the modified
file something else, substitute that filename in the instructions.

2. In a text editor, open the file CSS.PROPERTIES, located in the folder


Program Files\Hyperion Solutions\Hyperion
Planning\CSS.
3. Skip this step unless you plan to use multiple LDAP providers: In the
section # Authentication Factory, identify each provider by a name
(by default, ldap and msad).

Note: You may modify the bolded configuration names in the following example
(ldap and msad). You may rename them (for example, to ldap1 and ldap2), but
if you do, you must consistently use the modified configuration names in the
subsequent examples.

# Authentication Factory

96 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

com.hyperion.css.factory.auth.ldap =
com.hyperion.css.spi.impl.LDAPAuthenticationFactory
com.hyperion.css.factory.auth.msad =
com.hyperion.css.spi.impl.LDAPAuthenticationFactory

Note: If you are using iPlanet, you must specify LDAPAuthenticationFactory in the
above section. If you are using Microsoft Active Directory, you must specify
MSADAuthenticationFactory in the above section.

4. Skip this step unless you plan to use multiple LDAP providers: Under #
UserGroup Factory, identify each configuration by a name, as in the
previous step.
Configuration names to modify are suggested by the use of bold in the
following example:
5
# UserGroup Factory
com.hyperion.css.factory.userGroup.ldap=
com.hyperion.css.spi.impl.LDAPUserGroupCRUDFactory
com.hyperion.css.factory.userGroup.msad=
com.hyperion.css.spi.impl.MSADUserGroupCRUDFactory

Note: If you are using iPlanet, you must specify LDAPUserGroupCRUDFactory in


the above section. If you are using Microsoft Active Directory, you must specify
MSADUserGroupCRUDFactory in the above section.

5. Under # Search Order, define the search order.


The search order provides the external authentication mechanism with the
ability to access multiple data stores in a sequential manner.

Note: The first character in the string, ?, is used to separate the named provider
from the URL specified for the directory. The second character, (, is used to
separate the authentication repository designations in the search order.

The following example specifies a search order that is subsequently described.


You must include the domainComponent attributes (DCs) in the URL.
Sections in italics represent server information to be filled in.
com.hyperion.css.searchOrder =
?(msad?ldap://msad_server:389/DC=msad-dc,DC=hyperion,DC=
com(ldap?ldap://ldap_server:390/dc=ldap-dc, dc=hyperion, dc=
com(ntlm?hyperion
This example can be translated as follows:

Hyperion Planning Administrator’s Guide ■ 97


Setting Up Security

Access external repositories in the following order and by searching the


following roots:
a. For a configuration named msad, search the Microsoft Active Directory
repository at the URL ldap://msad_server:389/DC=msad-dc, DC=
hyperion, DC=com.
b. For a configuration named ldap, search the LDAP repository at the URL
ldap://ldap_server:390/DC=ldap-dc, DC=hyperion, DC=com.
c. Put the NTLM repository last in the search order.
For more information, see “Search Order for Users” on page 111.
6. Rename the logger.properties.sample file included in the CSS
directory to logger.properties. Configure access for using log4j as the
logging system in the logger.properties file, as documented by the
Jakarta Project. Make sure that in the CSS.PROPERTIES file, the property
com.hyperion.css.logger.properties gives the full path to the actual
location of the logger.properties file.
7. Modify the other required properties.
See “When the Web Application Server is Installed on a UNIX System” on
page 98 or “Modifying Properties for LDAP or MSAD” on page 102.
8. Enable LDAP authentication by running the HsxSysAdmin.msc file and
entering the name of the modified CSS.PROPERTIES file. For more
information, see “Enabling LDAP Authentication” on page 105.
9. Restart the application server.

When the Web Application Server is Installed on a UNIX


System
How you set up security on a system in which the Web application server is
installed on a UNIX computer depends on:

Type of Authentication Used Follow These Instructions


NTLM only “Configuring NTLM Authentication”
on page 99

98 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Type of Authentication Used Follow These Instructions


NTLM and LDAP • “About LDAP Authentication” on
page 95
• “Configuring the Properties File” on
page 100
• “Configuring the NTLM
Authentication Server” on page 101
LDAP Steps 4 and 5 in “Configuring the
Properties File” on page 100

This topic shows how to modify the properties files to support systems in which 5
the Web application server is installed on a UNIX computer that accesses
information stored in a Windows NT LAN Manager repository. For such a
cross-platform configuration to work, you need a Windows NT or Windows 2000
server running the remote NTLM provider. Use of the remote NTLM provider
requires a Java installation that includes the Java Remote Method Invocation
(RMI) server. The RMI server is included in the Java 2 Standard Edition. More
information about RMI servers can be found at
http://java.sun.com/products/jdk/rmi/.

Configuring NTLM Authentication


To use NTLM authentication as your sole authentication provider when your Web
application server is installed on a UNIX system, you need to add the
authentication server name to the HspJSHome.Properties file that the
HspSetupSupport utility creates.

➤ To modify the HspJSHome.Properties file:


1. With a text editor, open the HspJSHome.Properties properties file.
The location of the HspJSHome.Properties file depends on your application
server. Here is a sample location: Program Files\Hyperion
Solutions\Hyperion Planning\web\web-inf\lib

2. Add the authentication server name or IP address that appears after the APP
Server type line. Here is an example that uses a WebLogic application server
type:
APP_SERVER_TYPE=WebLogic

Hyperion Planning Administrator’s Guide ■ 99


Setting Up Security

AUTHENTICATION_SERVER=<server name or IP address>

where the server name or IP address is the Windows machine where Hyperion
Planning installed the application server files.

Note: If DNS is not set up properly, you may also have to enter an IP address for
the OLAP server and JDBC.

3. Run the Authentication Server.


It is located in Program Files\Hyperion Solutions\Hyperion
Planning\Deployment\Authentication Server\AuthSrvr.bat.

4. Save and upload the modified HspJSHome.Properties file to the application


folder (for example, web-inf\lib) on the UNIX machine.
5. Update the CLASSPATH by uploading the following to the web-inf\lib
folder on the UNIX machine: db2java.zip.

Configuring the Properties File


The CSS.PROPERTIES file must reside on the UNIX computer, and the
ntlm.rmi.url property of the file needs to be modified to tell the system where
to find the remote NTLM authentication server. The remote NTLM authentication
server is implemented using the Java Remote Method Invocation (RMI) server,
which is included in Java 2 Standard Edition.

Note: The CSS.PROPERTIES file on the UNIX system and on the Windows system
must be identical. If the LOGGER.PROPERTIES file is not included in the CLASSPATH,
then only the paths to LOGGER.PROPERTIES should be different.

Note: If you are using only LDAP authentication, you can skip steps 1 through 3.

➤ To configure the CSS.PROPERTIES file for a UNIX system to use NTLM


authentication:
1. In a text editor, open CSS.PROPERTIES (or the file that was renamed from
CSS.PROPERTIES.SAMPLE).
2. Under the comment header # NTLM, modify the property ntlm.rmi.url to
point to the RMI registry name, using the format
//machinename:port/rmiservername

100 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

where machinename is the name of the computer running the remote NTLM
provider (the default is localhost if left blank), port is the port number (the
port default is 1099 if left blank), and rmiservername is the name given to
the RMI server.

Note: Rmiservername is always set to NTLMImpl in this release.

For example, the following entry might be valid for this property:
ntlm.rmi.url = //myNTserver2/NTLMImpl

3. If the application server CLASSPATH does not point to the location of the
logger.properties file, modify the logFileProps property to indicate
the full path to the logger.properties file.
The logger.properties file is included in the CSS directory. The file 5
requires configuration as documented by the Jakarta Project for using log4j as
the logging system.

Note: We recommend that you leave the LOGGER.PROPERTIES and the


CSS.PROPERTIES files in the CSS directory.

4. Save and upload the CSS.PROPERTIES file to the UNIX server and to the
Windows server.
5. Rename the LOGGER.PROPERTIES.SAMPLE file to LOGGER.PROPERTIES
and upload it to the UNIX and the Windows servers.

Configuring the NTLM Authentication Server


The NTLMConnectionServer.properties file must reside on the Windows
NT or Windows 2000 server where the remote NTLM authentication provider is
installed.

➤ To configure the remote NTLM provider:


1. In a text editor, open the file
NTLMConnectionServer.properties.sample.
2. Save the file to the CSS directory under Hyperion Planning, renaming it
NTLMConnectionServer.properties.

Note: You must use this exact name.

Hyperion Planning Administrator’s Guide ■ 101


Setting Up Security

Modifying Properties for LDAP or MSAD


This section shows how to modify the properties that apply to configuring the
provider implementations for Lightweight Directory Access Protocol (LDAP)
using iPlanet or Microsoft Active Directory (MSAD) on Windows NT or Windows
2000.
Follow the instructions in these topics:
● “Configuring the Authentication Provider” on page 102
● “Configuring the User Provider” on page 104

Configuring the Authentication Provider


➤ To configure the authentication provider:
1. In a text editor, open CSS.PROPERTIES (or the file that was renamed from
CSS.PROPERTIES.SAMPLE).
2. Locate the section that deals with LDAP authentication or MSAD
authentication, depending on which configuration you want to use.
If you want to use both, you need to follow these instructions once for each
section. The comment headers for each section are:
# This is the LDAP authentication provider properties
# This is the MSAD authentication provider properties

3. Optional: Modify the user.url property to indicate the branch in the


directory server that contains user definitions.
The user.url property is relative to the URL specified in the search order
you defined in step 5 on page 97. If you want the authentication provider to
search the whole directory specified by the URL in the search order, then
comment out this property.
For example, if users for the provider named ldap are stored in an LDAP
Organizational Unit directory named People, the following sample is correct:
ldap.user.url = ou=People
4. Modify the loginAttribute property to point to an attribute in the directory
through which a user entry can be discovered.

102 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

The attribute can be part of the DN, such as uid or cn, or it can be a
customized extension of the corporate LDAP schema, such as employee_ID,
or any other attribute in the directory node of a particular user.
The following sample property states that for the LDAP repositorY, which we
have given a provider name of ldap, the user names in which we are interested
are using the “user id” attribute:
ldap.loginAttribute = uid

Note: We recommend using uid as the loginAttribute and the


nameAttribute property.

The entry above is correct if it is true that all directory server user names are
identified by uid = UserName. The following example shows Autumn 5
Smith in the LDAP browser view of a Microsoft Active Directory store:

The above example highlights a subset of the DN. However, the


loginAttribute property may instead refer to an attribute under the
directory node for the user; for example, loginAttribute may point to uid,
shown in the following entry detail:

5. For each named provider, modify the userDN and password properties with
an actual user account having read-only access to the directory stores.

Note: This step is required because the external authentication functionality


requires read-only access to search user trees in the directory stores.

For example, modify the parts indicated by bold in the following:


ldap.userDN = uid=Fully Qualified Name
ldap.password = user_password

msad.userDN = uid=Fully Qualified Name

Hyperion Planning Administrator’s Guide ■ 103


Setting Up Security

msad.password = user_password

Note: ldap and msad are bolded because they are sample provider names. If the
directory allows anonymous binding, the values on the right of the equal signs can
be left empty.

6. Save the file in the CSS directory.

Configuring the User Provider


➤ To configure the user provider:
1. In a text editor, open CSS.PROPERTIES (or the file that was modified and
renamed from CSS.PROPERTIES.SAMPLE).
2. Because Hyperion Planning does not support external groups, you need
modify only the nameAttribute property under these comment headers:
# This is the LDAP UserGroup provider properties
# This is the MSAD UserGroup provider properties

Modify the nameAttribute property to point to an attribute in the directory


through which a user entry can be discovered.

Note: The nameAttribute property must match exactly the value of the
loginAttribute property described in step 4 on page 102.

The following sample property states that for the directory store named ldap,
the relevant user names are using the Common Name attribute:
ldap.nameAttribute = uid
This entry is correct if all directory server user names are identified by uid =
UserName, as is Jane Doe in the following LDAP browser view of a directory
store:

This example highlights a subset of the DN. However, the nameAttribute


property can alternately refer to an attribute under the directory node for the
user. For example, nameAttribute might point to uid, shown in the
following entry detail:

104 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

3. You do not need to modify the other properties in this section.


4. Save the file in the CSS directory.

Enabling LDAP Authentication


After you have configured the CSS.PROPERTIES file, you must provide the
name of the CSS Property file to the HsxSysAdmin file. Until you do this,
support for LDAP authentication is not enabled for Hyperion Planning.
5
➤ To enable LDAP authentication:
1. On the computer hosting the Hyperion Planning server, run the
HsxSysAdmin.msc file.
By default, this file is located in C:\Program Files\Hyperion
Solutions\Hyperion Planning\Server.
2. In the left frame of the Microsoft Management Console window, expand the
Server Admin folder and click System Properties.
3. In the right frame of the Microsoft Management Console window:
a. Right-click CSS Properties.
b. In the CSS Property Name text box, type the name you gave to the
modified CSS.PROPERTIES file.
Hyperion Planning can now access the external authorization configurations
you set up in the CSS.PROPERTIES file.

Configuring DCOM
Before using Hyperion Planning, the application server’s Distributed Component
Object Model (DCOM) settings must be configured. DCOM enables
network-based component interaction and enables sharing of processes across a
network. With DCOM, components operating on a variety of platforms can
interact, as long as DCOM is available within the environment. The following
items are set using DCOM security:

Hyperion Planning Administrator’s Guide ■ 105


Setting Up Security

● Authorization level
● Access and launch permissions
● Identity
Typically, DCOM security is configured by an IT professional at your company.
For more information about setting up DCOM security, see the Hyperion Planning
Installation Guide.

About Hyperion Planning Security


Hyperion Planning security determines a user’s privileges in Hyperion Planning.
Users are people who are granted access to the Hyperion Planning application.
Groups are sets of users, based on similar access rights needs. After users and
groups are defined, you can assign their appropriate access rights to various
application elements. For example, you can assign a user or group access to Entity
dimension members, forms, and so on.
Access rights for users and groups can vary from one application to another. You
must first create and open an application before you can define users and groups,
and assign access rights. Access rights for users and groups can be assigned to the
following application elements:
● Scenario dimension members
● Version dimension members
● Account dimension members
● Entity dimension members
● User-defined custom dimension members
● Data entry forms
After you establish or update user and group security, the Hyperion Planning
application needs to be refreshed to complete the update to Hyperion Essbase
security filters. However, before doing this, you can validate that the size of the
security filters does not exceed the Hyperion Essbase limit of 4 KB per row. For
more information about validating the security filters, see “Creating Application
Databases” on page 67. Additionally, if you need to update only a few user security

106 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

filters, you can do that with the Implement Security task. For more information
about updating individual user security filters, see “Implementing User Security”
on page 116.

Note: Hyperion Business Rules can also be secured, but currently it supports only
individual users, not Hyperion Planning groups.

User Types
Hyperion Planning supports four types of users: administrators, interactive users,
planners, and view users. The administrator user type also contains a super-user
type called the application owner.
5
Administrator
Users who are designated as administrators can perform any task in the application
and during financial processes, except delete the application or claim ownership of
an application. The administrator who is designated as the application owner is the
only user who can delete an application. Administrators can perform the following
types of tasks:
● Create applications.
● Manage security.
● Maintain metadata.
● Initiate and manage the budget process.
● Designate the e-mail server for e-mail notification.
● Create and maintain Web-based data entry forms.
● Create and maintain Spreadsheet Add-in worksheets.
● Create and maintain reports using Hyperion Reports.
● Create and launch adapter processes using Hyperion Application Link.
● Create and launch business rules using Hyperion Business Rules.
● Enter and view data.
● Initiate the budget process (for example, start planning units).

Hyperion Planning Administrator’s Guide ■ 107


Setting Up Security

Setting Up Multiple Administrators for an Application


with One Owner
Hyperion Planning allows you to designate more than one administrator per
application. This ability facilitates the delegation of maintenance across large
applications. An application owner always exists, because he or she is the only
administrator who can delete an application. Other administrators who are
assigned to an application can perform all tasks except deleting an application,
deleting the application owner, or claiming ownership for themselves or another
user. The initial owner of the application is the administrator who created the
application. The application owner can later reassign ownership of the application
to another user.
When the Manage Database task is in use by an administrator, all other tasks are
unavailable to other users, including the application owner. Conversely, when any
other task is open, the Manage Database task is unavailable to all users. This
maintains consistency between the data in the relational database and the Hyperion
Essbase database.

Interactive User
Interactive users can perform the following tasks:
● Enable e-mail notification (for themselves only).
● Create and maintain Web-based data entry forms.
● Create and maintain Spreadsheet Add-in worksheets.
● Create and maintain reports using Hyperion Reports.
● Create and launch adapter processes using Hyperion Application Link.
● Create and launch business rules using Hyperion Business Rules.
● Enter and view data.
● Submit information and data for approval. They can then control this process,
sign off, reject, pass plans to another level, verify the plans with other parts of
the organization, and so on. For example a sales director may collect all the
planning information for sales managers. Before signing this off, a
manufacturing director can review new forecasts based on production
capacity.

108 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Interactive users cannot create and maintain applications, dimensions, exchange


rates, or users or access rights assignments. Examples of interactive users are
department heads, sales directors, and business unit managers.

Planner
In most cases, planners comprise the majority of users. Planners can perform the
following tasks:
● Enable e-mail notification (for themselves only).
● Input, submit, and view data.
● Use reports that have been built by others.
● Run data integration routines designed by others. 5
● Execute business rules and other processes associated with validating and
preparing data.
● Use Hyperion Planning Spreadsheet Add-in.
● Use any data access tools for which they are licensed (for example, Hyperion
Analyzer).
● Submit information and data for approval. They can then control this process,
sign off, reject, pass plans to another level, verify the plans with other parts of
the organization, and so on.
Planners are subject to the restrictions placed on interactive users. In addition,
planners cannot create and maintain reports, adapter flow diagrams, or business
rules.

View Users
View users are a subset of planners and can only view data. Typically, this type of
user is an executive who wants to see business plans during and at the end of the
budget process. View users can use any data access tool for which they are
licensed; for example, Hyperion Web Client, Hyperion Reports, Hyperion
Planning Spreadsheet Add-in, Hyperion Analyzer, and so on.
View users are often set up through a user group. That group is then given read
access to various combinations of dimensions.

Hyperion Planning Administrator’s Guide ■ 109


Setting Up Security

User Types and Tasks


The following table lists Hyperion Planning tasks and the corresponding users who
can perform the tasks.
Table 1: User Types and Tasks Matrix

Interactive
Tasks Administrator User Planner View User

Create new X
applications
Modify applications X
Submit plans X X X
Create and modify X X
Web forms
Create and update X X
rules in Hyperion
Business Rules
Create and update X X
Hyperion
Application Link
flow diagrams
Run Hyperion X X X
Application Link
flow diagrams
Data entry X X X
View data through X X X X
Hyperion Planning
Web forms
View data through X X X X
Hyperion Reports
Create data using X X X
the Hyperion
Planning
Spreadsheet Add-in

110 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Table 1: User Types and Tasks Matrix (Continued)

Interactive
Tasks Administrator User Planner View User

Analyze data using X X X X


the Hyperion
Planning
Spreadsheet Add-in

Setting Up Users
Hyperion Planning security determines a user’s data and access rights in Hyperion
Planning. You set up users in a Hyperion Planning application on the Web using 5
the Users tab, which is accessed from Administration link.
User names and passwords are managed by an external authentication provider, so
they must be created externally—using NTLM, LDAP, or MSAD—before they are
added in Hyperion Planning applications. You can then add users to the Hyperion
Planning application from the Users tab on the Web (see “Adding Users From the
Web” on page 112), or you can import them using a batch utility (see “Importing
Users With a Utility” on page 113).
By default, when users are added, they are added as planners, with planners’ access
rights. To access specific elements in Hyperion Planning (for example, a data entry
form), they must specifically be assigned access rights or inherit access rights by
being part of a group that is assigned access rights. If an individual user is assigned
to a group, and the access rights of the individual user conflict with those of the
group, the individual user’s access rights take precedence.

Search Order for Users


When you add or import users into an application, Hyperion Planning searches for
the first occurrence of a match using this logic:
If LDAP Authentication is not installed and enabled, Hyperion Planning searches
for users based on NTLM’s internal search order:
– The local Hyperion Planning application server.
– The domain that the Hyperion Planning application server belongs to.
– The domains in trusted relationships with the domain that the Hyperion
Planning application server belongs to.

Hyperion Planning Administrator’s Guide ■ 111


Setting Up Security

If LDAP Authentication is installed and enabled, Hyperion Planning searches for


users based on the search order in the CSS.PROPERTIES file (which IT
configured). Note that NTLM may be one of the specified providers in the search
order. In this case, see its internal search order, above. For more information, see
“Configuring for External Authentication” on page 95.

Adding Users From the Web


From the Add User page, you add users and set their user types. You can also
enable sharing of a the user’s password with Essbase.

Note: To add many users at once, we recommend importing them with a utility. For
more information, see “Importing Users With a Utility” on page 113.

➤ To add a user:
1. In the Value text box, type the user name you want to add.
If you are using NTLM authentication on the local computer, type the user
name without the domain. Otherwise, separate the domain name and user
name with a backslash (for example, domain\user).
If you are using LDAP authentication, match the attribute specified in step 2
in “Configuring the User Provider” on page 104 (for example, Jane Doe).
For information on how Hyperion Planning searches for the user, see “Search
Order for Users” on page 111.
2. Select or clear the Share Password (with Essbase) check box.
Selecting this option enables the password that is set up for the user in
Microsoft Windows to be used in both Hyperion Planning and Hyperion
Essbase. For more information about shared passwords, see “Modifying
Passwords” on page 122.
3. In the User Type area, select a user type.
You can define the user’s role as a planner, interactive user, or administrator.
If you are the current owner of the application and select Administrator as the
user type, you can designate the user as the application owner. For more
information, see “User Types and Tasks” on page 110.
4. Click OK.

112 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Importing Users With a Utility


To add a large number of users to a Hyperion Planning application, we recommend
that you import them from a text file, using the ImportUsers utility that is
included with Hyperion Planning.

Creating the Text File


You can create a text file that defines the users to import in a variety of ways:
manually typing in the values, cutting and pasting the information from another
source, or writing a utility to export them.
Each line of the text file must include these three pieces of information, separated
by a comma:
5
● Source\username (for example, hyperion\bsmith). For information on how
Hyperion Planning finds and matches users, see “Search Order for Users” on
page 111. For information on how user names are specified, see
● Whether or not to synchronize the user’s password with Essbase (true or
false)
● The user’s role in the application:
0 = administrator
1 = planner
2 = interactive user
3 = application owner
Example
sunnyvale\user1,true,1
stamford\user2,false,3
paris\user3,true,2

Hyperion Planning Administrator’s Guide ■ 113


Setting Up Security

Importing Users
After you have created a text file that defines the users to import, you can import
them into a Hyperion Planning application. You must run the ImportUsers utility
from the computer where the application server is installed. For information on
how Hyperion Planning searches for users, see “Search Order for Users” on
page 111.

Note: If you are using a DB2 application and want to use the ImportUsers
utility, copy db2java.zip from the DB2 installation directory (by default, this
directory is \program files\sqllib\java) to the \Hyperion
Planning\utils folder.

Note: If your Web application server is installed on a UNIX computer, you need to
change the PROP_PATH to . (a period) in the ImportUsers.cmd file and manually copy
the Properties file from the Utils folder on the UNIX system to the Utils folder on the
Windows system.

➤ To import users into a Hyperion Planning application:


1. Locate the ImportUsers utility by navigating to the Hyperion
Solutions\Hyperion Planning\Utils folder.
2. From the Command Prompt, log on to the Hyperion Planning application and
start the utility by typing the following command and required parameters
(separating each parameter with a space):
importusers (name of text file) (planning server name) (user name)
(password) (application name)
where:

Parameter Explanation

name of text file The full path and name of the text file containing
information on the users to import (for example,
c:\users.txt)
planning server The name of the application server that Hyperion
name Planning is using (for example, localhost)
user name The name you use to log on to the Hyperion
Planning application (for example, kravets).

114 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Parameter Explanation

password The password you use to log on to the Hyperion


Planning application (for example, pass1)
application name The name of the Hyperion Planning application (for
example, Wentel)

For example:
importusers c:\users.txt planning_server dkravets password
wentel

3. Examine the results onscreen.


5
4. Restart the application server.
You can now see the new users in the application.

Note: The ImportUsers utility does not add any users that already exist in the
application. If an imported user already exists, you can update whether their password
is synchronized with Essbase and their user role in the application. You cannot,
however, change a user to the application owner role by importing him or her.

Modifying Users
From the Edit User page, you change a user’s name and set its user type. You can
also enable sharing of the user’s password with Essbase.

➤ To modify a user:
1. At the Users tab, select the user you want to change.
You can edit only one user at a time.
2. In the Value text box, type the user name.
If you are using NTLM authentication on the local computer, type the user
name without the domain. Otherwise, separate the domain name and user
name with a backslash (for example, domain\user).
If you are using LDAP authentication, match the attribute specified in step 2
in “Configuring the User Provider” on page 104 (for example, Jane Doe).
For more information on how Hyperion Planning searches for a match with
the user name, see “Search Order for Users” on page 111.

Hyperion Planning Administrator’s Guide ■ 115


Setting Up Security

3. Select or clear the Share Password (with Essbase) check box.


For more information about shared passwords, see “Modifying Passwords” on
page 122.
4. In the User Type area, select a user type.

Note: When you change the user type for a user, the user has full read/write
access to the application through the Hyperion Planning Spreadsheet Add-in and
through Hyperion Essbase until you refresh the Hyperion Essbase cube. Once the
cube has been refreshed, the appropriate access rights are applied to the user.

5. Optional: If you are the current owner of the application and you select
Administrator as the user type, you can also make the user the application
owner by selecting the Owner check box.
6. Click OK.

Deleting Users
You delete users in Hyperion Planning on the Web from the Users tab, which is
accessed from the Administration link.

➤ To delete a user:
1. On the Users tab, select the users you want to delete.
2. Click Delete.
3. When you are prompted to confirm your deletion, click Yes.

Note: Hyperion Planning lets you delete users, even if they are currently logged.

Implementing User Security


When you add or modify users, you can create or update a security filter in
Hyperion Essbase for one user or multiple users. During this process, the size of
the security filter is checked to ensure it does not exceed the 4 KB Essbase limit.
For example, when you promote an employee, the employee’s access rights may
change. In that case, you need to update only one security filter rather than all
security filters.

116 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

If you have a very large number of users who need security filter updates, you can
use the Manage Database task to update all security filters at once. For more
information about updating large numbers of security filters, see “Creating
Application Databases” on page 67.

➤ To implement security filters for a user:


1. From the navigation frame on the Hyperion Planning Desktop, double-click
Hyperion Planning > Manage Database > Implement Security.
2. Select the users whose security filters you want to update.

3. Click .
5
Importing Access Rights
The ImportSecurity utility lets you load access rights for users and members from
a text file into Hyperion Planning. You can create a text file that specifies access
information and load that information directly into your Hyperion Planning
application.
When creating the text file, consider the following:
● The name of the text file must be Secfile.txt and it must be saved in the
Hyperion Solutions\Hyperion Planning\Utils folder
● All users and members must be defined in the database
● Each line must specify security implementation information
● Each line must contain the following items separated by a comma ( , )

Item Description

User Name An application planner


Member Name A member (account, entity, scenario or version) in the
application

Hyperion Planning Administrator’s Guide ■ 117


Setting Up Security

Item Description

Access Rights Read, Write or None. (None is ignored.)


Note: If there are duplicate lines for a user
name/member name combination, the line with Write
access takes precedence.
For example, consider the following two lines:
User1, Member1, Read, @IDESCENDANTS
User1, Member1, Write, @ICHILDREN
In this case, the security applied is User1, Member1,
Write, @ICHILDREN.

Hyperion Essbase @CHILDREN, @ICHILDREN, @DESCENDANTS,


Access Flags @IDESCENDANTS and MEMBER.
Note: The implementation of security for these
functions is the same as that in Hyperion Essbase.

For example, a line might contain the following:


User1, Member1, Read, @CHILDREN

➤ To import security information into Hyperion Planning:


1. Locate the ImportSecurity utility by navigating to the Hyperion
Solutions\Hyperion Planning\Utils folder.

2. From the Command Prompt, type the following command and required
parameter:
importsecurity.exe <UDL>

where <UDL> is the path and name of the Hyperion Planning UDL file that
points to the application for which you are specifying security.
3. After you execute the utility, check the secmig.log in the Utils folder for
a list of actions and a list of records inserted.

Note: The ImportSecurity utility retains existing form access for any users listed in
Secfile.txt.

118 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Setting Up Groups
Groups are sets of users, based on similar access rights needs, who are granted
access to the application. After users and groups are defined, you can assign their
access rights to various application elements. Users and groups are defined for
each application. A user or group may have different (if any) access rights for
different applications. A user may be a member of more than one group.
Hyperion Planning groups are defined within Hyperion Planning applications and
do not correspond with authentication provider groups. If you want to organize
users of an application into groups, you must specifically create the groups in
Hyperion Planning.
When you assign a user to a group, that user acquires the access rights of the group.
However, if a user is assigned to a group, and the access rights of the individual 5
user conflict with those of the group, the individual user’s access rights take
precedence. User groups honor the access rights overrides in Workflow Tasks. For
example, although a certain individual user may have write access to a planning
unit because the user acquired that access as a member of a group, the user will
have read-only access if another user currently has ownership of the planning unit.
Deleting a group does not delete its individual users. They are no longer part of the
group because the group no longer exists. Users who were part of the deleted group
may gain or lose some access rights, depending on the access rights that had been
assigned to the group and the users’ individual access rights.
You add, change, and delete groups in Hyperion Planning on the Web with the
Groups tab, which you access from the Administration link.

Adding Groups
You add, change, and delete groups in Hyperion Planning on the Web with the
Groups tab, which is accessed from the Administration link.

➤ To add a group:
1. In the Group Name text box on the Add Group page, enter the name of the
new group.
The name of the group must be unique within the application.
2. Optional: In the Description text box, enter a description of the new group.
3. Click Add Users.

Hyperion Planning Administrator’s Guide ■ 119


Setting Up Security

4. Do one of the following:


● In the Available Users area, select the users you want to add to the group

and click Right Arrow, , to move them to the Selected Users area.

● Click Right Arrow All, , to move all users to the Selected Users
area.
5. Click OK.
6. Click OK.

Modifying Groups
You add, change, and delete groups in Hyperion Planning on the Web with the
Groups tab, which you access from the Administration link.

➤ To modify a group:
1. In the Group Name text box on the Edit Group page, change the name of the
group.
The name of the group must be unique within the application.
2. Optional: In the Description text box, enter or change the description of the
group.
3. Click Add Users.
4. Do one or more of the following:
● In the Available Users area, select the users you want to add to the group

and click Right Arrow, , to move them to the Selected Users area.

● Click Right Arrow All, , to move all users to the Selected Users
area.
● In the Selected Users area, select the users you want to remove from the

group and click Left Arrow, , to move them to the Selected Users
area.

120 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

● Click Left Arrow All, , to move all users to the Available Users
area.
5. Click OK.
6. Click OK.

Deleting Groups
You add, change, and delete groups in Hyperion Planning on the Web with the
Groups tab, which is accessed from the Administration link.

➤ To delete a group:
5
1. At the Groups tab, select the groups to delete.
2. Click Delete.
3. When you are prompted to confirm your deletion, click Yes.

Modifying Passwords
If users who are set up to share their passwords want to change their passwords in
Hyperion Planning, they must do so by changing them directly in the external
authentication provider: Microsoft Windows LAN Manager (NTLM), LDAP
through iPlanet, or Microsoft Active Directory (MSAD). For example, a user
would change a password through Microsoft Windows Authentication/Logon and
then log on to Hyperion Planning through the Web client. At that time, the new
password information is passed to the Hyperion Essbase Server.
If a user is set up to maintain separate passwords (that is, you deselected the option
to share the password when setting up a user), you then need to change the user’s
password using Hyperion Essbase Application Manager. Until you do so, the
user’s password is set to the default, which is password. Users need to use this
default password when accessing Hyperion Planning data through a Hyperion tool,
such as Hyperion Analyzer.
When changing a user’s password, keep in mind that by default, Essbase
passwords must have at least six characters. In addition, when you add a user to
Hyperion Planning, two user IDs are automatically created in the Hyperion
Essbase database. For example:
user1

Hyperion Planning Administrator’s Guide ■ 121


Setting Up Security

user1_
If you are using NTLM authentication, user1 is specified in NTLM, without the
domain name (for example, dkravets). If you are using LDAP authentication, user1
is the value specified in step 4 in “Configuring the Authentication Provider” on
page 102 (for example, Autumn_Smith).
In either case, the system appends an underscore character after the second user
ID. The password for the underscore user ID should not be changed. In all cases,
the user type in the Hyperion Essbase security settings is user.

Tip: If two Hyperion Planning applications exist on a single Hyperion Essbase server,
and contain the same user in each application, you must pay attention to whether or not
you select to share the user’s password in either one of the applications. For example,
if you select to share the user’s password in one application but not in the other
application, it will be shared in both applications regardless. This is because Hyperion
Essbase maintains users and their passwords on a server basis rather than on an
application basis.

Assigning Access Rights


Access rights for users and groups can vary from one application to another. You
must create and open an application before you can define users and groups and
assign access rights. Access rights for users and groups can be assigned to the
following application elements:
● Scenario dimension members
● Version dimension members
● Account dimension members
● Entity dimension members
● User-defined custom dimension members
● Data entry forms
● Business rules (supports users only, not groups)

Note: Changing a user’s or group’s access to the dimension members affects the
members that are displayed on the axis on the form (after the application is refreshed).
Hyperion Planning applications should be refreshed after any changes are made to
user or group security.

122 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

You can assign access rights to a dimension member or form when you add or
modify that dimension member or form. In each instance, there is an Assign
Access option where you can assign access rights for that dimension member or
form.
Access rights consist of the following options:
● Read - Allows view access to the dimension member or form for the specified
user or group
● Write - Allows view and modify access to the dimension member or form for
the specified user or group
● None - Prohibits access to the dimension member or form for the specified
user or group
5
Note: None is the default access and does not need to be specified.

You can specify only one access right for each user or group. However, when you
assign a user to a group, that user acquires the access rights of the group. If an
individual user is assigned to a group and the access rights of the individual user
conflict with those of the group, the individual user’s access rights take
precedence.
If there is no access right specified for a user or group to an Entity, Account, or
user-defined custom dimension member, an inheritance option may determine the
user or group’s access rights. However, an access right assigned to the member
takes precedence over any inherited security access.
When assigning access rights to a specific member, you can also specify an
attribute that causes the children or descendants of that member to inherit its access
rights. In addition, when specifying inheritance attributes, you can include or
exclude the actual member from the access rights setting. The following table
illustrates the available inheritance options.
Table 2: Options for Inheriting Access Rights

Inheritance Option Result

Member The access right is assigned only to the currently selected


member.
Children The access right is assigned to all children members in the
level below the currently selected member.
iChildren The access right is assigned to the currently selected
member and all children members in the level below it.

Hyperion Planning Administrator’s Guide ■ 123


Setting Up Security

Table 2: Options for Inheriting Access Rights

Inheritance Option Result

Descendant The access right is assigned to all descendant members


below the currently selected member.
iDescendant The access right is assigned to the currently selected
member and all descendant members below it.

Setting Up Hyperion Essbase Security as Defined by


Hyperion Planning
For every licensed user in Hyperion Planning, two users are created in each
Hyperion Essbase database: the named user (as determined by the external
authentication provider) and the internal user. The internal user is identical to the
named user, with an underscore appended. For information on the naming
conventions for users, see “Modifying Passwords” on page 122 The password for
the internal user is generated automatically.

CAUTION: The password generated by the system should not be modified.

The named user is always used to log on and authenticate a user. Depending on
which program a user logs on through (for example, Hyperion Planning Web or
Hyperion Analyzer), Hyperion Planning connects to the Hyperion Essbase
database using the appropriate user type to establish a connection. The possible
connection types are listed in the following table:

Program Used to Log on to Hyperion


Planning Application Hyperion Essbase Connection

Hyperion Planning Web Client Pooled supervisor user


Hyperion Planning Windows Desktop Internal user
and Hyperion Planning Spreadsheet In addition, when an internal user logs
Add-in on to an application, one supervisor user
is logged on for that application. This
occurs only for the first internal user
who logs on, not for each subsequent
internal user.

124 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

Program Used to Log on to Hyperion


Planning Application Hyperion Essbase Connection

Analytical tools, such as Hyperion Named user


Business Rules and Hyperion Essbase
Spreadsheet Add-in

After the connection is established in Hyperion Essbase, the type of access a user
has depends on the user type that is used to establish the connection.

User Type for


Connection Planner Interactive User Administrator

Internal User Calculate Calculate Application 5


Designer
Named User Read Calculate All Calculate All

Setting Up Security for Business Rules


The ability for users to launch business rules from Hyperion Planning Web
requires setting up appropriate access rights in the Hyperion Essbase database and
in the Hyperion Business Rules repository. Setting security in Hyperion Essbase
and the Hyperion Business Rules repository needs to be established for both
Hyperion Planning users—the named user and the internal underscore user.

Setting Security on Business Rules in Hyperion


Essbase
For users to launch business rules, the type of access assigned in Hyperion Essbase
depends on the business rule type. For users to launch calculation scripts (either
created in Hyperion Essbase or exported from Hyperion Business Rules to
Hyperion Essbase), they must have a minimum of Calculate rights to the Hyperion
Essbase database for those specific calculation scripts. Allow All Calcs access
gives users permission to run all calculation scripts stored on the application or
database. For users to launch business rules that reside in the Hyperion Business
repository, they must have a minimum of Calculate rights to the Hyperion Essbase
database.

Hyperion Planning Administrator’s Guide ■ 125


Setting Up Security

Access rights must be set up through Hyperion Essbase Application Manager. For
instructions on setting up appropriate security to launch calc scripts, refer to the
Hyperion Essbase documentation.

CAUTION: If you delete a business rule from Hyperion Essbase, you must
remove the deleted business rule from any forms to which it is assigned.

Setting Security on Business Rules in the HBR


Repository
For users to launch business rules that reside in the Hyperion Business Rules
repository, access rights need to be assigned in Hyperion Business Rules in
addition to those in Hyperion Essbase. In Hyperion Business Rules, users need to
be assigned access to the specific business rules. If a business rule contains
run-time prompts, run-time prompt security also needs to be set.
Access rights must be set up through the Hyperion Business Rules Designer
module. For instructions on setting up appropriate security for business rules and
run-time prompts, see the Hyperion Business Rules documentation.

Note: When you export a business rule with the Apply Existing Security Settings check
box selected, the user access assignment of the business rule is retained in Hyperion
Essbase.

Setting Up Security in Hyperion Reports


Hyperion Reports supports three types of security:
● User Authentication
– Logon security
– Access to Hyperion Reports and data source
● Application Rights
– Access to tasks within Hyperion Reports
– Rights to design or view reports
● Data Rights
– Access to data source data such as members and values

126 ■ Hyperion Planning Administrator’s Guide


Setting Up Security

– Access to Hyperion Reports objects such as reports and folders

Hyperion Planning Administrator’s Guide ■ 127


Setting Up Security

128 ■ Hyperion Planning Administrator’s Guide


Chapter Setting Up Multiple Alias

6 Tables

This section describes how to set up and maintain multiple alias tables within a
Hyperion Planning application.

About Alias Tables


You can assign one or more alternate names, or aliases, to Hyperion Planning
Account, Entity, and user-defined dimension members. Aliases provide the ability
to create unique sets of identifiers when working with dimensions and members.
Hyperion Planning allows up to 10 aliases per dimension and dimension member,
including the default alias.
For example, members in a Cost Center dimension may be identified by their
number (100, 200, 210, and so on) or by their more descriptive alias (Human 6
Resources, Engineering, Sales, and so on). Members may also have aliases for
different languages.
When creating a Hyperion Planning application, Hyperion Essbase creates an
empty default alias table in the database outline. If you do not create any other alias
tables, all aliases are stored in this default table.
However, you can create up to nine new alias tables for storing new aliases in
Essbase. Adding or changing aliases or alias tables means you must refresh the
application. Changes are not in effect until the database is updated. To view the
subsequent database outline, open Hyperion Essbase Application Manager and
select Outline > Aliases > Set Table and select a specific alias table.

Note: You can only use alias tables that are created from within Hyperion Planning.
Alias tables that are created outside of Hyperion Planning are deleted during an
application refresh.

Multiple alias tables support the following language combinations:


● English, French, German, Spanish, and Italian

Hyperion Planning Administrator’s Guide ■ 129


Setting Up Multiple Alias Tables

● Japanese and English


● Korean and English
● Turkish and English
Each time you open the Custom Dimensions task on the Desktop, the default alias
table is selected. If you select a new alias table for a dimension or member, it
becomes the current alias table selection for all dimensions and members that
support multiple aliases for the current session only. Web users can select which
alias table to use by changing their user preferences.

Adding Alias Tables


➤ To add an alias table:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Multiple Aliases.

2. Click Add Table, .


3. In the New Alias Table Name text box, enter a name of up to 80 characters
for the alias table.

Note: The alias table name cannot contain the Tab, double quote “, or backslash
\ characters.

Note: The alias table name cannot start with the following characters:

‘\<|,=@_+-{}().
4. Click OK.

Copying Alias Tables


➤ To copy an alias table:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Multiple Aliases.

2. Click Copy Table .

130 ■ Hyperion Planning Administrator’s Guide


Setting Up Multiple Alias Tables

3. From the Source Alias Table drop-down list, select the alias table you want
to copy.
4. From the Target Alias Table drop-down list, select the alias table to which
you want to copy the information.
5. Click OK.

Clearing Alias Tables


➤ To clear an alias table:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Multiple Aliases.
2. Select the alias table you want to clear.

Note: Clearing the alias table removes the contents of the table but not the table
itself.

3. Click Clear Table . You are prompted to confirm your intention to clear
the contents of the alias table.
4. Click OK. 6

Renaming Alias Tables


➤ To rename an alias table:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Multiple Aliases.

2. Click Rename Table .


3. From the Alias Table drop-down list, select the alias table you want to
rename.

Note: You cannot rename the default alias table.

Hyperion Planning Administrator’s Guide ■ 131


Setting Up Multiple Alias Tables

4. In the New Table Name text box, enter a name of up to 80 characters for the
alias table.

Note: The alias table name cannot contain the Tab, double quote “, or backslash
\ characters.

Note: The alias table name cannot start with the following characters:

‘\<|,=@_+-{}().
5. Click OK.

Deleting Alias Tables


➤ To delete an alias table:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Multiple Aliases.
2. Select the alias table you want to delete.

Note: Deleting the alias table removes the contents of the table and the table itself.

3. Click Delete Table . You are prompted to confirm your intention to delete
the alias table.
4. Click OK.

Selecting an Alias Table


If you have assigned alternate names, or aliases, to Account, Entity, and
user-defined dimensions and members, users can select which set of aliases (stored
in an alias table) to use for displaying member and dimension names. For example,
an alias table named French could display members in French and another alias
table named German could display members in German. Users can select the alias
table to use in Web forms through the Preferences link in the Hyperion Planning
Web Client.

➤ To select an alias table:


1. From the Hyperion Planning Home page, click the Preferences link.

132 ■ Hyperion Planning Administrator’s Guide


Setting Up Multiple Alias Tables

2. Select the Application tab.


3. From the Alias Table drop-down list, select an alias table.
4. Click Save.

Hyperion Planning Administrator’s Guide ■ 133


Setting Up Multiple Alias Tables

134 ■ Hyperion Planning Administrator’s Guide


Chapter Setting Up the Calendar and

7 Currencies

This section describes how the calendar rolls up, which currencies are used in an
application, and how currencies are converted from one to another.

Customizing the Calendar


You use the Calendar task to maintain the Time dimension. The time periods that
span the Hyperion Planning database are set up by the budget administrator when
the application is created. After the calendar in the application is created, you
cannot change the base time period or reduce the number of years in the calendar.
You can change the rollup structure and add more years to the calendar using the
Calendar task.

Defining How Calendars Roll Up


The default roll up structure is based on the base time periods that are defined by
the budget administrator when the application is set up. The following table
illustrates the roll up scenario for each possible base time period:
7
Table 1: Calendar Roll Up

Base Time Period Roll Up

12 Months Four quarters are created per year. Months roll up into
their parent quarter and quarters roll up into a year.
Quarters Quarters roll up into a year.
Custom There are no default roll up structures. Instead, a flat list of
the custom base time periods is displayed.

Hyperion Planning Administrator’s Guide ■ 135


Setting Up the Calendar and Currencies

When you start the Calendar task, the Calendar window displays. Properties for a
selected item in the hierarchy are displayed in the Period Properties to the right of
the Summary Time Periods hierarchy. As the budget administrator, you can change
the names, descriptions, and ranges of the summary time periods in the hierarchy.

Creating Summary Time Periods


➤ To create a summary time period:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. Select the first summary time period in the Summary Time Periods
hierarchy.

Note: You must work from the top of the hierarchy to the bottom when you create
summary time periods. Otherwise, Hyperion Planning views the rollup structure as
asymmetrical and will not allow you to continue.

3. Do one of the following:


● Click New Period.
● Select Task > New Period.

Note: The new summary time period displays in the hierarchy as a parent of
the selected item. It has a temporary name.

4. In the Name text box, enter a name for the new summary time period.
5. Optional: In the Description text box, enter a description for the new
summary time period.
6. Use the Start Period and End Period drop-down lists to select start and end
time periods.
7. Repeat steps 3 through 6 for each summary time period you want to add.
8. Click Save.

136 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

Modifying Summary Time Periods


The Period Properties frame to the right of the Summary Time Periods hierarchy
displays the properties of a selected item in the hierarchy. You can use the Period
Properties frame to rename a summary time period or to change the range of a
summary time period. You cannot change the order of the base time periods or skip
base time periods. Also, the range cannot extend beyond the current fiscal year.

➤ To modify the name of a summary time period:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. In the Summary Time Periods hierarchy, select the summary time period you
want to rename.

Note: You cannot rename base time periods or Year Total.

3. In the Name text box, highlight the existing text and enter a new name.
4. Optional: In the Description text box, highlight the existing text and enter a
new description.
5. Repeat steps 3 through 4 for each summary time period you want to rename.
6. Click Save.

➤ To modify the range of a summary time period:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. In the Summary Time Periods hierarchy, select the summary time period for 7
which you want to change the range.
3. Use the Start Period and End Period drop-down lists to select the time
periods for the selected summary time period.
● If you select a summary time period with no sibling above it, then the
Start Period drop-down list is not available and displays its first child.
● If you select a summary time period with no sibling below it, then the End
Period drop-down list is not available and displays its last child.
● If you select a summary time period that has a sibling above it, then the
Start Period drop-down list is available and displays all children except
the first child of the sibling above it.

Hyperion Planning Administrator’s Guide ■ 137


Setting Up the Calendar and Currencies

● If you select a summary time period with a sibling below it, then the End
Period drop-down list is available and displays all children from the Start
Period through the next sibling’s children, except for the last child.
4. Repeat steps 2 and 3 for each summary time period you want to modify.
5. Click Save.

Deleting Summary Time Periods


➤ To delete a summary time period:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. In the Summary Time Periods hierarchy, select the summary time period you
want to delete.

Note: You cannot delete a base time period.

3. Do one of the following:


● Click Delete Period.
● Select Task > Delete.
4. The summary time period is removed from the hierarchy and the children are
moved into another summary time period, as described below:
● If you delete the first summary time period in the hierarchy, the children
are moved into the next sibling of the summary time period.
● If you delete the last summary time period in the hierarchy, the children
are moved into the previous sibling of the summary time period.
● If you delete a summary time period from the middle of a hierarchy, the
children are moved into the previous sibling of the summary time period.
5. Repeat steps 2 through 4 for each summary time period you want to delete.
6. Click Save.

138 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

Expanding and Collapsing the Hierarchy


➤ To expand the summary time periods in the hierarchy:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. Do one of the following:
● Click Expand All.
● Select Task > Expand All.

➤ To collapse the summary time periods in the hierarchy:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. Do one of the following:
● Click Collapse All.
● Select Task > Collapse All.

Adding Years to the Calendar


You can add years to the calendar, however, the calendar cannot exceed 15 years.
You cannot reduce the number of years in the calendar without creating a new
database.

➤ To add years to the calendar:


1. From the navigation frame on the Desktop, double-click Hyperion Planning 7
> Manage Dimensions > Calendar.
2. Do one of the following:
● Click Add Years.
● Select Task > Add Years.
3. In the Number of Years to Add text box, enter the number of years you wish
to add to the calendar.

Note: The total calendar years cannot exceed 15.

4. Click OK.

Hyperion Planning Administrator’s Guide ■ 139


Setting Up the Calendar and Currencies

Changing the Current Year or Period


The Options dialog box displays the current year and period for the calendar that
was defined when the application was created. You can change either of these
options.

➤ To change the current year or period:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Calendar.
2. Do one of the following:
● Click Options.
● Select Task > Options.
3. From the Current Year drop-down list, select the current year.
4. From the Current Period drop-down list, select the current period.
5. Click OK.

Converting Currency Values


You can plan, forecast, and analyze your financial information in a single currency
or in multiple currencies. As the budget administrator, you control the following
situations:
● Which currencies an application uses
● Which currencies an application uses for reporting purposes
● How currencies display in reports and data entry forms
● How one currency is translated into another currency
● Whether a third currency (also known as a triangulation currency) is used for
converting between currencies
● When currency conversions occur

Enabling Multiple Currencies


When you create an application, you specify that the application uses only one
currency, or multiple currencies. If you specify that the application uses only one
currency, neither the Currency nor Exchange Rates tasks are available on the

140 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

navigation frame. For more information about creating an application that allows
multiple currencies, see “Setting Up Currencies” on page 58. Additionally, if you
enabled the application to support multiple currencies, you can also enable
multiple currency support per entity on the forms you create and during business
rule selection. For more information about form options and business rule
selection, see “Setting a Form’s Display Options” on page 246 and “Selecting
Business Rules” on page 250.
To allow users to work with currencies other than entities’ base currencies, you
must also do one of the following when selecting members for a form:

➤ To compare converted currencies in the same form, for rows and columns select to
display at least two different currencies.

➤ To convert currencies for all the currency values in the form, assign the Currency
dimension to the page axis and select reporting currencies as members. Users can
then select the currency member of their choice from the page axis and then launch
the calculate currencies calc script to view all the values in that currency.

Working with Multiple Currencies


If multiple currencies are enabled, users can see values converted from the local
currency to a reporting currency and can override a cell’s base currency. The
following are some important points to know about working with multiple
currencies:
● To convert data from one currency to another, multiple currencies must be
enabled for the application and for the form, and the form must include at least
two currencies.
7
● When the local currency is selected on a data entry form, the default stored and
displayed currency for each cell is the entity’s base currency (which you set
up). Think of the local currency members and values as source currencies.
Users can enter data values only into local currency members. If the local
currency member is selected, then all the currencies that are set up for the
application are available as valid input types.
● Currencies can be converted only to reporting currencies. Think of reporting
currencies as target currencies in that they are read-only. Users cannot enter
data into cells that are displayed in a reporting currency. The application’s
main currency is by default a reporting currency. You can change which
currencies are reporting currencies within the Currencies task.

Hyperion Planning Administrator’s Guide ■ 141


Setting Up the Calendar and Currencies

You can load values (from historical scenarios, for example) into a reporting
currency by using the Hyperion Essbase Adapter to populate values directly
into Hyperion Essbase.
● Currency conversion is limited to level 0 members.
● Currencies that are defined for the application, including reporting and
non-reporting currencies, (as set up in the Currencies task) are valid currencies
for data entry. The valid currencies for data entry are displayed in a list that
users can access by clicking the Available Currencies link on the Enter Data
page.
● To get meaningful results, roll up values in one common reporting currency.
If members of a subtotal have mixed currencies, the currency type is blank and
the currency symbol does not display. For example, adding 10 US dollars and
10 Japanese Yen to a subtotal value of 20 does not make sense.

About the Calculate Currencies Calc Script


The Calculate Currencies calc script is based on the dimensions and members on
the form. This calc script converts data from the local currency to the reporting
currency specified on the form, applying the exchange rate conversions.
The following is a list of important points to know about the Calculate Currencies
calc script:
● It converts only level 0 members.
● It does not calculate subtotals. To subtotal values, run the Calculate Form calc
script (or a customized calc script that includes aggregation) after converting
currencies.
● It ignores #missing values.
● It can be turned on or off by associating or disassociating it with a form (a form
design option).
● It is by default set to not run when saving data.

Exchange Rate Types


There are three types of exchange rates associated with a currency:
● Historical
● Average

142 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

● Ending
The exchange rate type used for each account is specified in the Custom
Dimensions window when you set up accounts. For average and ending rate types,
you can enter values for all time periods. For the historical rate type, you can enter
a single rate value that is used for all time periods, including the Beginning
Balance time period. For the Beginning Balance time period you can enter a single
rate value that is always used for that time period for average and ending rate types.

Triangulation
Hyperion Planning supports currency conversion by triangulation through an
interim currency. The interim currency is called the triangulation currency. For
example, if you know Euro/US Dollar exchange rate and the Euro/French Franc
exchange rate, you can calculate the US Dollar/French Franc exchange rate by
using the Euro as the triangulation currency.
You also have the ability to modify a currency’s triangulation currency. Doing this
requires you to re-enter exchange rates relative to the triangulation currency
property. You must then refresh the application for the new exchange rates to be
transferred and stored to the plan types.

Note: The application’s default currency cannot be selected as a triangulation


currency.

Scaling
You can specify that data values be scaled when they are displayed in certain
currencies. For example, you might set the scaling for Yen to Thousands. You
could enter 10,000 as a value for the Japan entity on a form with the Local member 7
selected for the Currency dimension. When you select Yen as the currency member
for the form, the scaling is applied and 10 displays as the value for Japan.

Number Formatting
You can determine how numerical values display in a data entry form. This applies
to non-currency as well as currency data types. However, users can override these
settings on an individual basis in data entry forms. You can determine the initial
display of:
● The thousands separator:
– None - to display numbers with no thousands separator

Hyperion Planning Administrator’s Guide ■ 143


Setting Up the Calendar and Currencies

Example: 1000
– Comma - to display numbers with a comma separating thousands values
Example: 1,000
– Dot - to display numbers with a dot separating thousands values
Example: 1.000
– Space - to display numbers with a space separating thousands values
Example: 1 000
● The decimal separator:
– Dot - to display the decimal separator as a dot
Example: 1000.00
– Comma - to display the decimal separator as a comma
Example: 1000,00
● The display of negative numbers:
– Prefixed minus - to display a minus sign in front of negative numbers
Example: -1000
– Suffixed minus - to display a minus sign behind negative numbers
Example: 1000-
– Parentheses - to display brackets around negative numbers
Example: [1000]
● The color of negative numbers:
– Black - to display negative numbers in black
– Red - to display negative numbers in red

Reporting Currencies
A reporting currency is the currency in which your company prepares its financial
statements. Hyperion Planning supports currency conversion from local currencies
to one or more reporting currencies. The converted reporting currency values are

144 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

stored and are read-only for all users. An application’s default currency is also the
default reporting currency. You also have the ability to disable a currency as a
reporting currency.

Seeing How a Currency is Used


You can see a graphical representation of how a currency is used in an application.
The display reports such information as whether a currency:
● Is the default currency
● Is used as a triangulation currency
● Has a conversion or exchange relationship set up with other currencies
● Is used by an entity

➤ To see how a currency is used:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Currencies.
2. From the list of currencies, highlight the currency for which you want
information.

3. Click Show Currency Usage, .


4. Click OK.

Adding Currencies
7
You can add currencies to an application as needed. When you add currencies, you
can select them from a pre-defined list or create your own. You can specify the
following properties when you add a currency:
● The three letter code
● The symbol
● A description of up to 256 characters
● The scaling factor to use, if any, when values are displayed in the currency
● The triangulation currency, if any, to use for currency conversion
● The number formatting

Hyperion Planning Administrator’s Guide ■ 145


Setting Up the Calendar and Currencies

● Whether or not it is a reporting currency

➤ To add a currency:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Currencies.
2. Do one of the following:

● Click New Currency, .


● Select Task > New Currency.
3. Do one of the following:
● To add a pre-defined currency to the application, select Select Standard
Currencies.
● To add a custom currency to the application, select Create a New
Currency and specify the following properties:
– In the Code text box, enter an abbreviation or key identifier of up to
three characters for the new currency.
– From the Symbol drop-down list, select a symbol for the new
currency.
– Optional: In the Description text box, enter a descriptive name for
the new currency.
– Optional: From the Scale drop-down list, select how the new
currency is entered and displayed (in whole numbers, tens, hundreds,
thousands, ten thousands, and so on).
– Optional: From the Triangulation Currency drop-down list, select
a currency to be used for converting the new currency to a different
currency through a common, third currency, which is the
triangulation currency.
– Optional: From the 1000s Separator drop-down list, select an
option to display numbers with thousands values.
– Optional: From the Decimal Separator drop-down list, select an
option to display numbers with decimal values.
– Optional: From the Negative Sign drop-down list, select an option
to display numbers with negative values.

146 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

– Optional: From the Negative Color drop-down list, select a color


option to display numbers with negative values.
– Optional: Select the Reporting Currency option to designate the
currency as a reporting currency.
4. Repeat steps 2 and 3 for each new currency you want to add.
5. Click OK.

Modifying Currencies
➤ To modify a currency:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Currencies.
2. From the Currencies area, select the currency you want to modify.
3. Do one of the following:

● Click Edit Currency, .


● Select Task > Edit Currency.
4. Modify the properties as necessary.
– From the Symbol drop-down list, select a symbol for the currency.
– In the Description text box, enter a descriptive name for the currency.
– From the Scale drop-down list, select how the currency is entered and
displayed (in whole numbers, tens, hundreds, thousands, ten 7
thousands, and so on).
– From the Triangulation Currency drop-down list, select a currency
to be used for converting the currency to a different currency through
a common, third currency, which is the triangulation currency.
– From the 1000s Separator drop-down list, select an option to display
numbers with thousands values.
– From the Decimal Separator drop-down list, select an option to
display numbers with decimal values.
– From the Negative Sign drop-down list, select an option to display
numbers with negative values.

Hyperion Planning Administrator’s Guide ■ 147


Setting Up the Calendar and Currencies

– From the Negative Color drop-down list, select a color option to


display numbers with negative values.
– Select or deselect the Reporting Currency option.

Note: You cannot modify the Code property.

5. Repeat steps 2 through 4 for each currency you want to modify.


6. Click OK.

Deleting Currencies
➤ To delete a currency:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Currencies.
2. From the Currencies area, select the currency you want to delete.
3. Click Show Currency Usage to see if the currency is the default currency, is
used as a triangulation currency, or is associated with an entity. You cannot
delete a currency that meets any of these criteria. Additionally, if you delete a
currency that is defined in the exchange rate table, it is also deleted from that
table.
4. Do one of the following:

● Click Delete Currencies, .


● Select Task > Delete Currencies.
5. The system prompts you to confirm your intention to delete the currency.
6. Click Yes.
7. Repeat steps 2 through 6 for each currency you want to delete.
8. Click OK.

Note: After deleting a currency, you need to update and validate business rules,
reports, and Hyperion Application Link adapter processes.

148 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

Setting Up Exchange Rates


You use exchange rates to convert values from one currency to another. This
allows you to plan in a variety of currencies. Some situations where you might
want to set up exchange rates include:
● When you want to enable budget preparers in various countries to create plans
in their native currencies
● When you want to show summary data in reports in a particular currency
● When you want to summarize values from multiple currencies into a single
currency
For example, you might specify Yen as the base currency for the Japan entity and
US Dollars for the United States entity. When you display a data entry form that
has values on it for the Japan entity and the form’s display currency is set to US
Dollars, the exchange rates for the Yen is used to convert the values for Japan to
US Dollars. If the display currency is set to Yen, it uses the exchange rates for US
Dollars to convert values for the Unites States entity to Yen.

Note: When you create an application, you must have selected to use multiple
currencies for the Exchange Rates task to be available. If you selected to create the
application using one currency, the Exchange Rates task is not available.

About Exchange Rate Tables


Each application has a default currency, which you specify when creating the
application. When setting up the exchange rate tables, only the default currency,
and any triangulation currencies are available as destination currencies. You can
then enter exchange rates from all source currencies to the default or triangulation
currencies.
7
You can create as many exchange rate tables as the application requires, each with
a different purpose. For example, you could use three exchange rate tables, each
representing a different business scenario and name them Forecast, Actual, and
Budget. Each table is typically associated with one or more scenarios. Each
scenario can be associated with only one exchange rate table. When you create a
scenario, Hyperion Planning allows you to select which exchange rate table to use
for converting currencies.
You can then enter conversion values between the default currency and all the
currencies defined in the Currencies Module. Each exchange rate tables span all
time periods of the application calendar so that you can apply exchange rates to all
scenarios. When you create a new exchange rate table or modify existing exchange

Hyperion Planning Administrator’s Guide ■ 149


Setting Up the Calendar and Currencies

rate tables, you must refresh the application for the new exchange rates to be
transferred and stored in the plan types. For more information about creating and
refreshing applications, see “Creating Application Databases” on page 67 and
“Refreshing Application Databases” on page 70.

Hsp_Rates Dimension
Applications that support multiple currencies include an additional dimension
called Hsp_Rates. This dimension is used to store exchange rates. There are two
members within this dimension:
● Hsp_InputValue - which stores data values
● Hsp_InputCurrency - which stores currency types for the data values
When you generate reports or load data, you need to refer to the Hsp_InputValue
member. Additionally, when you load data, you need to load the data against the
local currency. You do not need to refer to the Hsp_InputCurrency member.
By default, the Hsp_Rates dimension is set to Dense. You can change this setting
using the Performance Settings option. For more information about changing
performance settings, see “Optimizing Application Performance” on page 76.

Triangulation
If currency A is set to triangulate through another currency B, then the exchange
rates between currency A and any other currencies that triangulate through
currency B are calculated automatically. For example, French Francs and
Deutsche Marks might both be set to triangulate through the Euro. After rates are
entered for converting between French Francs and the Euro and between Deutsche
Marks and the Euro, the rates for converting from French Francs to the default
currency and the rates for converting from Deutsche Marks to the default currency
are automatically calculated.

Calculation Method
When you input exchange rates for converting from one currency to another, you
select either Multiply or Divide as the calculation method. For example, if you
select 1.5 as the rate for converting British Pounds to US Dollars, and select
multiply as the calculation method, 1 British Pound is converted to 1.5 US Dollars.

150 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

Setting Up Exchange Rate Tables


You enter exchange rates for time periods using the Exchange Rate Table window.
You do not have to define exchange rates for all time periods. By default, the time
periods shown in the table are for the current year of the application. You can
control which columns and years display on an exchange rate table. Your
selections do not affect the actual data stored in the table, just whether or not it
displays. The display selections are not saved when you save the table.
The following table describes the option on the Exchange Rate Table window:
Table 2: Exchange Rate Table Window Options

Currency Select the currency from the list for which you want to
enter conversion rates (either the default currency or any
triangulation currency). For example, if you want to
specify a rate for converting French Francs to the default
currency of the application, select the default currency in
the Currency column.
From Select the currency to enter rates from which to convert
(source currency).
Method The mathematical operator (either multiply or divide) that
determines how values are calculated between the source
and destination currencies.
Historical For all time periods, this value sets the exchange rate for
accounts whose Exchange Rate Type is set to Historical
(in the Custom Dimension task). The account’s Data Type
must be set to Currency. Historical is typically used for
balance sheet account types. A historical exchange rate
may reflect a calculated rate over time, a rate for a point in
7
time prior to the application’s calendar, or a rate that was
in effect when an event occurred.
Beg Balance The value of balance sheet accounts (for example, Asset,
Liability, and Equity). There is one beginning balance
time period, which is the first time period in the
application. Rates for the Beginning Balance time period
are populated for each year in the application. Scenarios
that do not include the first year of the application can still
include a Beginning Balance time period.

Hyperion Planning Administrator’s Guide ■ 151


Setting Up the Calendar and Currencies

Table 2: Exchange Rate Table Window Options

Average For any time period, this value sets the exchange rate for
accounts whose Exchange Rate Type is set to Average (in
the Custom Dimension task). Average is typically used for
Revenue and Expense account types, or for Saved
Assumption account types whose Time Balance option is
set to Flow. The account’s Data Type must be set to
Currency.
Ending For any time period, this value sets the exchange rate for
accounts whose Exchange Rate Type is set to Ending (in
the Custom Dimension task). Ending is typically used for
Asset and Liability account types, or for Saved
Assumption account types whose Time Balance option is
set to Balance. The account’s Data Type must be set to
Currency.
Show Columns for Lets you control which columns display in the grid by
clicking the check boxes for Average Rates, Type, End
Rates, Method, Historical, and Beg Balance.
Years Click to specify the time periods shown in the grid. By
default, the time periods shown in the grid are the current
year of the application calendar.
Select Another Rate Click to select another Exchange Rate table to edit.
Table

➤ To set up an exchange rate table:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Exchange Rates.
2. Do one of the following:

● Click New Rate Table, .


● Select Task > New Rate Table.
3. In the Name text box, enter the name of the new exchange rate table.
4. In the Description text box, enter a description for the new exchange rate
table.
5. Click OK.

152 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

6. Highlight the exchange rate you created and click Open Rate Table.
7. From the Currency list, select the default currency or triangulation currency
you want to set up.
8. Place the cursor in the row of the currency you want to convert from and in
the cell for which you want to enter a value.
9. Enter values in the other columns of the row to reflect the relationship you
want to set up when Hyperion Planning converts from that currency to the
default or triangulation currency.
10. In the Method column of the row, specify whether multiplication or division
should be used as the calculation method.
11. Enter values into the cells for the desired time periods:
● Hyperion Planning stores values with up to six places to the right of the
decimal separator. If you enter more than six digits to the right of the
decimal separator, the value is rounded off to six digits.
● To automatically enter the same exchange rate for all following average
or ending periods in a year, place the cursor in the cell to be copied and
select Task > Fill Year. To enter the value for all the average or ending
exchange rate cells in the row, select Task > Fill Table.
● To set which years display, click Years and select the desired years.
12. Optional: From the Show Columns For section, select the columns you want
to display in the grid.
13. Optional: Click Years to set which years the grid displays.
● Select the years you want to display. 7
● Click OK.
14. Click OK.

Note: To undo your changes since you last saved the exchange rate table, click
Restore.

15. Click Save.

Hyperion Planning Administrator’s Guide ■ 153


Setting Up the Calendar and Currencies

Modifying Exchange Rate Tables


The values of currencies relative to each other can change frequently. You can
change the exchange rates that are used in an application to reflect real world
changes.

➤ To modify an exchange rate table:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Exchange Rates.
2. From the Exchange Rates Tables list, select the table whose exchange rates
you want to modify.
3. Click Open Rate Table.
4. From the Currency list, select the destination currency you want to modify.

Note: By default, the currencies are listed by the abbreviations set up by the three
character ISO currency standard.

5. Enter the changes in the appropriate columns.


6. Repeat steps 2 through 5 for each currency you want to modify.

Note: To undo your changes since you last saved the exchange rate table, click
Restore.

7. Click Save.

Note: Launch the currency conversion to recalculate values.

Deleting Exchange Rate Tables


You can delete exchange rate tables unless they are being used by a scenario, in
which case they cannot be deleted.

➤ To delete an exchange rate table:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Exchange Rates.
2. From the Exchange Rate Tables list, select the table you want to delete.
3. Do one of the following:
● Click Delete Rate Table.

154 ■ Hyperion Planning Administrator’s Guide


Setting Up the Calendar and Currencies

● Select Task > Delete Rate Table.


4. You are prompted to confirm your intention to delete the exchange rate table.
5. Click Yes.
6. Repeat steps 2 through 4 for each exchange rate table you want to delete.

Hyperion Planning Administrator’s Guide ■ 155


Setting Up the Calendar and Currencies

156 ■ Hyperion Planning Administrator’s Guide


Chapter Setting Up Custom

8 Dimensions

This section describes how to work with user-defined custom dimensions, the
Entity dimension, the Account dimension, and the members, attributes, and
attribute values within each of the dimensions.

Working with Dimensions


Dimensions represent the core components of a Hyperion Planning application.
You use them to categorize every data value. Dimensions are usually static. After
you determine the dimensions, they rarely change over the life of an application.
Seven dimensions are included with Hyperion Planning: Account, Entity,
Scenario, Version, Time, Year, and Currency. In addition, you can create up to 13
user-defined custom dimensions that are specific to your organization.

About Dimensions and Members


You create hierarchical relationships in dimensions by creating and organizing
members. Members are the individual components of a dimension. Some
dimensions may consist of relatively few members, while others may have
hundreds or even thousands of members.

About Sparse and Dense Dimensions


8
Most multi-dimensional databases have the following two characteristics:
● Data values are not smoothly and randomly distributed throughout the
database.
● Data values do not exist for the majority of member combinations in the
database.

Hyperion Planning Administrator’s Guide ■ 157


Setting Up Custom Dimensions

When these two conditions exist for any given dimension in the database, that
dimension is said to be a sparse dimension. A sparse dimension is a dimension that
contains a low percentage of occupied data values in each combination of
dimensions that occurs. For example, a database might include the Product,
Market, and Accounts dimensions. The Product dimension represents the product
units, the Market dimension represents the geographical regions in which the
products are sold, and the Accounts dimension represents the Accounts data.
Because not every product is sold in every geographical region, accounts data does
not exist for all products in all regions. In this case, the Accounts dimension is a
sparse dimension.
Most multidimensional databases also contain dense dimensions. A dense
dimension is a dimension that contains a high percentage of occupied data values
in each combination of dimensions that occur. In the previous example, if every (or
nearly every) product is sold in every (or nearly every) region, then accounts data
exists for almost all products in all regions. In this case, the Accounts dimension
is a dense dimension.
To optimize the performance of the database, you can designate the dimensions as
sparse or dense. If a dimension is sparse, and you designate it as such, Hyperion
Planning searches for only those data values that are occupied in each dimension
combination that occurs, and then calculates those data values. This optimizes
performance by decreasing calculation time and lowering disk usage. By default,
Hyperion Planning designates the Account and Time dimensions as dense and the
remaining dimensions as sparse. You can modify these settings as the application
requires. For more information about optimizing the performance of the
application, see “Optimizing Application Performance” on page 76.

About Dimension Hierarchies


Dimension hierarchies define the structural and mathematical relationships, and
the consolidations between the members in the database. These relationships are
represented graphically in a collapsible hierarchy diagram. The levels below the
database name are the dimensions, and the levels below each dimension are the
members.
In the following example, the Periods dimension contains the member YearTotal,
which in turn contains the members Q1, Q2, Q3, and Q4. The members Q1, Q2,
Q3, and Q4 each contain their own members for the corresponding months in the
year. To consolidate the data values in the Periods dimension, you roll up monthly

158 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

data values to get quarterly data values, and quarterly data values to get yearly data
values. Together, the structure of these members, as well as the method for
consolidating their data values, comprise a dimension hierarchy.

In any dimension hierarchy, members of the same level that belong to the same
dimension or member are known as siblings. In the previous example, Q1, Q2, Q3,
and Q4 are siblings because they are at the same level in the hierarchy, and are
members of the same member: YearTotal. However, Jan and Apr are not siblings
because, though they are at the same level in the hierarchy, Jan is a member of Q1
and Apr is a member of Q2.
The members that belong to a particular dimension are known as the children of
that dimension. This is also true of members as well. Members that belong to a
particular member are known as the children of that member. In the previous
example, the member YearTotal is a child of the Periods dimension, the members
of Q1, Q2, Q3, and Q4 are children of the member YearTotal, and the members
Jan, Feb, and Mar are children of the member Q1. Conversely, Q1 is the parent of
Jan, Feb, and Mar, YearTotal is the parent of Q1, Q2, Q3, and Q4, and Periods is 8
the parent of YearTotal. This is because the data values of Jan, Feb, and Mar are
consolidated to produce the data value for Q1, and the data values for Q1, Q2, Q3,
and Q4 are consolidated to produce the data value for YearTotal.

Hyperion Planning Administrator’s Guide ■ 159


Setting Up Custom Dimensions

Working with Custom Dimensions


Hyperion Planning includes two custom dimensions: Account and Entity. You can
edit the names of these dimensions as needed. In addition, you can create up to 13
user-defined custom dimensions. You use custom dimensions for the following
purposes:
● You use the Entity dimension to model the flow of planning information in
your organization and establish a plan review path.
● You use the Account dimension and user-defined dimensions to specify the
data you want to gather from planners.

Aggregation Options
You can define calculations within dimension hierarchies using aggregation
options. Aggregation options determine how values of child members are
aggregated to the parent member. The following is a list of available aggregation
options:
● + Addition
● - Subtraction
● * Multiplication
● / Division
● % Percent
● ~ Ignore
For example, Sales and COGS may be children of the member Net Income. If you
set the aggregation option for the Sales member to addition and the aggregation
option for COGS to subtraction, then the aggregated value for the Net Income
member will represent the Sales member minus the COGS member.

160 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

Storage Options
You can select from several storage and calculation options for dimension
members to optimize performance and disk usage. The following table describes
the available options:
Table 3: Storage Options

Option Impact

Dynamic Calc and Calculates the data values of the member, and then stores
Store these values
Store Stores the data values of the member
Dynamic Calc Calculates the data values of the member, and then
disregards these values
Share Allows two or more members in the same dimension to
share data values (this is supported for Entity members
only)
Never Share Prohibits two or more members in the same dimension
from sharing data values

In most cases, you can optimize your calculation and lower disk usage by using
Dynamic Calc instead of Dynamic Calc and Store when you are calculating
members of sparse dimensions. However, you should use Dynamic Calc and Store
for members of sparse dimensions in the following situations:
● A sparse member with a complex formula
● A sparse member that users retrieve frequently
For members of dense dimensions, use Dynamic Calc for your calculation. Using
Dynamic Calc and Store provides only a small decrease in retrieval time, and in
the regular calculation time. In addition, the disk usage is not lowered
significantly. 8
For data values that are being accessed concurrently by many users, use Dynamic
Calc. In this situation, the retrieval time may be significantly lower than for
Dynamic Calc and Store.
You should keep the following points in mind when selecting storage options:
● You should not use Dynamic Calc for base-level members for which users
enter data.

Hyperion Planning Administrator’s Guide ■ 161


Setting Up Custom Dimensions

● Data values are not saved for Dynamic Calc members.


● You should not use Dynamic Calc for a parent member if you enter data for
that member in a target version. Parent members set to Dynamic Calc are
read-only in target versions.
● You should not set a parent member to Stored if its children are set to Dynamic
Calc. With this combination, when a user saves and refreshes a data entry
form, the new total for the parent is not calculated.
● You should use Share when you want to allow for alternate roll-up structures
in the application. For more information about shared members, see “Working
with Shared Members” on page 165.
● You should use Never Share when a parent has only one child that aggregates
to that parent.

Expanding Dimensions and Members


You can expand a dimension and all its members, or you can select to only expand
a particular member within a dimension. You must expand a dimension before
using the Find feature. A dimension cannot be included in a search until it has been
expanded.

➤ To expand a dimension or member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. Select the dimension or member you want to expand.
3. Do one of the following:

● Click Expand Dimension, .


● Select Task > Expand Dimension.

Collapsing Dimensions and Members


You can collapse a dimension and all its members. You can also collapse only a
particular member within a dimension.

162 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

➤ To collapse a dimension or member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. Select the dimension or member you want to collapse.
3. Do one of the following:

● Click Collapse Dimension, .


● Select Task > Collapse Dimension.

Finding Dimensions or Members


The Find feature lets you search for dimensions or members in the Dimension List
hierarchy. When you search for a dimension or member, the Find feature searches
any dimensions that you expanded in the Dimension List hierarchy. If you do not
expand a dimension before you use the Find feature, the unexpanded branches are
not included in the search.

➤ To find a dimension or member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. Select the dimension you want to include in the search and do one of the
following:

● Click Expand Dimension, .


● Select Task > Expand Dimension.
3. Repeat step 2 for each dimension you want to include in the search.
4. In the Find text box, enter the name of the dimension or member for which you
want to search. 8
Note: You can use the wildcard character * to find an item when you do not know
the complete name of the item or to find multiple items whose names have several
letters in common.

5. Click Find Next, , and Find Previous, , to scroll through the search
results.

Hyperion Planning Administrator’s Guide ■ 163


Setting Up Custom Dimensions

Saving Changes to Dimensions and Members


Hyperion Planning provides an “autosave” feature to assist you in saving changes
to dimensions and their members. This feature is turned on by default.

➤ To turn off the autosave feature:


1. Highlight the top-level Custom Dimensions.
2. Clear the Autosave check box.
From this point on, you will need to click Save in order to save the changes to the
database. In addition, you will have access to the restore feature. For more
information on the restore feature, see “Restoring Dimension and Member
Properties” on page 164.

➤ To turn on the autosave feature:


1. Highlight the top-level Custom Dimensions.
2. Select the Autosave check box.
3. Now, changes are automatically saved to the database.
When changes are saved, Hyperion Planning performs a validation check to:
● Prevent a user from assigning a member to a plan type for which it is not valid.
● Prevent a user from using duplicate member names and aliases.
If the validation check fails, an error message displays and you can make the
necessary corrections.

Restoring Dimension and Member Properties


After you make changes to dimensions and members, and before you save those
changes, you can restore the dimension and member properties to the properties
that you last saved. When you restore the dimension and member properties,
Hyperion Planning discards any changes that you made since you last saved the
properties.

CAUTION: The restore feature is not available if you are using the
autosave feature.

164 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

Concurrent Usage
Different administrators can work on different dimensions within the Custom
Dimensions task. For example, one administrator can set up accounts while
another administrator manages entities. This enables multiple administrators to
maintain an application in less time, and with less restrictions.

Working with the Entity Dimension


Typically, you use the Entity dimension to create a structure that matches the
structure of your organization. You create an entity member for each group or
responsibility center in your organization that submits a plan for approval. The
entity member is one of the key dimensions that helps define the budget review
process. It represents the unit of work in workflow tasks. For more information
about workflow tasks, see “Managing the Budgeting Process” on page 259. You
can define whatever type of units your organization requires, such as geographical
regions, departments, or divisions.
For example, you may have regional centers that prepare budgets which are
reviewed at the country headquarters. The country headquarters in turn prepares a
plan that is reviewed at the corporate headquarters. To match this structure, you
would create members for the regions, countries and headquarters. You would set
up the regions as children of the country members, and the country members as
children of the headquarters member.
When you create a form, you can also allow multiple currencies per entity. This
allows for multiple currency data entry and reporting against a single entity.
However, Hyperion Planning continues to support a base entity for each entity.
You can also assign the currency for the values you enter. The values for the
selected currency convert to all other currencies that have defined exchange rates.

Working with Shared Members


The ability to create shared members allows for alternate roll-up structures within 8
a Hyperion Planning application. A base member must exist before you can create
a shared member, but there is no limit to the number of shared members you can
create for the base member. A base member must also display before any of its
shared members in position from top to bottom.

Hyperion Planning Administrator’s Guide ■ 165


Setting Up Custom Dimensions

Shared members contain read-only values and are only available in the Entity
dimension. For example, you may want to roll up by function (functional roll-ups),
by line of business (management roll-ups), or by geography (statutory roll-ups).
However, shared member values can be ignored to avoid double-counting the
values when you roll-up the outline.
Shared members share some of the same property definitions as the base member.
Those properties include member name, alias name, base currency, and plan types
for which the member is valid. Shared members must have unique parent members
and different roll-up aggregation settings. Custom attributes, custom attribute
values, and member formulas are not allowed for shared members.
When a shared member is created, the Advanced option is not available. In
addition, shared members cannot be moved to a different parent member. Rather,
you must delete the shared member and re-create it under a different parent
member. Shared members must be at the lowest level (which is level zero) in the
hierarchy and cannot have children. Therefore, data can be entered to a shared
member and the value is stored with its base member.

Assigning Access Rights to Shared Members


Access cannot be assigned directly to a shared member. You assign access rights
to shared members in one of two ways:
● From the security assigned directly to the base member
● From the security assigned at the parent or ancestor of the shared member
The existing inheritance access rights apply to shared members. The precedence
order for access rights is checked at each level, first by user and then by group
based on the member’s access right inheritance relationship. However, if there is
more than one access assignment, inheritance rules are additive, so that the highest
access right is applied. For more information about inheritance relationships, see
“Assigning Access Rights” on page 123.

Example
Entity
United States
CA (base)
NY

166 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

West
CA (shared)
NV
Sales Region 1
CA (shared)

Case Access Assignment Effective Access for CA


Case 1 CA (base) = None Read
iDescendants (West) = Read
Case 2 iDescendants (United States) = Write
None
iDescendants (West) = Read
iDescendants (Sales Region 1) =
Write
Case 3 iDescendants (United States) = Write
Write
iDescendants (West) = None
iDescendants (Sales Region 1) =
Read

Entity Members and Plan Types


When you define an entity member, you assign a plan type for which it is valid. If
you promote or demote a member, and the new parent of the member is valid for
different plan types than the member is valid for, then the member becomes valid
for the same plan types as the new parent. However, if you do not assign a plan
type to a member, that member’s children do not have access to that plan type or
its aggregation options.
Your organization may require that different entity members prepare different
8
plans. For example, in your organization all entity members may submit expense
plans, but entity members that are cost centers do not submit revenue plans. When
you define entity members you specify the plan types for which they are valid.
Because data entry forms are associated with plan types, this allows you to control
which entity members can enter data for each plan type.

Hyperion Planning Administrator’s Guide ■ 167


Setting Up Custom Dimensions

For example, Eastern US may be a cost center, and you assign it as valid for the
P&L plan type, but not valid for the Revenue plan type. When you create data
entry forms for the Revenue plan type, Eastern US is not selectable for those
forms.
You can also add entities by performing a bulk load using Hyperion Application
Link. For more information about loading entities using Hyperion Application
Link, see “Loading Members and Data” on page 219.

Base Currency
If the application is set up for currency conversion, you specify a base currency for
each entity member. The default base currency for all entity members is the
currency you specify when you create the application using the Setup Assistant.
For example, if US Dollars is the default currency, you may specify Yen as the base
currency for the Japan entity and US Dollars for the United States entity. When
you display a data entry form that has values on it for the Japan entity and the
form’s display currency is set to US Dollars, the values will be converted to US
Dollars per the rates in the exchange rate table (this example assumes that Yen is
the local currency and US Dollars is the reporting currency).

Adding Entity Members


You can add entity members to the Entity dimension as well as adding siblings and
children to the existing entity members.

➤ To add an entity member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimensions List hierarchy, select the Entity dimension, or an existing
member of the Entity dimension.
3. Do one of the following:

● If you select the Entity dimension, click Add Child, , to add an


entity member to the dimension.

168 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

● If you select an existing entity member, click Add Sibling, , to add a

sibling entity member or click Add Child, , to add a child entity


member.

Note: A sibling member displays at the same level in the hierarchy as the
selected member. A child member displays one level below the selected
member in the hierarchy.

4. In the Member text box, highlight the default member name and enter a new
member name. The name can contain up to 80 characters and must be unique
across all dimensions.

Note: The member name cannot contain the Tab, double quote “, or backslash \
characters.

Note: The member name cannot start with the following characters:

‘\<|,=@_+-{}().
5. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
6. Optional: In the Alias text box, enter an alternate name for the entity member.
The alias can contain up to 80 characters and requires the same naming
conventions as described above for the member name.
7. From the Base Currency drop-down list, select the base currency for the
entity member.
8. Select or deselect the Valid for Consolidations option. Selecting this option
flags the member as one you plan to transfer to Hyperion Financial
Management using Hyperion Application Link.
9. Optional: Click Advanced to set data storage properties used in building a
Hyperion Essbase cube. For more information about setting advanced 8
properties, see “Defining Advanced Properties for Entity Members” on
page 170.
10. Click Assign Access. For more information about assigning access rights to
members, see “Assigning Access Rights to Members” on page 192.

Hyperion Planning Administrator’s Guide ■ 169


Setting Up Custom Dimensions

11. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
12. Select the Plan Type tab.
13. Select one or more plan types for which the entity member is valid. For more
information about plan types, see “Entity Members and Plan Types” on
page 167.

Note: Only the plan types for which the entity member’s parent is valid are
available. If the parent is not valid for a particular plan type, then neither is the child
entity member.

14. Select an aggregation option for each plan type you previously selected. For
more information about aggregation options, see “Aggregation Options” on
page 160.

Note: Only the aggregation options for which the entity member’s parent is valid
are available. If the parent is not valid for a particular aggregation option, then
neither is the child entity member.

15. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.
16. Repeat these steps for as many members as you need to add.

Defining Advanced Properties for Entity Members


➤ To define advanced properties for an entity member:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List hierarchy, select the entity member for which you
want to define advanced properties.
3. On the Member Properties tab, click Advanced.
4. From the Data Storage drop-down list, select a data storage option. For more
information about data storage options, see “Storage Options” on page 161.
● Store - stores the data values of the member.

170 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

● Dynamic Calc - calculates the data values of the member and then
discards these values.
● Dynamic Calc and Store - calculates the data values of the member and
then stores these values.
● Never Share - prohibits two or more members in the same dimension
from sharing a data value. This option should be used for parent members
that have only one child member, so that the appropriate security can be
applied to the child member.
● Shared - when you want to allow for alternate roll-up structures in the
application. For more information about shared members, see “Working
with Shared Members” on page 165.
5. Select or deselect the Two Pass Calculation option. Selecting this option
causes Hyperion Planning to re-calculate the data values of any members that
are based on the data values of the parent member or other members.

Note: This option is available for all entity members with the Dynamic Calc or
Dynamic Calc and Store properties.

6. Click OK.
7. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Modifying Entity Members


You can modify the name, alias, plan types, base currency, data storage options,
attributes, and custom attributes for any entity member.

➤ To modify an entity member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions. 8
2. In the Dimensions List hierarchy, select the entity member you want to
modify.

Hyperion Planning Administrator’s Guide ■ 171


Setting Up Custom Dimensions

3. In the Member text box, highlight the default member name and enter a new
member name. The name can contain up to 80 characters and must be unique
across all dimensions.

Note: The member name cannot contain the Tab, double quote “, or backslash \
characters.

Note: The member name cannot start with the following characters:

‘\<|,=@_+-{}().
4. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
5. Optional: In the Alias text box, enter an alternate name for the entity member.
The alias can contain up to 80 characters and requires the same naming
conventions as described above for the member name.
6. From the Base Currency drop-down list, select the base currency for the
entity member.
7. Select or deselect the Valid for Consolidations option. Setting this option
flags the member as one you plan to transfer to Hyperion Financial
Management using Hyperion Application Link.
8. Optional: Click Advanced to set data storage properties used in building a
Hyperion Essbase cube. For more information about setting advanced
properties, see “Defining Advanced Properties for Entity Members” on
page 170.
9. Click Assign Access. For more information about assigning access rights to
members, see “Assigning Access Rights to Members” on page 192.
10. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
11. Select the Plan Type tab.
12. Select one or more plan types for which the entity member is valid. For more
information about plan types, see “Entity Members and Plan Types” on
page 167.

Note: Only the plan types for which the entity member’s parent is valid are
available. If the parent is not valid for a particular plan type, then neither is the child
entity member.

172 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

13. Select an aggregation option for each plan type you previously selected. For
more information about aggregation options, see “Aggregation Options” on
page 160.
14. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Deleting Entity Members


Members must be deleted one at a time and a parent cannot be deleted without first
deleting its children. Deleting an entity member also deletes all planning units
(including data) that are associated with it. You must delete the entity member
throughout Hyperion Planning before deleting it from the Custom Dimensions
task. For example, if the entity member you want to delete is used in a data entry
form, you must delete it from the data entry form before deleting it from the
Custom Dimensions task.

➤ To delete an entity member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List, select the entity member you want to delete.
3. Select Edit > Delete Member.

Note: Deleting a base member also deletes its shared members.

4. Hyperion Planning prompts you to confirm your intention to delete the entity
member.
5. Click Yes to confirm the deletion.
6. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164. 8
Note: After deleting an entity member, you need to update and validate business
rules, reports, and Hyperion Application Link adapter process.

Hyperion Planning Administrator’s Guide ■ 173


Setting Up Custom Dimensions

Working with the Account Dimension


You use the Account dimension to specify the information that you want to gather
from budget planners. You create an account structure that lets budget preparers
input data for all of the items you are budgeting to the level of detail that you need.
You can also define calculations in the account structure. For example, the Detail
Operating Expense account member can automatically aggregate to Total
Expenses account member, and Total Expenses account member can be subtracted
from the Total Revenue account member.

Account Members and Plan Types


When you define an account member, you assign a plan type for which it is valid.
If you promote or demote a member, and the new parent of the member is valid for
different plan types than the member is valid for, then the member becomes valid
for the same plan types as the new parent. For example, you may make the Total
Product Sales account member valid for both the Revenue and the P&L plan types.
You may make the Fixed Assets account member valid for only the Balance Sheet
plan type. However, if you do not assign a plan type to a member, that member’s
children do not have access to that plan type or its aggregation options.
If an account member is valid for more than one plan type, you must specify a
source plan type for the account member. The source plan type determines which
plan type’s database stores the account value. For example, if the source plan type
for Total Product Sales account member is the Revenue plan type, then the value
displayed for the Total Product Sales account member on forms for the P&L plan
type is the value that was entered for the Revenue plan type.
You can also add accounts by performing a bulk load using Hyperion Application
Link. For more information about loading accounts using Hyperion Application
Link, see “Loading Members and Data” on page 219.

Account Types
The account type defines an account’s time balance, or how an account’s value
flows over time. It also determines the account’s sign behavior for variance
reporting with Hyperion Essbase member formulas. The variance reporting and

174 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

time balance settings are predefined for all account types except the Saved
Assumption type, which is user-defined. The following table describes the account
types.
Table 4: Account Types

Account Type Time Balance Variance Reporting

Revenue Flow Non-Expense


Expense Flow Expense
Asset Balance Non-Expense
Liability Balance Non-Expense
Equity Balance Non-Expense
Saved Assumption User-defined User-defined

An account’s time balance property determines the ending value of summary time
periods either by aggregating all values for the summary time period, or by using
only the ending value for the summary time period as follows:
● Flow uses an aggregate of all of the data values for a summary time period as
a total for the period.
● Balance uses the ending data value in a summary time period as the total for
the period.
An account’s variance reporting property determines whether the account is
treated as an expense when used in Hyperion Essbase member formulas. The
following illustrates how expense and non-expense accounts behave for variance
reporting:
● Expense - the actual amount is subtracted from the budgeted amount to
determine the variance.
● Non-Expense - the budgeted amount is subtracted from the actual amount to 8
determine the variance.
Account types are used for the following purposes:
● An expense account type represents a cost of doing business. For example,
when you plan your budget for travel expenses, you may have account
members for sales trips, trade shows and seminars.

Hyperion Planning Administrator’s Guide ■ 175


Setting Up Custom Dimensions

● A revenue account type represents a source of income. For example, when you
receive revenue from the sales of different products, you may have separate
account members for each product.
● An asset account type represents a resource that belongs to your company. For
example, when you plan accounts receivable, you may have separate account
members for each customer.
● Both the liability and equity account types represent a residual interest or a
single outside obligation to an outside creditor.
● A saved assumption account type represents the planning assumptions that
you make. Examples include; floor space, headcount, rates, prices, and so on.
Saved assumptions let you centralize your planning assumptions to ensure
consistency across the application.

Saved Assumptions
Saved assumptions let you centralize your planning assumptions to identify key
business drivers and to ensure consistency across the application. When you define
a saved assumption account member, you select the appropriate time balance and
variance reporting properties.
● Variance reporting - for each saved assumption you create, you can determine
the variance between budget data and actual data. To do so, you need to define
the saved assumption as expense or non-expense. When you define a saved
assumption as expense, Hyperion Planning calculates the variance by
subtracting the actual amount from the budgeted amount. When you define a
saved assumption as a non-expense, Hyperion Planning calculates the
variance by subtracting the budgeted amount from the actual amount.
● Time balance - for each saved assumption you create, you can determine the
ending value for the summary time period either by aggregating all values for
the summary time period, or by using the ending value for the summary time
period.
The following list contains examples of how time balance and variance reporting
properties are used with saved assumption account members:
● You may create a saved assumption of an expense type for variance reporting
that assumes that the actual amount you spent on headcount is less than the
amount you budgeted for headcount. To determine the variance, Hyperion
Planning subtracts the actual amount from the budgeted amount.

176 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

● You may make an assumption on the floor space of an office and you
determine the floor space of the office for the time period by using whatever
value you have for the end of the time period.
● You may make an assumption about the number of product units that are sold
at the end of the time period. You would therefore determine the final value
for the time period by aggregating the number of units sold across the range
of time periods.

Data Type and Exchange Rate Type


The data type and exchange rate type determine how the numeric values are stored
in the account member, and which exchange rate to use to calculate the value.
The following data type values are available:
● Currency - stores and displays the account member’s data value in the default
currency.
● Non-currency - stores and displays the account member’s data value as a
numeric value.
● Percentage - stores as a numeric value and displays the account member’s data
value as a percent.
For accounts with Currency as the data type, the following Exchange Rate types
are available:
● Average - valid for any time period; uses the average exchange rate for the
account.
● Ending - valid for any time period; uses the ending exchange rate for the
account.
● Historical - valid for any time period; uses the exchange rate that was in effect
for the account when, for example, the earnings for a Retained Earnings
account were earned or the assets for a Fixed Assets account were purchased.
8
Adding Account Members
You can add account members to the Account dimension, as well as adding
siblings and children to the existing account members.

Hyperion Planning Administrator’s Guide ■ 177


Setting Up Custom Dimensions

➤ To add an account member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimensions List hierarchy, select the Account dimension, or an
existing member of the Account dimension.
3. Do one of the following:

● If you select the Account dimension, click Add Child, , to add an


account member to the dimension.

● If you select an existing account member, click Add Sibling, , to add

a sibling account member or click Add Child, , to add a child account


member.

Note: A sibling member displays at the same level in the hierarchy as the
selected member. A child member displays one level below the selected
member in the hierarchy.

4. In the Member text box, highlight the default member name and enter a new
member name. The name can contain up to 80 characters and must be unique
across all dimensions.

Note: The member name cannot contain the Tab, double quote “, or backslash \
characters.

Note: The member name cannot start with the following characters:

‘\<|,=@_+-{}().
5. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
6. Optional: In the Alias text box, enter an alternate name for the account
member. The alias can contain up to 80 characters and must be unique across
all dimensions. the alias also requires the same naming conventions as
described above for the member name.
7. From the Account Type drop-down list, select the account type for the
account member. For more information about account types, see “Account
Types” on page 174.

178 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

8. If the account type is Saved Assumptions, click Options to select account type
options. For more information about saved assumptions, see “Saved
Assumptions” on page 176.
● In the Variance Reporting area, select one of the following options:
– Expense - designates the saved assumption as an expense account.
The actual amount is subtracted from the budgeted amount to
determine the variance.
– Non-Expense - designates the saved assumption as a revenue, asset,
liability, or equity account. The budgeted amount is subtracted from
the actual amount to determine the variance.
● In the Time Balance area, select one of the following options:
– Flow - uses an aggregate of all the data values for a summary time
period as a total for the period.
– Balance - uses the ending data value in a summary time period as the
total for the period.
● Click OK.
9. From the Exchange Rate drop-down list, select an exchange rate. For more
information about exchange rates, see “Data Type and Exchange Rate Type”
on page 177.
10. From the Data Type drop-down list, select a data type. For more information
about data types, see “Data Type and Exchange Rate Type” on page 177.
11. Select or deselect the Valid for Consolidations option. Selecting this option
flags the member as one you plan to transfer using Hyperion Application Link.
12. Optional: Click Advanced to set data storage properties used in building a
Hyperion Essbase cube. For more information about setting advanced
properties, see “Defining Advanced Properties for Account Members” on
page 180.
13. Click Assign Access. For more information about assigning access rights to 8
members, see “Assigning Access Rights to Members” on page 192.
14. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
15. Select the Plan Type tab.

Hyperion Planning Administrator’s Guide ■ 179


Setting Up Custom Dimensions

16. Select one or more plan types for which the account member is valid. For more
information about plan types, see “Account Members and Plan Types” on
page 174.

Note: Only the plan types for which the account member’s parent is valid are
available. If the parent is not valid for a particular plan type, then neither is the child
account member.

17. Select an aggregation option for each plan type you previously selected. For
more information about aggregation options, see “Aggregation Options” on
page 160.
18. Select the source plan type for the account. For more information about source
plan types, see “Account Members and Plan Types” on page 174.

Note: You can select a source plan type only if more than one plan type is valid for
the member (for example, more than one plan type is selected on the Plan Type
tab).

19. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.
20. Repeat these steps for as many members as you need to add.

Defining Advanced Properties for Account Members


➤ To define advanced properties for an account member:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List, select the account member for which you want to
define advanced properties.
3. On the Member Properties tab, click Advanced.
4. From the Data Storage drop-down list, select a data storage option. For more
information about data storage options, see “Storage Options” on page 161.
● Store - stores the data values of the member.
● Dynamic Calc - calculates the data values of the member and then
discards these values.

180 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

● Dynamic Calc and Store - calculates the data values of the member and
then stores these values.
● Never Share - prohibits two or more members in the same dimension
from sharing a data value. This option should be used for parent members
that have only one child member, so that the appropriate security can be
applied to the child member.
5. Select or deselect the Two Pass Calculation option. Selecting this option
causes Hyperion Planning to re-calculate the data values of any members that
are based on the data values of the parent member or other members.

Note: This option is available for all account members with the Dynamic Calc or
Dynamic Calc and Store properties.

6. Click OK.
7. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Modifying Account Members


You can modify the name, alias, account type, variance reporting option, time
balance option, exchange rate type, data type, plan types, source plan type, data
storage options, attributes, and custom attributes for any account member.

➤ To modify an account member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimensions List hierarchy, select the account member you want to
modify.
3. In the Member text box, highlight the default member name and enter a new
member name. The name can contain up to 80 characters and must be unique 8
across all dimensions.

Note: The member name cannot contain the Tab, double quote “, or backslash \
characters.

Note: The member name cannot start with the following characters:

‘\<|,=@_+-{}().

Hyperion Planning Administrator’s Guide ■ 181


Setting Up Custom Dimensions

4. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
5. Optional: In the Alias text box, enter an alternate name for the account
member. The alias can contain up to 80 characters and must be unique across
al dimensions. The alias also requires the same naming conventions as
described above for the member name.
6. From the Account Type drop-down list, select the account type for the
account member. For more information about account types, see “Account
Types” on page 174.
7. If the account type is Saved Assumptions, click Options to modify account
type options. For more information about saved assumptions, see “Saved
Assumptions” on page 176.
● In the Variance Reporting area, select one of the following options:
– Expense - designates the saved assumption as an expense account.
The actual amount is subtracted from the budgeted amount to
determine the variance.
– Non-Expense - designates the saved assumption as a revenue, asset,
liability, or equity account. The budgeted amount is subtracted from
the actual amount to determine the variance.
● In the Time Balance area, select one of the following options:
– Flow - uses an aggregate of all the data values for a summary time
period as a total for the period.
– Balance - uses the ending data value in a summary time period as the
total for the period.
● Click OK.
8. From the Exchange Rate drop-down list, select an exchange rate. For more
information about exchange rates, see “Data Type and Exchange Rate Type”
on page 177.
9. From the Data Type drop-down list, select a data type. For more information
about data types, see “Data Type and Exchange Rate Type” on page 177.
10. Select or deselect the Valid for Consolidations option. Selecting this option
flags the member as one you plan to transfer to Hyperion Financial
Management using Hyperion Application Link.

182 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

11. Optional: Click Advanced to set data storage properties used in building a
Hyperion Essbase cube. For more information about setting advanced
properties, see “Defining Advanced Properties for Account Members” on
page 180.
12. Click Assign Access. For more information about assigning access rights to
members, see “Assigning Access Rights to Members” on page 192.
13. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
14. Select the Plan Type tab.
15. Select one or more plan types for which the account member is valid. For more
information about plan types, see “Account Members and Plan Types” on
page 174.

Note: Only the plan types for which the account member’s parent is valid are
available. If the parent is not valid for a particular plan type, then neither is the child
account member.

16. Select an aggregation option for each plan type you previously selected. For
more information about aggregation options, see “Aggregation Options” on
page 160.
17. Select the source plan type for the account. For more information about
aggregation options, see “Aggregation Options” on page 160.

Note: You can select a source plan type only if more than one plan type is valid for
the member (for example, more than one plan type is selected on the Plan Type
tab).

18. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.
8
Deleting Account Members
Members must be deleted one at a time and a parent cannot be deleted without first
deleting its children. Deleting an account also deletes account annotations and
data. You must delete the account member throughout Hyperion Planning before

Hyperion Planning Administrator’s Guide ■ 183


Setting Up Custom Dimensions

deleting it from the Custom Dimensions task. For example, if the account member
you want to delete is used in a data entry form, you must delete it from the data
entry form before deleting it from the Custom Dimensions task.

➤ To delete an account member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List, select the account member you want to delete.
3. Select Edit > Delete Member.
4. Hyperion Planning prompts you to confirm your intention to delete the
account member. Click Yes to confirm the deletion.
5. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Note: After deleting an account member, you need to update and validate
business rules, reports, and Hyperion Application Link adapter processes.

Working with User-Defined Custom Dimensions


You can add up to 13 user-defined custom dimensions to meet the needs of your
organization. User-defined custom dimensions can help you to further capture
categories your organization uses for planning. For example, you may have a
group of accounts for operating expenses. You may decide to add a dimension
called Project so that you can budget operating expenses on a per project basis.
You add user-defined custom dimensions by defining properties, which include
name, alias, plan type, security, custom attributes, and attribute values.

CAUTION: You cannot delete custom dimensions once they have been
created.

User-defined custom dimensions differ from the Entity and Account dimensions in
that you assign valid plan types for user-defined custom dimensions at the
dimension level. You do not assign plan types to the members of a user-defined
custom dimension. All members of a user-defined custom dimension are valid for
the plan types assigned at the dimension level.

184 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

You can also add user-defined custom dimensions by performing a bulk load using
Hyperion Application Link. For more information about loading dimensions using
Hyperion Application Link, see “Importing Custom Dimension Members” on
page 219.

Adding User-Defined Custom Dimensions


➤ To add a user-defined custom dimension:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select Custom Dimensions.
3. Do one of the following:

● Click Add Child, .


● Select Task > Add Child.
4. In the Dimension text box, enter the name of the dimension. The name can
contain up to 80 characters and must be unique across all dimensions.

Note: The dimension name cannot contain the Tab, double quote “, or backslash
\ characters.

Note: The dimension name cannot start with the following characters:

‘\<|,=@_+-{}().
5. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
6. Optional: In the Alias text box, enter an alternate name for the dimension.
The alias can contain up to 80 characters and must be unique across all
dimensions. The alias also requires the same naming conventions as described
above for the dimension name.
8
7. Select the plan types for which the dimension is valid.
8. Select the Apply Security option to allow security to be set up on custom
dimension members.

Hyperion Planning Administrator’s Guide ■ 185


Setting Up Custom Dimensions

9. Optional: Click Advanced to define how data values are stored in Hyperion
Planning. For more information about defining advanced properties for a
dimension, see “Defining Advanced Properties for User-Defined Dimensions
and Members” on page 191.
10. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
11. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Modifying User-Defined Custom Dimensions


➤ To modify a user-defined custom dimension:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select the user-defined custom dimension
you want to modify.
3. In the Dimension text box, enter the name of the dimension. The name can
contain up to 80 characters and must be unique across all dimensions.

Note: The dimension name cannot contain the Tab, double quote “, or backslash
\ characters.

Note: The dimension name cannot start with the following characters:

‘\<|,=@_+-{}().
4. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
5. Optional: In the Alias text box, enter an alternate name for the dimension.
The alias can contain up to 80 characters and must be unique across all
dimensions. The alias also requires the same naming conventions as described
above for the dimension name.
6. Select the plan types for which the dimension is valid.
7. Select the Apply Security option to allow security to be set up on custom
dimension members.

186 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

8. Optional: Click Advanced to define how data values are stored in Hyperion
Planning. For more information about defining advanced properties for a
dimension, see “Defining Advanced Properties for User-Defined Dimensions
and Members” on page 191.
9. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
10. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Adding User-Defined Custom Dimension Members


➤ To add a user-defined custom dimension member:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimensions List hierarchy, select a user-defined custom dimension, or
an existing member of a user-defined custom dimension.
3. Do one of the following:

● If you select a user-defined custom dimension, click Add Child, , to


add a member to the dimension.

● If you select an existing member, click Add Sibling, , to add a sibling

member or click Add Child, , to add a child member.

Note: A sibling member displays at the same level in the hierarchy as the
selected member. A child member displays one level below the selected
member in the hierarchy. 8

Hyperion Planning Administrator’s Guide ■ 187


Setting Up Custom Dimensions

4. In the Member text box, highlight the default member name and enter a new
member name. The name can contain up to 80 characters and must be unique
across all dimensions.

Note: The member name cannot contain the Tab, double quote “, or backslash \
characters.

Note: The member name cannot start with the following characters:

‘\<|,=@_+-{}().
5. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
6. Optional: In the Alias text box, enter an alternate name for the member. The
alias can contain up to 80 characters and must be unique across all dimensions.
The alias also requires the same naming conventions as described above for
the member name.
7. Select or deselect the Valid for Consolidations option. Selecting this option
flags the member as one you plan to transfer to Hyperion Financial
Management using Hyperion Application Link.
8. Optional: Click Advanced to define how data values are stored in Hyperion
Planning. For more information about defining advanced properties for a
member, see “Defining Advanced Properties for User-Defined Dimensions
and Members” on page 191.
9. Click Assign Access. For more information about assigning access rights to
members, see “Assigning Access Rights to Members” on page 192.
10. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
11. Select the Plan Type tab.
12. Select an aggregation option for each plan type that is available. For more
information about aggregation options, see “Aggregation Options” on
page 160.
13. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

188 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

14. Repeat these steps for as many members as you need to add.

Note: After adding a user-defined custom dimension member, you need to update
and validate business rules, reports, and Hyperion Application Link adapter
processes.

Modifying User-Defined Custom Dimension


Members
➤ To modify a user-defined custom dimension member:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimensions List hierarchy, select the member you want to modify.
3. In the Member text box, highlight the default member name and enter a new
member name. The name can contain up to 80 characters and must be unique
across all dimensions.

Note: The member name cannot contain the Tab, double quote “, or backslash \
characters.

Note: The member name cannot start with the following characters:

‘\<|,=@_+-{}().
4. Optional: From the Alias Table drop-down list, select the alias table to store
the alias name.
5. Optional: In the Alias text box, enter an alternate name for the member. The
alias can contain up to 80 characters and must be unique across all dimensions.
The alias also requires the same naming conventions as described above for
the member name.
6. Select or deselect the Valid for Consolidations option. Selecting this option
flags the member as one you plan to transfer to Hyperion Financial 8
Management using Hyperion Application Link.
7. Optional: Click Advanced to define how data values are stored in Hyperion
Planning. For more information about defining advanced properties for a
member, see “Defining Advanced Properties for User-Defined Dimensions
and Members” on page 191.

Hyperion Planning Administrator’s Guide ■ 189


Setting Up Custom Dimensions

8. Click Assign Access. For more information about assigning access rights to
members, see “Assigning Access Rights to Members” on page 192.
9. Select the Custom Attributes tab. For more information about using
attributes and attribute values, see “Working with Attributes” on page 195 and
“Working with Attribute Values” on page 198.
10. Select the Plan Type tab.
11. Select an aggregation option for each plan type that is available. For more
information about aggregation options, see “Aggregation Options” on
page 160.
12. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Deleting User-Defined Custom Dimension Members


Members must be deleted one at a time and a parent cannot be deleted without first
deleting its children. You must delete the member throughout Hyperion Planning
before deleting it from the Custom Dimensions task. For example, if the member
you want to delete is used in a data entry form, you must delete it from the data
entry form before deleting it from the Custom Dimensions task.

➤ To delete a user-defined custom dimension member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List hierarchy, select the member you want to delete.
3. Select Edit > Delete Member.
4. Hyperion Planning prompts you to confirm your intention to delete the
member. Click Yes to confirm the deletion.
5. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Note: After deleting a user-defined custom dimension member, you need to


update and validate business rules, reports, and Hyperion Application Link adapter
processes.

190 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

Defining Advanced Properties for User-Defined


Dimensions and Members
➤ To define how data values are stored in Hyperion Planning:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List hierarchy, select the user-defined dimension or
member for which you want to define advanced properties.
3. Click Advanced.
4. From the Data Storage drop-down list, select a data storage option. For more
information about data storage, see “Storage Options” on page 161.
● Store - stores the data values of the member.
● Dynamic Calc - calculates the data values of the member and then
discards these values.
● Dynamic Calc and Store - calculates the data values of the member and
then stores these values.
● Never Share - prohibits two or more members in the same dimension
from sharing a data value. This option should be used for parent members
that have only one child member, so that the appropriate security can be
applied to the child member.
● Share - this option is not available for user-defined dimensions.
5. Click OK.
6. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Working with Members 8


After you create members for the various custom dimensions, you can assign
access rights to those members, rearrange the member hierarchy within the
dimensions, and share Entity members. Only members of the Entity dimension can
be shared.

Hyperion Planning Administrator’s Guide ■ 191


Setting Up Custom Dimensions

Assigning Access Rights to Members


You can specify access rights for the members of the Entity, Account, and
user-defined custom dimensions for groups or users. Access rights determine
whether or not a user or group can view and/or modify data. A user or group can
have only one of the following access rights: Read, Write, or None. However, the
access rights for an individual user can be combined based on the groups to which
that user belongs.
When assigning access rights to a specific member, you can also specify an
attribute that causes the children or descendants of that member to inherit its access
rights. In addition, when specifying inheritance attributes, you can include or
exclude the actual member from the access rights setting. The following table
illustrates the available inheritance options.
Table 5: Access Rights Inheritance Options

Inheritance Option Result

Member The access right is assigned only to the currently selected


member.
Children The access right is assigned to all children members in the
level below the currently selected member.
iChildren The access right is assigned to the currently selected
member and all children members in the level below it.
Descendant The access right is assigned to all descendant members
below the currently selected member.
iDescendant The access right is assigned to the currently selected
member and all descendant members below it.

➤ To assign access rights to a member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimension List hierarchy, select the member to which you want to
assign access rights.
3. Click Assign Access.

4. Click Add User/Group, .

192 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

5. Select a user or group to which you want to add access rights.


6. Select the type of access right you want to assign to the user or group for this
particular member.
● Read - permits read access to this particular member for the user or group
● Write - permits read and write access to this particular member for the
user or group
● None - prevents access to this particular member for the user or group
7. From the Relationship drop-down list, select a relationship.
8. Click OK.
9. Click OK.
10. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Modifying Access Rights


➤ To modify access rights for a member:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimension List hierarchy, select the member to which you want to
modify access rights.
3. Click Assign Access.
4. Select a user or group for which you want to modify access rights.

5. Click Edit, .
6. Select the type of access right you want to assign to the user or group for this 8
particular member.
● Read - permits read access to this particular member for the user or group
● Write - permits read and write access to this particular member for the
user or group
● None - prevents access to this particular member for the user or group

Hyperion Planning Administrator’s Guide ■ 193


Setting Up Custom Dimensions

7. From the Relationship drop-down list, select a relationship.


8. Click OK.
9. Click OK.
10. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Deleting Access Rights


➤ To delete access rights for a member:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimension List hierarchy, select the member for which you want to
delete access rights.
3. Click Assign Access.
4. Select a user or group for which you want to delete access rights.
5. Click Delete.
6. Click Yes to confirm your intention to delete the access rights.
7. Click OK.
8. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Moving Members within the Dimension Hierarchy


After you define members and their properties, you can change their order in the
dimension hierarchy.

➤ To move members within the dimension hierarchy:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. From the Dimensions List hierarchy, select the member you want to move.
3. Do one of the following:

194 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

● Click Promote Member to move the member to the next highest level in
the dimension hierarchy. You cannot promote a member to a dimension,
nor can you promote shared members (for the Entity dimension only).
● Click Demote Member to move the member to the next lowest level in
the dimension hierarchy. If a member has no siblings, you cannot demote
that member.
● Click Move Up to move the member up in the dimension list within the
same hierarchical level. You cannot move a member up if it has no
siblings.
● Click Move Down to move the member down in the dimension list within
the same hierarchical level. You cannot move a member down if it has no
siblings.
4. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Note: After moving members within the dimension hierarchy, you need to update
and validate business rules, reports, and Hyperion Application Link adapter
processes.

Working with Attributes


Attributes let you add another level of granularity to your data. You create
attributes for a dimension when you want to group its members according to the
same criterion. You then create attribute values for each attribute, which are
assigned to dimension members.
You can filter members by their attribute values when creating forms and reports.
For example, you may have a Product dimension with members for three product
lines, some of which are sold in retail outlets and some sold only by catalog. When
you are analyzing or reporting on your data, you might need separate totals for
retail and catalog sales. To gather this type of information, you could define an 8
attribute called Channel for the Product dimension, with the values Retail and
Catalog. You could then assign one of these values to each of the members in the
Product dimension that you need to categorize.
Attributes must be assigned to sparse dimensions. Because the Account dimension
is usually defined as a dense dimension, you cannot assign attributes to the
Account dimension. If you must assign attributes to the Account dimension,

Hyperion Planning Administrator’s Guide ■ 195


Setting Up Custom Dimensions

change it to a sparse dimension. For more information on changing the


sparsity/density option for a dimension, see “Optimizing Application
Performance” on page 76.

Defining Attributes
Hyperion Planning allows you to define attributes at the dimension level. Once
you define an attribute for a dimension, you can define the values for that attribute
and assign those values to dimension members.

➤ To define an attribute:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select a dimension for which you want to
define an attribute.

Note: Only sparse dimensions can contain attributes. Therefore, if the dimension
you select is not a sparse dimension, the Custom Attributes tab is not available.

3. Select the Custom Attributes tab.


4. Click New.
5. In the Name text box, enter a name of up to 32 characters that is unique.

Note: The attribute value name cannot contain the Tab, double quote “, or
backslash \ characters.

Note: The attribute value name cannot start with the following characters:

‘\<|,=@_+-{}().
6. Click OK.
7. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

196 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

Modifying Attributes
➤ To modify an attribute:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select the dimension that contains the
attribute you want to modify.

Note: Only sparse dimensions can contain attributes. Therefore, if the dimension
you select is not a sparse dimension, the Custom Attributes tab is not available.

3. Select the Custom Attributes tab.


4. From the Custom Attributes list, select the attribute you want to modify.
5. Click Edit Values.
6. From the Attribute drop-down list, select the attribute you want to modify.
7. Do one of the following:
● Define a new attribute value. For more information on defining attribute
values, see “Defining Attribute Values” on page 198.
● Modify an attribute value. For more information on modifying attribute
values, see “Modifying Attribute Values” on page 200.
● Delete an attribute value. For more information on deleting attribute
values, see “Deleting Attribute Values” on page 201.
8. Click OK.
9. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Note: After modifying an attribute, you need to update and validate business rules,
reports, and Hyperion Application Link adapter processes. 8

Deleting Attributes
When you delete an attribute, all attribute values associated with the attribute are
also deleted. The attribute values are removed from any members to which they
had been assigned, and the attribute is removed from any dimensions to which it
had been assigned.

Hyperion Planning Administrator’s Guide ■ 197


Setting Up Custom Dimensions

➤ To delete an attribute:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select the dimension whose attribute you
want to delete.

Note: Only sparse dimensions can contain attributes. Therefore, if the dimension
you select is not a sparse dimension, the Custom Attributes tab is not available.

3. Select the Custom Attributes tab.


4. Select the attribute you want to delete.
5. Click Delete.
6. Click Yes to confirm your intention to delete the attribute.
7. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Note: After deleting an attribute, you need to update and validate business rules,
reports, and Hyperion Application Link adapter processes.

Working with Attribute Values


When you define an attribute, you can also define values for the attribute, which
enables you to add another level of granularity to the data. For example, you may
have a Product dimension, with the members Sodas, Juices, and Coffees. You can
then create the Size attribute with the following attribute values: Small, Medium,
and Large. After you create the attribute and attribute values, you can assign the
attribute values to each member of the Product dimension.
When you assign attribute values to dimension members, they must all be assigned
at the same level in the hierarchy.
Data values for attributes are dynamically calculated, but not stored.

Defining Attribute Values


You can define attribute values for the Account, Entity, and user-defined custom
dimensions. Once you define an attribute value for a dimension, you then assign it
to the members of that dimension.

198 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

➤ To define an attribute value:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select a dimension that contains the attribute
for which you want to define attribute values.

Note: Only sparse dimensions can contain attributes. Therefore, if the dimension
you select is not a sparse dimension, the Custom Attributes tab is not available.

3. Select the Custom Attributes tab.


4. From the Custom Attributes list, select the attribute for which you want to
define an attribute value.
5. Click Edit Values.
6. From the Attribute drop-down list, select the attribute for which you want to
define an attribute value.
7. Click New.
8. In the Name text box, enter a name of up to 32 characters that is unique.

Note: The attribute value name cannot contain the Tab, double quote “, or
backslash \ characters.

Note: The attribute value name cannot start with the following characters:

‘\<|,=@_+-{}().
9. Press Enter.
10. Click OK.
11. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.
8
Assigning Attribute Values to Members
You can define attribute values for Custom Dimensions. Once you define an
attribute value for a dimension, you then assign it to the members of that
dimension.

Hyperion Planning Administrator’s Guide ■ 199


Setting Up Custom Dimensions

➤ To assign an attribute value to a member:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select a member to which you want to assign
an attribute value.
3. Select the Custom Attributes tab.
4. Click Assign Attribute Values.
5. From the Attributes list, select the attribute that contains the value you want
to assign to the member.
6. From the Values For list, select the attribute value you want to assign to the
member.
7. Click Assign.
8. Click OK.

Note: Attribute values for a given attribute must be assigned to the same-level
sparse custom dimension members. Assigning an attribute value to a different level
will cause an error during the application refresh.

9. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Modifying Attribute Values


➤ To modify an attribute value:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select a dimension that contains the attribute
for which you want to modify an attribute value.

Note: Only sparse dimensions can contain attributes. Therefore, if the dimension
you select is not a sparse dimension, the Custom Attributes tab is not available.

3. Select the Custom Attributes tab.


4. From the Custom Attributes list, select the attribute that contains the
attribute value you want to modify.

200 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

5. Click Edit Values.


6. From the Attribute drop-down list, select the attribute that contains the
attribute value you want to modify.
7. From the Attribute Values list, select the attribute value you want to modify.
8. Click Edit Values and modify the attribute value name. The attribute value
name can contain up to 32 characters and must be unique.

Note: The attribute value name cannot contain the Tab, double quote “, or
backslash \ characters.

Note: The attribute value name cannot start with the following characters:

‘\<|,=@_+-{}().
9. Click OK.
10. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Deleting Attribute Values


When you delete an attribute value, it is removed from any Custom Dimension
members to which it is assigned. For example, you may have a Size attribute, with
an attribute value of Small. And the attribute value Small has been assigned to the
dimension members Sodas and Juices. When you delete the attribute value Small,
it is removed from the members Sodas and Juices. However, since the values for
small are dynamically calculated, no data values are lost.

➤ To delete an attribute value:


1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Custom Dimensions.
2. In the Dimension List hierarchy, select a dimension that contains the attribute
8
for which you want to delete an attribute value.

Note: Only sparse dimensions can contain attributes. Therefore, if the dimension
you select is not a sparse dimension, the Custom Attributes tab is not available.

3. Select the Custom Attributes tab.

Hyperion Planning Administrator’s Guide ■ 201


Setting Up Custom Dimensions

4. From the Custom Attributes list, select the attribute that contains the
attribute value you want to delete.
5. Click Edit Values.
6. From the Attribute drop-down list, select the attribute that contains the
attribute value you want to delete.
7. From the Attribute Values list, select the attribute value you want to delete.
8. Click Delete.
9. Click OK.
10. Click Save if you are not using Hyperion Planning’s Autosave feature. For
more information about the Autosave feature, see “Saving Changes to
Dimensions and Members” on page 164.

Note: After deleting an attribute value, you need to update and validate business
rules, reports, and Hyperion Application Link adapter processes.

Using Attributes and Attribute Values


After you assign attributes to Custom Dimensions and attribute values to Custom
Dimension members, it is important to understand how they are used within
Hyperion Planning, and with other Hyperion products.

Using Attributes and Attribute Values in Hyperion


Planning Data Entry Forms
Attribute values provide users with another way of selecting dimension members
when they are using Web-based data entry forms. For example, users can select to
include all the customers with the “Fortune 500” attribute value. When users select
two or more custom attribute values from the same attribute, they behave as they
would in an “OR” statement. For example, if a user selected to include members
with the attribute values “Fortune 500” and “Fortune 1000” from the “Customers”
attribute, all members with either the “Fortune 500” OR the “Fortune 1000”
attribute values display.
When users select two or more custom attribute values from different attributes,
they behave as they would in an “AND” statement. For example, if a user selected
to include members with the attribute values “Fortune 500” from the “Customers”
attribute and “Northeast” from the “Region” attribute, all members with both the
“Fortune 500” and “Northeast” attribute values display.

202 ■ Hyperion Planning Administrator’s Guide


Setting Up Custom Dimensions

When users select a base member and an associated custom attribute member, they
behave as they would in an “AND” statement. For example, if a user selected the
“North America” base member and its descendants, and the user selected the
“Population equals 250,000” custom attribute value, all members that are both in
“North America” and have the “Population equals 250,000” attribute value
display.

Using Attributes and Attribute Values in Hyperion


Application Link
You can use Hyperion Application Link to load attribute values. However,
Hyperion Application Link only supports loading attribute values to existing
attributes. Therefore, you must create attributes before you load attribute values.

Hyperion Planning Administrator’s Guide ■ 203


Setting Up Custom Dimensions

204 ■ Hyperion Planning Administrator’s Guide


Chapter Setting Up Scenarios and

9 Versions

This section describes how to create scenarios to group the application into
separate plans with their own review cycles. This section also describes how to
create versions, which allow for many iterations of a plan.

About Scenarios and Versions


You use the Scenarios and Version dimensions to create individual plans to be
reviewed and approved. Each scenario/version combination contains its own set of
data for the accounts and other dimensions of each entity. After users complete
data entry for an entity for a specific scenario and version, they can submit or
promote the data for the entity to another user for review and approval. The
intersection of entity, scenario, and version is referred to as a planning unit.
Hyperion Planning tracks the status of each planning unit as it moves through the
review process.

Setting Up Scenarios
Hyperion Planning allows you to create scenarios to group data that an application
uses. Scenarios enable you to:
● Apply different planning methods to scenarios.
● Create new forecasts.
● Enter data into scenarios.
● Associate different scenarios with different time periods.
● Associate different scenarios with different exchange rates. 9
● Assign user access rights by scenario.
● Report on certain scenarios.

Hyperion Planning Administrator’s Guide ■ 205


Setting Up Scenarios and Versions

● Compare and analyze different scenarios.

Creating Scenarios
Creating scenarios lets you group your application into separate plans with their
own review cycles. Scenarios can also cover different time spans. For example,
your organization may create one year and three year revenue plans that are
prepared by different users and follow different review paths. You could create two
scenarios, Current Year Revenue and 3Year Revenue Forecast for this purpose.
When you create a scenario, you define these properties:
● Time periods
● Exchange rate table
● Access rights

Time Periods
You assign each scenario a range of years and time periods for which it is
valid.You can also specify whether or not to use the Beginning Balance time
period for a scenario. When users access a data entry form, they can enter into that
scenario only years and periods that are within the range. Years and periods outside
of the range display as read-only.
You can modify the time range of scenarios as needed to allow for continuous
planning. For example, you may have a scenario named 3Year Forecast that has
2002 as the start year and 2004 as the end year. At the beginning of the 2003 fiscal
year, you could advance the start year to 2003 and the end year to 2005. You could
then enter forecast data for 2005.

Exchange Rate Table


If an application converts currencies, you assign an exchange rate table to the
scenario. By assigning different exchange rate tables to scenarios, you can model
the effect that different assumptions about currency rates have on your business.

206 ■ Hyperion Planning Administrator’s Guide


Setting Up Scenarios and Versions

Access Rights
You can specify access rights to the members of the Scenario dimension for groups
or users. Access rights determine whether or not a user or group can view and/or
modify data. A user or group can have only one of the following access rights:
Read, Write, or None. However, the access rights for a user can be combined based
on the groups to which that user belongs.

Adding a Scenario
➤ To add a scenario:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Scenarios.
2. Do one of the following:

● Click New Scenario, .


● Select Task > New Scenario.
3. In the Scenario text box, enter a name of up to 80 characters for the new
scenario.
4. Optional: In the Description text box, enter a description of up to 255
characters for the new scenario.
5. Select the Include BegBalance as time period option if you want to include
the BegBalance time period in this scenario for currency conversion.
6. From the Start Period, Start Year, End Period, and End Year drop-down
lists, select the time period you want to associate with the new scenario.
7. Optional: From the Exchange Rate Table drop-down list, select an exchange
rate table to associate with the new scenario.

Note: If an application uses multiple currencies, you should associate a scenario


with an exchange rate table so that currency conversions can be calculated.

8. Click Assign Access to assign access rights to the scenario member. For more
information about assigning access rights, see “Setting Access Rights for
Scenarios and Versions” on page 215. 9
Note: Assigning access rights to a scenario lets you control access to the data
values associated with the scenario.

Hyperion Planning Administrator’s Guide ■ 207


Setting Up Scenarios and Versions

9. Click OK.

Modifying a Scenario
➤ To modify a scenario:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Scenarios.
2. Do one of the following:

● Click Edit Scenario, .


● Select Task > Edit Scenario.
3. In the Scenario text box, enter a name of up to 80 characters for the scenario.
4. Optional: In the Description text box, enter a description of up to 255
characters for the scenario.
5. Select the Include BegBalance as time period option if you want to include
the BegBalance time period in this scenario for currency conversion.
6. From the Start Period, Start Year, End Period, and End Year drop-down
lists, select the time period you want to associate with the scenario.
7. Optional: Use the Exchange Rate Table drop-down list to select an
exchange rate table to associate with the scenario.

Note: If an application uses multiple currencies, you should associate a scenario


with an exchange rate table so that currency conversions can be calculated.

8. Click Assign Access to assign access rights to the scenario member. For more
information about assigning access rights, see “Setting Access Rights for
Scenarios and Versions” on page 215.

Note: Assigning access rights to a scenario lets you control access to the data
values associated with the scenario.

9. Click OK.

208 ■ Hyperion Planning Administrator’s Guide


Setting Up Scenarios and Versions

Deleting a Scenario
When you delete a scenario, all planning units that use the scenario (including
data) are deleted. Also, you cannot delete a scenario that is assigned to an axis on
a data entry form. You first need to remove the reference to the scenario from the
data entry form and then assign a different scenario to an axis on the form.

➤ To delete a scenario:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Scenarios.
2. Do one of the following:

● Click Delete Scenario, .


● Select Task > Delete Scenario.
3. You are prompted to confirm your intention to delete the scenario. Click Yes.

Note: After deleting a scenario, you need to update and validate business rules,
reports, and Hyperion Application Link adapter processes.

Copying a Scenario
When you select to copy a scenario, only the scenario properties are copied. The
data values and access rights associated with the original scenario are not copied
to the new scenario.

➤ To copy a scenario:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Scenarios.
2. From the list of scenarios, select the scenario you want to copy.
3. Do one of the following:

● Click Copy Scenario, .


● Select Task > Copy Scenario.
4. In the Scenario text box, enter a name of up to 80 characters for the new
9
scenario.

Hyperion Planning Administrator’s Guide ■ 209


Setting Up Scenarios and Versions

5. Optional: In the Description text box, enter a description of up to 255


characters for the new scenario.
6. Select the Include BegBalance as time period option if you want to include
the BegBalance time period in this scenario for currency conversion.
7. From the Start Period, Start Year, End Period, and End Year drop-down
lists, select the time period you want to associate with the new scenario.
8. Optional: Use the Exchange Rate Table drop-down list to select an
exchange rate table to associate with the new scenario.

Note: If an application uses multiple currencies, you should associate a scenario


with an exchange rate table so that currency conversions can be calculated.

9. Click Assign Access to assign access rights to the scenario member. For more
information about assigning access rights, see “Setting Access Rights for
Scenarios and Versions” on page 215.

Note: Assigning access rights to a scenario lets you control access to the data
values associated with the scenario.

10. Click Copy.

Setting Up Versions
Versions allow flexibility in the planning process and are independent of
individual scenarios. For example, if you create Best Case and Worst Case
versions in the Version dimension, you can use these versions with any of the
scenarios that you created. The following lists some possible uses of versions:
● To allow multiple iterations of a plan, for example, Preliminary and Final
● To model possible outcomes based on more optimistic or less optimistic
assumptions, for example, Best Case and Worst Case
● To manage dissemination of plan data, for example, Internal and External
● To facilitate target settings

210 ■ Hyperion Planning Administrator’s Guide


Setting Up Scenarios and Versions

Target and Bottom Up Versions


You can create two types of versions, target or bottom up. With bottom up
versions, you enter data into the bottom level members. Parent level members in
bottom up versions are display-only and do not permit data entry. Values for parent
members are automatically aggregated from the bottom level members. For
example, data is entered for Northern Europe and Southern Europe, and the total
for Europe is the aggregated result.
For target versions, you can enter data for members at any level in the hierarchy.
You can then use business rules to distribute values from parent members to their
descendants. For example, you can enter the target for Total Expenses into the
Europe member and use a business rule to distribute the target values to Northern
and Southern Europe based on their headcount.
Target versions allow you to set high-level targets for your plan. Planners working
with bottom up versions can then reference these targets when they enter plan data.
For example, the Total Product Sales member might have Retail, Wholesale, and
Distributors for its children. A budget manager may enter 10,000 into Total
Product Sales for the California entity in a target version. This sets California’s
target for product sales. The budget preparer for California could then enter a
combination of values for Retail, Wholesale, and Distributor that total to 10,000
into a bottom up version to show how the target will be met.
The functionality available with target versions is for tops down budgeting.
However, take the following into consideration when using target versions:
● Workflow Tasks are not allowed for target versions.
● Children of target members must be blank (for example, #missing) for the data
input to be allowed at the top level.
● Target members must be set to Store (Dynamic Calc overrides data input with
sum of children).

Adding a Version
➤ To add a version:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Versions.
9
2. Do one of the following:

Hyperion Planning Administrator’s Guide ■ 211


Setting Up Scenarios and Versions

● Click New Version, .


● Select Task > New Version.
3. In the Number of Versions text box, enter the number of versions you are
adding to the application.
4. From the Version Type drop-down list, select the type of version for the
application.
● Standard Target - displays versions whose values are entered from the
parent level down.
● Standard Bottom Up - displays versions whose values are entered at the
lowest member level and aggregated upward. Standard bottom up
versions are a dimension in a planning unit.
5. Click Assign Access to assign access rights to this version. For more
information about assigning access rights, see “Setting Access Rights for
Scenarios and Versions” on page 215.

Note: Assigning access rights to a version lets you control access to the data
values associated with the version.

6. Click OK.

Modifying a Version
You can edit an existing version to change the name of a version and the access
rights assigned to the version. You can assign access rights to a version to specify
which users have access to the version. For example, you may want to give users
read-only access to the version Final. To modify the version type or the version
owner, you must delete the version and add a new version.

➤ To modify a version:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Versions.
2. In the Versions window, select the version you want to modify.
3. Do one of the following:

● Click Edit Version, .

212 ■ Hyperion Planning Administrator’s Guide


Setting Up Scenarios and Versions

● Select Task > Edit Version.


4. In the Name text box, enter a new version name.

Note: Hyperion Planning automatically generates a unique name for each version
you create. You can modify that name after the version is created.

5. Click Assign Access to assign access rights to this version. For more
information about assigning access rights, see “Setting Access Rights for
Scenarios and Versions” on page 215.

Note: Assigning access rights to a version lets you control access to the data
values associated with the version.

6. Click OK.

Note: After modifying a version, you need to update and validate business rules,
reports, and Hyperion Application Link adapter processes.

Deleting a Version
You cannot delete a version that is currently assigned to an axis on a data entry
form. You must first remove the reference to the version from the data entry form
and then assign another version to an axis on the form.

➤ To delete a version:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Versions.
2. In the Versions window, select the version you want to delete.
3. Do one of the following:

● Click Delete Version, .


● Select Task > Delete Version.
4. You are prompted to confirm your intention to delete the version. Click Yes.

Note: When you delete a standard bottom up version, all planning units
associated with the version (including their data) are deleted. 9
Note: After deleting a version, you need to update and validate business rules,
reports, and Hyperion Application Link adapter processes.

Hyperion Planning Administrator’s Guide ■ 213


Setting Up Scenarios and Versions

Viewing Versions
➤ To view a version:
1. From the navigation frame on the Desktop, double-click Hyperion Planning
> Manage Dimensions > Versions.

Note: By default, all existing versions display.

2. In the Show Versions area at the bottom of the Versions window, select the
version types you want to display.
● Select Standard Target to display versions whose values are entered
from the parent level down.
● Select Standard Bottom Up to display versions whose values are entered
at the lowest member level and aggregated up.

Copying Versions
You can copy versions using the Hyperion Planning Web client. You use the Copy
Versions page to copy data from one bottom-up or target version of a selected
scenario to another bottom-up or target version within the same scenario. You can
copy between bottom-up and target versions, but keep in mind the following:
● When you copy to a bottom-up version, only selected level zero entities are
copied.
● When you copy to a target version, all selected entities are copied.
For example, you can create a Best Case version and then copy some or all of the
data in that version to a Worst Case version to quickly create a starting point for
the new version.

➤ To copy a version:
1. Open an application in the Hyperion Planning Web client.
2. From the Hyperion Planning Home page, click Copy Versions.
3. In the Scenario drop-down list, select the scenario you want to copy.
4. In the Copy From drop-down list, select the version from which you want to
copy data.

214 ■ Hyperion Planning Administrator’s Guide


Setting Up Scenarios and Versions

5. In the Copy To drop-down list, select the version into which you want to copy
data.
6. Click Go.

Note: The entities for the selected version display in the Available Entities list.

7. In the Available Entities list, select the entities to which you want to copy
data.

Note: The Available Entities list displays only the entities to which you have write
access.

8. Click > to add the selected entity to the Selected Entities list or click >> to
add all of the entities in the Available Entities list. Click < to remove a
selected entity from the list, or click << to remove all entities from the list.
9. Repeat steps 7 and 8 until the Selected Entities list is complete.
10. Optional: To copy any comments or annotations that are associated with
accounts, select the Copy Account Annotations check box.
11. Optional: To copy any supporting details that are associated with versions,
select the Copy Supporting Details check box.

Note: Only annotations for selected entities are copied. If you are copying to a
bottom-up version, only level zero entities and their annotations are copied.

12. Click Copy Data.

Setting Access Rights for Scenarios and


Versions
You can specify access rights to the members of the Scenario and Version
dimension for groups or individual users that are either planners or interactive
users. Access rights determine whether or not a user or group can view and/or
modify data. A user or group can have only one of the following access rights:
Read, Write, or None. However, the access rights for an individual user can be
combined based on the groups to which that user belongs.
9

Hyperion Planning Administrator’s Guide ■ 215


Setting Up Scenarios and Versions

Assigning Access Rights to Members


➤ To add access rights for a member:
1. Do one of the following:
– From the navigation frame on the Desktop, double-click Hyperion
Planning > Manage Dimensions > Versions.
– From the navigation frame on the Desktop, double-click Hyperion
Planning > Manage Dimensions > Scenarios.
2. Select the member for which you want to assign access rights.

3. Click Edit, .
4. Click Assign Access.

5. Click New, .
6. Select a user or group for which you want to add access rights.
7. Select the type of access right you want to assign to the user or group for this
particular member.
● Read - permits read access to this particular member for the user or group
● Write - permits read and write access to this particular member for the
user or group
● None - prevents access to this particular member for the user or group
8. Click OK.
9. Click OK.

Modifying Access Rights for Members


➤ To modify access rights for a version:
1. Do one of the following:
– From the navigation frame on the Desktop, double-click Hyperion
Planning > Manage Dimensions > Versions.
– From the navigation frame on the Desktop, double-click Hyperion
Planning > Manage Dimensions > Scenarios.

216 ■ Hyperion Planning Administrator’s Guide


Setting Up Scenarios and Versions

2. Select the member for which you want to modify access rights.

3. Click Edit, .
4. Click Assign Access.
5. Select a user or group for which you want to modify access rights.

6. Click Edit, .
7. Select the type of access right you want to assign to the user or group for this
particular member.
● Read - permits read access to this particular member for the user or group
● Write - permits read and write access to this particular member for the
user or group
● None - prevents access to this particular member for the user or group
8. Click OK.
9. Click OK.

Deleting Access Rights for a Member


➤ To delete access rights for a member:
1. Do one of the following:
– From the navigation frame on the Desktop, double-click Hyperion
Planning > Manage Dimensions > Versions.
– From the navigation frame on the Desktop, double-click Hyperion
Planning > Manage Dimensions > Scenarios.
2. Select the member for which you want to delete access rights.

3. Click Edit Version, .


4. Click Assign Access.
5. Select a user or group for which you want to delete access rights. 9
6. Click Delete.

Hyperion Planning Administrator’s Guide ■ 217


Setting Up Scenarios and Versions

7. You are prompted to confirm your intention to delete the access rights for the
user or group. Click Yes.
8. Click OK.

218 ■ Hyperion Planning Administrator’s Guide


Chapter Loading Members and Data

10
This section describes how to populate Hyperion Planning applications with
members and data from external systems.

Importing Custom Dimension Members


Custom dimensions, such as the Account dimension, often have large numbers of
members. To save time, you can import members for a custom dimension from an
external system, such as your ledger system. You can use Hyperion Application
Link to load members for custom dimensions into Hyperion Planning applications.
When you import members, any that do not currently exist in the Hyperion
Planning application are added to it. If a member being imported already exists in
the application, the member is updated with the property settings from the import
file (for example, including modifications to the rollup structure).
When you use Hyperion Application Link to import members into a Hyperion
Planning application, they are imported into a relational database that stores the
application definition. You must refresh the Hyperion Planning application before
the new members are available to end users.
Often, your external system contains data for many of the member properties for
the custom dimension, such as account type. However, it may not have information
about some properties, such as parent/child relationships or the plan type. You can
use Hyperion Translation Manager to modify information before loading the
members into a Hyperion Planning application.

Note: You cannot use Hyperion Application Link to export data values from Hyperion
Planning.

10
Hyperion Planning Administrator’s Guide ■ 219
Loading Members and Data

Quick Steps for Importing Custom Dimension Members


This chapter covers how to import custom dimension members into a Hyperion
Planning application. Listed below are the basic procedures.
1. Export custom dimension data from an external system, such as a general
ledger.
2. Modify the source data using Hyperion Translation Manager to meet the data
requirements of the Hyperion Planning application.
3. Use Hyperion Application Link (which includes using the Hyperion Planning
Adapter and the flat file Adapter) to load the custom dimension data into a
Hyperion Planning application. The Hyperion Planning Log On page must be
loaded before you can connect to the Hyperion Planning server through
Hyperion Application Link.
4. Refresh Hyperion Planning.

Using Hyperion Application Link


Hyperion Application Link is a suite of application integration services that
dramatically reduces the time and expense of integrating external source data with
Hyperion’s business analysis software. Using Hyperion Application Link,
organizations can quickly deploy flexible, adaptable, and reusable integration
solutions that seamlessly and transparently connect Hyperion’s business analysis
software with various data sources.
You can use Hyperion Application Link to load accounts, entities, and custom
dimensions from any flat file or ODBC-compliant database into Hyperion
Planning. You can also use Hyperion Application Link to load the same data into
Hyperion Planning directly from an Enterprise Resource Planning (ERP) system
such as SAP, J.D. Edwards World, or J.D. Edwards OneWorld.
Hyperion Application Link provides you with a graphical user interface that makes
it easy for you to create seamless integration from your source system into
Hyperion Planning. It includes a wizard, called Hyperion Translation Manager,
that helps you map your source data into Hyperion Planning equivalents.

220 ■ Hyperion Planning Administrator’s Guide


Loading Members and Data

Using Flow Diagrams


To load data into a Hyperion Planning application, you must create a flow diagram
in Vignette Business Integration Studio (VBIS). The main elements of a flow
diagram are adapters that represent a special task or set of tasks to be performed
within the flow diagram.
To build a flow diagram you select the Hyperion Planning Adapter from the
Adapter Palette or Adapter Libraries window and drag it into the flow diagram
workspace. From the workspace, you can open adapters to select processing
options and create links between the ports of the adapters to reflect desired data
flow. Save the flow diagram instance. You can run and launch adapter processes
from within VBIS or deploy them as executables that you run either stand-alone
or within other applications.

Flow Diagram Workspace


The following table explains the elements of the flow diagram workspace.
Table 6: Flow Diagram Workspace

Element Function

Adapters These are the active elements of an adapter process. Each


adapter represents a specialized task or tasks within the
adapter process where it is used. Adapters are reusable
objects that can be utilized multiple times in an adapter
process, or in multiple adapter processes.
Methods These indicate the specific task that the adapter performs,
such as read data from a file or write data to a file.
Ports These are the places on the adapters where you attach
connections. Ports can receive data from other adapters,
send data to other adapters, or both. The ports on the
Hyperion Planning adapter represent the member
properties. They can receive data from other adapters, but
cannot send data.
Connectors These are the communication paths between adapters and
are used to exchange data between adapters.
Adapter Palette This displays the adapters that are available for use. You
can then drag any available adapter from the Adapter
Palette to the Flow Diagram Workspace.

10
Hyperion Planning Administrator’s Guide ■ 221
Loading Members and Data

Creating an Adapter Process


Before you begin loading custom dimensions into a Hyperion Planning
application, you must create an adapter process in VBIS.

➤ To create an adapter process:


1. Select Start > Programs > Vignette Business Integration Studio V6 >
Vignette Business Integration Studio.
2. From the VBIS dialog box, select New Flow Diagram.
3. Click OK.

Using the Hyperion Planning Adapter


You use the Hyperion Planning Adapter to load members, shared members, and
attribute values into dimensions.

Loading and Updating Shared Members


You can load and update the parent/child roll-up of existing shared members using
the Hyperion Planning Adapter. Shared members can be loaded and updated from
a text file, or any other data source that is supported by Hyperion Application Link.
However, shared members must be loaded into the Hyperion Planning relational
repository, rather than directly into Hyperion Essbase. Also keep in mind that
shared members are supported only by the entity dimension, and the base member
must first be loaded prior to loading its shared members.

Loading Attribute Values


You can load attribute values using Hyperion Planning Adapter, provided that the
corresponding attribute is already set up. For example, the Color attribute must be
established before you can load the attribute values Red, Blue, and Green.
Attribute values can be loaded from a text file, or any other data source that is
supported by Hyperion Application Link. However, attribute values must be
loaded into the Hyperion Planning relational repository, rather than directly into
Hyperion Essbase.
For more detailed information about using the Hyperion Planning Adapter, see the
Hyperion Planning Adapter User’s Guide.

222 ■ Hyperion Planning Administrator’s Guide


Loading Members and Data

Adding a Hyperion Planning Adapter


➤ To add a Hyperion Planning Adapter:
1. Start Hyperion Essbase Server.
2. Select Start > Programs > Vignette Business Integration Studio V6 >
Vignette Business Integration Studio.
3. Drag the Hyperion Planning Adapter icon from the Palette or the Extensions
window and drop it in the flow diagram workspace.
4. Enter the name of the Hyperion Planning Web server and click OK.
5. When you connect to the server, the Logon to Hyperion Planning dialog box
displays. Enter the name of the Hyperion Planning application, user name and
password, and click OK.

Note: The Properties dialog box for the Hyperion Planning Adapter displays with
the Data Source tab selected. The Data Source tab shows the server and
application to which you are connected.

6. Select the General tab and enter the name for the adapter, or accept the
default.
7. Select the Methods tab.
8. From the Dimension drop-down list, select the dimension for which you want
to load members.
9. If the source from which you are importing is not sorted in parent/child order,
select Sort in Parent/Child Order.
10. Select the Errors tab.
11. Specify the locations for the errors and exceptions files or accept the defaults.
12. Click OK.

Note: The Hyperion Planning Adapter is now added to the flow diagram
workspace.

10
Hyperion Planning Administrator’s Guide ■ 223
Loading Members and Data

Using the Hyperion Essbase Adapter


You use the Hyperion Essbase Adapter to load members from a Hyperion Essbase
database into custom dimensions within a Hyperion Planning application. For
example, there may be certain additional dimensions in a Hyperion Essbase
database that you want to use in a Hyperion Planning application that you cannot
obtain from any other external source.
Also, you may find that you use Hyperion Essbase for analysis of sales. The
Hyperion Essbase Adapter supports loading values to Hyperion Planning. You can
then use these values in a Hyperion Planning application for forecasting,
budgeting, and projections. For more detailed information about using the
Hyperion Essbase Adapter, see the Hyperion Essbase Adapter User’s Guide.

Adding a Hyperion Essbase Adapter


The Hyperion Essbase Adapter can be used to load data to Hyperion Planning
applications. You can use either the Data Load Rules and the Essbase Application
Manager or Hyperion Application Link with the Essbase Adapter to load data into
a Hyperion Planning application.

➤ To add a Hyperion Essbase Adapter:


1. Select Start > Programs > Vignette Business Integration Studio V6 >
Vignette Business Integration Studio.
2. Drag the Hyperion Essbase Adapter icon from the Palette or the Adapter
Libraries window and drop it in the flow diagram workspace.
3. The Logon dialog box displays and you must perform the following tasks:
– In the Server text box, enter the name of the Hyperion Essbase server.
– In the Application text box, enter the name of the Hyperion Essbase
application.
– In the User text box, enter your user name.
– In the Password text box, enter the password that corresponds with your
user name.
– Click Login.
4. The system verifies the logon information and, if valid, logs on to the
Hyperion Essbase application. The Data Source tab in the Properties dialog
box displays by default.

224 ■ Hyperion Planning Administrator’s Guide


Loading Members and Data

5. From the Database drop-down list, select a Hyperion Essbase database to use
in the adapter process.

Note: You cannot change the database once you select it.

6. Click OK.

Importing Multiple Currency Application Data


In Hyperion Planning, you can enter data into multiple currencies per entity by
overriding the base currency assigned for an entity. If you want to load data to
multiple currencies per entity using the Essbase Adapter, you will need to enter
two lines of data for each piece of data entry. The first line of data represents the
actual value that is to be input into the intersection of dimensions. The second line
of data represents the overriding currency value so that the data is entered to the
correct currency. The following figure is a sample of what a data load might look
like:

The value in the HSP_Rates dimension should be HSP_InputValue for the actual
data entry. The second line for HSP_InputCurrency represents the code that is
assigned to the currency in the relational store to allow for currency overrides. The
code is numeric as Essbase cannot accept alpha characters in the data cells. Then
you can run a currency conversion calculation script to populate reporting
currency values in the database.

Using the Flat File Adapter


You use the flat file adapter to read data from a text file and to load data into the
Hyperion Planning application. Files can contain records that are character
delimited or fixed length. For character delimited files, you specify whether
commas, tabs, or other delimiters are used to delimit the records. To map the fields
in the text file to the member properties in a custom dimension, you need to make
connections between the ports on the flat file adapter and the Hyperion Planning
adapter.

10
Hyperion Planning Administrator’s Guide ■ 225
Loading Members and Data

You can control how the file is read by specifying information in the flat file
adapter Properties dialog box. For more detailed information about using the flat
file adapter, see the Hyperion Application Link Getting Started Guide.

Flat File Load File


The flat file load file is a text file with fields or columns that correspond to the
member properties you want to load. The fields in the text file can be a fixed length
or delimited with a character, such as a tab or comma. The only member property
that is required to have a field in the load file is the member name. All other
member properties are optional. If the value for a property is not loaded through
the load file, the application default value for the property is used. When preparing
a text file, consider the following:
● A load file can contain members for only one dimension.
● Parent members must display before children members, unless the Sort in
Parent/Child option is selected. For example, if the Fixed Assets account is the
parent of the Land account, then Fixed Assets must display before the Land
account in the load file.
● If a parent is not included, the members are imported as children of the root
parent. For example, in the account dimension they would be imported as
children of the member Account.
● If the field or column names in the text file match the port names in the
Hyperion Planning Adapter, they can be automatically connected to the ports.
If the names do not match, you must manually connect them to the ports.
● If a field exists in the load file, but you do not connect it to a port on the
Hyperion Planning Adapter, the members for that field are not loaded.
● The Valid for Consolidations, Two Pass Calculations, Distribution, and Plan
Type properties take a binary value. A value of 1 turns the options on and a
value of 0 turns the options off.

Adding a Flat File Adapter


➤ To add a Hyperion Planning Adapter:
1. Select Start > Programs > Vignette Business Integration Studio V6 >
Vignette Business Integration Studio.

226 ■ Hyperion Planning Administrator’s Guide


Loading Members and Data

2. Drag the Flat File Adapter icon from the Palette or the Adapter Libraries
window and drop it in the flow diagram workspace.

Note: The Properties dialog box for the Flat File Adapter displays with the File tab
selected.

3. Enter the name and path of the text file you want to load, or click the Browse
button to select a file.
4. Select the Methods tab.
5. Select the Reader method if it is not already selected.
6. Select the Format tab.
7. Select Fixed or Delimited as the File Type.
8. If you selected Delimited as the File Type, select a delimiter from the
Delimiters options.
9. Select the Fields tab.
10. If the first line of the file contains field headers, select the First Line for Field
Names option.
11. Click File Preview and select Grid View to make sure that the data source file
is correct.
12. Click OK.

Note: The Flat File Adapter is now added to the flow diagram workspace.

Connecting Ports
There are two ways to connect ports: quick connect and manual connect. When
you use quick connect, VBIS finds all ports with names that match and establishes
connections between them. You use the manual connect to connect ports that do
not have matching names. You can mix the connections methods.

➤ To use the quick connect method to connect ports:


1. Place the mouse on the quick connect circle in the upper right corner of one of
the adapters.

Note: The mouse changes to a connect icon when it is in the correct position.

10
Hyperion Planning Administrator’s Guide ■ 227
Loading Members and Data

2. Drag the mouse to the quick connect circle of the adapter to which you want
to connect. Connection lines display between all ports with matching names.

➤ To use the manual connect method to connect ports:


1. Place the mouse over the arrow on a port on the right side of the port.

Note: The mouse changes to a connect icon when it is in the correct position.

2. Drag the mouse to the appropriate port of the adapter to which you want to
connect. A connection line displays between the two ports.

Running an Adapter Process


The Hyperion Essbase server must be running when you run an adapter process.
Hyperion Planning does not need to be open. If the dimension editor is open, the
dimension that is currently selected in the dimension editor is locked and you
cannot load members into that dimension.

➤ To run an adapter process:


1. Click the Start button on the toolbar.

Note: An adapter process can be run outside of Hyperion Application Link as a


deployed executable.

Importing Data
You can load data values into the Hyperion Planning application from external
systems. For example, you may want to load data for actuals from the ERP system
so that you can calculate variances. Or, you may have an existing Hyperion
Essbase database (for example, operational analysis) from which you want to load
historical or current data into a Hyperion Planning application You use Hyperion
Essbase Application Manager or Hyperion Essbase Adapter to load files that have
been extracted from external systems.
Data load files must meet the following requirements:
● Each data point must be tagged with a member from each dimension.
● Data must be for bottom level members, unless you are loading into a target
version.
● Data must be scanned from the top of the file and from left to right.

228 ■ Hyperion Planning Administrator’s Guide


Loading Members and Data

● Each field in a record must be separated by spaces, tabs, new lines, or carriage
returns.
● A member name or alias must be enclosed in double quotes if it contains
blanks, numeric characters, dashes, or unary operators. It must also appear
exactly as it does in the outline.
● Members from the same dimension must be in the same column or row.
● Members from different dimensions can be together only on the page header.
They cannot be mixed in any other rows or columns.

Loading Data Files


➤ To load data:
1. Select Start > Programs > Hyperion Solutions > Hyperion Essbase >
Essbase Application Manager.
2. From the Hyperion Essbase Application Manager, select Server > Connect.
3. From the Server drop-down list, select the server to which you want to
connect.
4. Enter a username and password, then click OK.
5. Minimize the Hyperion Essbase Application Manager.
6. Select Start > Programs > Windows NT Explorer.
7. Browse to the directory that contains the data files you want to load.
8. Select the text files that you want to load and drag those files onto Hyperion
Essbase Application Manager on the Windows Task Bar at the bottom of the
screen. Hold the mouse there until the Hyperion Essbase Application Manager
maximizes.
9. Continue holding the mouse and drag the files onto the Hyperion Essbase
Application Manager window, then release the mouse.
10. From the Application drop-down list, select the application to which you
want to load the data files.
11. From the Database drop-down list, select the database to which you want to
load the data files.

Note: You should select the database that corresponds to the plan type in the
Hyperion Planning application into which you selected to load the data.

10
Hyperion Planning Administrator’s Guide ■ 229
Loading Members and Data

12. Click OK.


13. Click Close.

Data Load File Example


The following example loads data values for the first quarter of 2001 for the
Europe entity and the Gross Sales account in the Actual scenario and Final version.
EUROPE GROSS SALES ACTUAL FINAL JAN 2001 150
EUROPE GROSS SALES ACTUAL FINAL FEB 2001 110
EUROPE GROSS SALES ACTUAL FINAL MAR 2001 200

If a dimension uses the same value for all rows, you can place it in the header as a
page dimension, as in the following example:
ACTUAL FINAL
EUROPE GROSS SALES JAN 2001 150
ASIA NET INCOME FEB 2001 150
EUROPE NET INCOME FEB 2001 110
ASIA GROSS SALES JAN 2001 200

230 ■ Hyperion Planning Administrator’s Guide


11
Chapter Using Data Entry Forms

11
This section describes how to create, modify, and manage data entry forms and the
folders in which they are stored.

About Data Entry Forms


Data entry forms are spreadsheet-like grids with rows and columns for entering
data through the Web. You can create as many data entry forms as needed to meet
the needs of different users in your organization. For example, you may create a
data entry form for fixed assets that is used by budget preparers in the finance
department, and another data entry form with the schedule of expense accounts
that is used by line managers.

Forms and Plan Types


When you create a data entry form, you assign it to a plan type. The data entry form
contains dimension members that are valid for the plan type you select. For
example, if you assign a data entry form to the Revenue plan type, you cannot add
accounts to the data entry form that are not valid for the Revenue plan type. The
data entered on the data entry form is saved to the database for the data entry form’s
plan type. You cannot change the plan type for a data entry form once it has been
assigned.
On a form, accounts whose source plan type is the plan type for the form are
editable. You should only add an account to a form for a plan type other than the
account’s source plan type if you want the account to be read-only on that form.

Hyperion Planning Administrator’s Guide ■ 231


Using Data Entry Forms

Forms and Access Rights


When you assign access to a data entry form, you control which users can access
and change the form design (for example, form properties such as formats, layout,
and instructions) and which users can access the form for data input. A user or
group can have only one of the following access rights: Read, Write, or None.
However, the access rights for a user can be combined based on the groups to
which that user belongs.
You create and change form designs using the Manage Forms task. Administrators
and interactive users have access to this task. When users are designing a form in
the Web client, the selection list to set properties is filtered based on access rights.
For example, when setting up the form layout for page, column, row, and point of
view, a user is able to select from the list of dimension members to which he has
read or write access.
Users enter data through the Enter Data page. All users have access to the Enter
Data page. Access to specific data entry forms created by administrators or
interactive users is based on access rights. For example, a user having read access
to a form can see the form listed and can select the form for entering data. Whether
users can actually change the data in the form depends on whether they have access
to its members.
When users access a form in the Web client for data entry, their access to the rows
and columns on the form is determined by the data access rights they have been
assigned to the members on the rows and columns of the form. In order for a form
to be editable by a user, the user must have access to at least one member of each
secured dimension on the form. For example, if a user has read-only access to the
Europe entity, all of the rows and columns on the form that include the Europe
entity display in a read-only format.

Forms and Currencies


The Currency dimension on a form determines the currency in which the form
values display. When a row or column on a data entry form has the member Local
selected for the Currency dimension, no currency conversion takes place for that
row or column, and users can enter data for the entities on the row or column in
their native currency. When a form uses a currency member other than Local, data
values are converted to the selected currency for that row or column, and the form
is read-only.

232 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
You can enter data in rows or columns that have Currency as the selected member,
as well as Local. For applications that use a single currency, the currency you
selected when you created the application is used as the currency member for all
entities.

Designing a Form for Multiple Currencies


To allow users to work with currencies other than entities’ base currencies, you
must also do one of the following when selecting members for a form:
● To compare converted currencies in the same form for rows and columns,
select members from at least two different currencies.
● To convert currencies for all the members in the form, assign the Currency
dimension to the page axis and select reporting currencies as members. Users
can then select the currency member of their choice from the page axis and
then launch the calculate currencies calc script to view all the values in that
currency.

Forms and Versions


For bottom up versions, rows and columns with Level 0 members allow data entry.
A bottom-level member is a member that has no child members below it. If any
rows or columns are set to a parent member, those rows or columns are read-only.
The point of view must also be set to the Level 0 member and a member that allows
data to be entered against it, in order to allow data entry on a bottom up version.
Target versions allow data entry in both parent and bottom-level members.

Forms and Attributes


You can use attributes to select members that share an attribute. For example, you
could select the Cost Center attribute to include members on the form that have the
Cost Center attribute. Values can be entered into rows and columns that use
attributes and are saved to the database.

Forms and Shared Members


You can use the member relationship to select shared members. For example, you
could select an alternate functional roll-up to include all members under that
roll-up on the form. Values can be entered into rows or columns that display shared
members and are saved to the base members in the database.

Hyperion Planning Administrator’s Guide ■ 233


Using Data Entry Forms

Understanding the Composition of a Form


Before you begin creating data entry forms, it is important to understand some of
the basic components of a data entry form.

Point of View
The members you select for the dimensions that are assigned to the point of view
determine the context for the pages, rows, and columns. For example, if the
Scenario dimension is set to Budget in the point of view, then all of the data entered
in the pages, row, and columns will go into the Budget scenario. The point of view
is always set to a single member for each point of view dimension. A user cannot
change the member that is selected for the point of view.

Page Axis
The page axis lets you set up combinations of members that may span dimensions
so users can work with data in smaller, logical views. Each item on the page axis
can have members selected from one dimension or from multiple dimensions.
Users see only members to which they have access.
You specify any number of page drop-down lists, and select members using
relationship functions or attributes. You can then switch among member sets to
work with by selecting them from the page axis.

Rows and Columns


Rows and columns define the grid into which users enter data. For example, you
may assign Unit Sales to the row axis and January to the columns axis. When users
access data entry forms through the Web client, they can enter data into the cell
where the row for Unit Sales intersects with the column for January.
By default, data entry forms have a single set of rows and columns. You can add
additional sets of rows and columns to create data entry forms with asymmetrical
combinations for members in rows and columns.

Managing Forms and Folders


The Form Management page lets you manage data entry forms and folders. You
can perform the following tasks from the Form Management page:

234 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
● Create folders
● Move folders
● Delete folders
● Create forms
● Edit forms
● Assign access to forms
● Move forms
● Delete forms
If you want to view all the forms in a particular folder, click on the folder’s name
in the Form Folders area. To select all the forms in the forms list, select the check
box at the top of the list, in the Form column.

Creating Form Folders


Form folders help you organize the various data entry forms you create. You can
create as many form folders as needed, and you can arrange the form folders in a
hierarchy. For example, you may want to create a top level form folder called P&L.
Within the P&L form folder, you could create form folders named Revenue and
Operating Expenses to organize your P&L data entry forms.
You should keep the following points in mind when working with form folders:
● You can move form folders within the hierarchy.
● You can give form folders the same name if they are not on the same
hierarchical level.
● You cannot rename a form folder.
● You cannot assign access rights to form folders.
● You cannot delete a form folder unless it is empty.
● You cannot select multiple form folders.
● You cannot rename, move, or delete the top level form folder called Forms, as
it contains all the form folders and forms for the application.

➤ To create a form folder:


1. From the Hyperion Planning Home page, click Manage Forms.

Hyperion Planning Administrator’s Guide ■ 235


Using Data Entry Forms

2. From the Form Folders list on the left side of the Form Management page,
select the form folder under which you want to create a new form folder.
3. From the left side of the Form Management page, click Create.
4. In the text box, enter a name for the new form folder.

Note: You cannot rename a form folder.

5. Click OK.

Moving Form Folders


When you move a form folder, all the data entry forms and nested form folders
within the folder are also moved.

➤ To move a form folder:


1. From the Hyperion Planning Home page, click Manage Forms.
2. From the Form Folders list on the left side of the Form Management page,
select the form folder you want to move.
3. From the left side of the Form Management page, click Move.
4. From the Destination Folder drop-down list, select the form folder to which
you want to move the selected form folder.
5. Click OK.

Deleting Form Folders


➤ To delete a form folder:
1. From the Hyperion Planning Home page, click Manage Forms.
2. From the Form Folders list on the left side of the Form Management page,
select the form folder you want to delete.

Note: You cannot delete a form folder that contains folders or forms.

3. From the left side of the Form Management page, click Delete.
4. When you are prompted to confirm your intention to delete the form folder,
click OK.

236 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
Creating Forms
The process of creating a form includes defining various aspects of the form,
including:
● Form properties
● Row and column layout
● Page and POV definition
● Member selection
● Display options
● Business rules selection and properties
● Access rights

➤ To create a form:
1. From the Hyperion Planning Home page, click Manage Forms.
2. From the Form Folders list on the left side of the Form Management page,
select the form folder under which you want to store the new form.
3. From the right side of the Form Management page, click Create.
4. The Form Design Wizard displays and guides you through the process of
creating a form.

Setting Form Properties


On the Properties tab, you name the form and set its basic characteristics.

➤ To set a form’s properties:


1. In the Form text box, enter a name for the form of up to 80 characters.
2. Optional: In the Description text box, enter a description for the form of up
to 255 characters.
3. From the Plan Type drop-down list, select the plan type to associate with the
form.
4. In the Enter Instructions text box, enter instructions that users can view.
5. Click Next.

Hyperion Planning Administrator’s Guide ■ 237


Using Data Entry Forms

Setting the Row and Column Layout


On the Row/Column Layout tab, you assign dimensions to the columns and rows
on the form by selecting them from the drop-down lists. For each of those
dimensions, you select the members with which you want users to work. You can
then set the properties of the dimensions and members on the columns and rows.
These properties include showing a member name or alias, starting with the
hierarchy expanded, suppressing missing data, and the column width.
You should keep the following items in mind when setting the row and column
layout:
● You must select at least one member for each dimension.
● A form must have at least one dimension assigned to the row and column axis.
● You cannot select the same dimension for more than one axis.
● To move a dimension from one axis to another, delete it from the source axis
and select it for the destination axis.

➤ To set up the dimensions and members for the column and row axis:
1. In the Column Dimensions area, use the Dimension drop-down list to select
the dimension to display first in the column axis.
● To add more dimensions to a column, click Add Dimension.
● To add more columns, click Add Column. For more information, see
“Adding Column Definitions” on page 240.
2. Select each dimension’s members by doing one of the following:
● In the Member text box, type the names.
● Click the magnifying glass icon under Select.
For more information about selecting members, see “Selecting Members” on
page 241. For more information about selecting different sets of members
across the same dimension for a column, see “Creating Asymmetric Rows and
Columns” on page 244.
3. Repeat the above steps to assign more dimensions to the column axis.
4. In the Properties area, you can make the following selections:
● Select or deselect the Member Name and Alias options to display the
member name, member alias, or both.

238 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
● Select or deselect the Start Expanded option to start the member list
expanded or collapsed.
● Select or deselect the Suppress missing data option to suppress or show
missing data.
● Select either Small, Medium, or Large for the column width.
5. In the Row Dimensions area, use the Order Dimension 1 drop-down list to
select the dimension to display first in the row axis.
● To add more dimensions to a row click Add Dimension.
● To add more rows, click Add Row. For more information, see “Adding
Row Definitions” on page 240.
6. Select each dimension’s members by doing one of the following:
● In the Member text box, type the names.
● Click the magnifying glass icon under Select.
For more information about selecting members, see “Selecting Members” on
page 241.
For more information about selecting different sets of members across the
same dimension for a row, see “Creating Asymmetric Rows and Columns” on
page 244.
7. Repeat the above steps to assign more dimensions to the row axis.
8. In the Properties area, you can make the following selections:
● Select or deselect the Member Name and Alias options to display the
member name, member alias, or both.
● Select or deselect the Start Expanded option to start the member list
expanded or collapsed.
● Select or deselect the Suppress missing data option to suppress or show
missing data.
9. Do one of the following:
● Click Next to continue setting up the form.
● Click Previous to return to the previous tab.

Hyperion Planning Administrator’s Guide ■ 239


Using Data Entry Forms

Adding Column Definitions


On the Additional Column Definition page, you can further define the member
selections for a column’s dimensions. This page enables you to create asymmetric
columns. For more information, see “Creating Asymmetric Rows and Columns”
on page 244.

➤ To further select members for dimensions in the column axis:


1. On the Additional Column Definition page, click the magnifying glass icon.
2. On the Member Selection page, select members for the dimension.
3. Click Submit.
4. Repeat this for the necessary dimensions.
5. Click Submit.
The newly displayed Edit Columns button on the Row/Column Layout tab lets you
further define the column’s dimensions and members.

Adding Row Definitions


On the Additional Row Definition page, you can further refine the member
selections for a row’s dimensions. This page enables you to create asymmetric
rows. For more information about asymmetric rows, see “Creating Asymmetric
Rows and Columns” on page 244.

➤ To further select members for dimensions in the row axis:


1. On the Additional Row Definition page, click the magnifying glass icon.
2. On the Member Selection page, select members for the dimension.
3. Click Submit.
4. Repeat this for the necessary dimensions.
5. Click Submit.
The newly displayed Edit Rows button on the Row/Column Layout tab lets you
further define the row’s dimensions and members.

240 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
Changing Column Definitions
The Edit Columns Definition page lets you further define or remove column
definitions.

➤ To set or change the dimension members assigned to a column or to remove the


column definition:
1. On the Row/Column Layout tab, click Edit Columns.
2. On the Edit Column Definitions page, next to the column you want to change
or delete, click:
● Edit to further define the member selections for the column.
● Delete to delete the additional column definition (including its member
selection).
3. Click Return to Form Layout.

Changing Row Definitions


The Edit Row Definitions page lets you further define or remove row definitions.

➤ To set or change the dimension members assigned to a row or to remove the row
definition:
1. On the Row/Column Layout tab, click Edit Rows.
2. On the Edit Row Definitions page, next to the row you want to change or
delete, click:
● Edit to further define the member selections for the row.
● Delete to delete the additional row definition (including its member
selection).
3. Click Return to Form Layout.

Selecting Members
On the Member Selection page, you select members for the current dimension.
You can select members directly, by attribute, or based on a relationship.

Hyperion Planning Administrator’s Guide ■ 241


Using Data Entry Forms

➤ To select members for a dimension:


1. From the Members list on the left, select the check boxes for the members you
want to select.

Note: To select all members, select the check box in front of the Members In list.
Click the plus or minus sign in the Member list to expand or collapse the member
list.

2. Move members to and from the Selected Members list in any of these ways:
● Use the right arrow to move the selected members to the right Selected
Members list.
● Use the left arrow to remove the selected members from the Selected
Members list.
● Use the double left arrows to remove all members from the Selected
Members list.
● When selecting members for the page, row, or column axis, you can use
the Relation drop-down list to select a range of members based on
database outline relationships.
The following table describes the existing relationships, and the members that are
included on the form for each relationship:

Relationship Members Included on the Form

Member The selected member


Descendants All descendants of the selected member,
excluding the selected member
Descendants (inc) The selected member and all its
descendants
Ancestors All members above the selected
member, excluding the selected member
Ancestors (inc) The selected member and all its
ancestors
Siblings All members from the same level in the
hierarchy as the selected member,
excluding the selected member
Siblings (inc) The selected member and all its siblings

242 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
Relationship Members Included on the Form

Parents The member in the level above the


selected member
Parents (inc) The selected member and its parent
Children All members in the level immediately
below the selected member
Children (inc) The selected member and all its children
Level 0 Descendants All descendants of the selected member
that have no children

Members chosen using the Relation drop-down list are displayed in their
unexpanded state.
3. Click Submit.

Note: Changing a user’s access to a dimension member affects which members


are displayed in the form after the plan is refreshed.

The order of the members in the Selected Members list determines the order in
which they appear in the data entry form. You can change the order of members by
selecting a member and then clicking the up or down arrow in the Selected
Members title bar. You can use the scroll bar on the right to view long member lists
or the horizontal scroll bar at the bottom to easily see members that have long file
names or are deeply nested.
● For information on defining different sets of members for a dimension, see
“Creating Asymmetric Rows and Columns” on page 244.
● For information on selecting members that are attribute values, see “Selecting
Attribute Values as Members” on page 244.
● For information on creating forms that enable account annotations to display
on the data entry form, see “Setting a Form’s Display Options” on page 246.

Hyperion Planning Administrator’s Guide ■ 243


Using Data Entry Forms

Selecting Attribute Values as Members


When selecting members for a data entry form, you can select attribute values as
members, but you cannot select attributes themselves. For example, you can select
the East and West attribute values, but you cannot select the Region attribute as a
member.
When selecting attribute values as members, you should also keep the following
points in mind:
● You can select shared members by the attribute values they inherit from their
base member.
● You can select attribute values using one or more attribute members.
● Selecting two or more attribute values as members from the same attribute
dimension results in members that have either attribute value. For example,
selecting Blue and Red from the Color attribute includes members that are
either Blue or Red.
● Selecting two or more attributes from different attribute dimensions results in
members that have both attribute values. For example, selecting Blue from the
Color attribute and Large from the Size attribute includes members that are
both Blue and Large.
● Selecting a base dimension member and an associated attribute value results
in base dimension members that have the associated attribute value. For
example, selecting North America (base member) and all its descendants and
Populations equal to 200,000 (attribute value) includes all members that are
both North American and have populations equal to 200,000.
● A data entry form in which attribute values are selected as members shows the
attribute name as well as the base dimension member names and/or aliases.

Creating Asymmetric Rows and Columns


Asymmetric rows and columns are ones in which different sets of members are
selected across the same dimension. Here is an example of an asymmetric
selection:
Row/Column A: Scenario = Actual, Time Period = Q1
Row/Column B: Scenario = Budget, Time Period = Q2, Q3, Q4

244 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
➤ To create an asymmetric row or column:
1. On the Row/Column Layout tab, click Add Row or Add Column.
2. On the Additional Row or Column Definitions page, next to the dimension
you want to select asymmetric members for, click the magnifying glass icon.
3. Select a different set of members for the row or column than you selected for
the dimension in the previous row or column.
4. Click Submit.
5. Repeat this for the necessary dimensions.
6. Click Submit.

Defining the Page and POV


On the Page/Point of View Layout tab, you can select dimensions and members for
the page axis, as well as whether to display the members names or aliases. You can
also define the POV dimensions and members for any dimensions that are valid for
the form’s plan type and not assigned to a page, column, or row axis. The POV
toolbar lets you set the unique set of dimension members that define specific
intersections of data.

➤ To define the page axis and POV:


1. In the Page Dimensions area, use the Order Dimension 1 drop-down list to
select the dimension to display first in the page axis.
2. Select each dimension’s members by doing one of the following:
● In the Member text box, type the names.
● Click the magnifying glass icon under Select.
For more information about selecting members, see “Selecting Members” on
page 241.
3. Repeat the above steps to assign any number of dimensions to the page axis.
Assigning multiple dimensions to the page axis enables planners to easily
select dimensionality while entering data. Using the Preferences link and the
Data Display tab, users can also specify whether Hyperion Planning sets the
page selection to the most recently used selection.
4. Select or deselect the Member Name and Alias options to display the member
name or member alias.

Hyperion Planning Administrator’s Guide ■ 245


Using Data Entry Forms

5. In the POV Dimension area, select each dimension’s members by doing one
of the following:
● In the Member text box, type the names.
● Click the magnifying glass icon under Select.
For more information about selecting members, see “Selecting Members” on
page 241.
6. Select or deselect the Member Name and Alias options to display the member
name or member alias.
7. At this point you have entered enough information to save the form. Do one of
the following:
● Click Save to save the form and return to the Form Management page.
● Click Next to continue setting up the form.
● Click Previous to return to the previous tab.

Setting a Form’s Display Options


On the Display Options tab, you can set various options for the form’s display,
functionality, and printing. You can also enable account level annotations. In a data
entry form, users can add annotations to accounts. However, a user must have write
access to the individual account, entity, scenario, and version members. The
account level annotations can vary by different combinations of scenario, version,
and entity dimensions. The following guidelines apply in order to enable users to
add annotations to accounts:
● The Account dimension must be assigned to a row axis.
● The Account, Entity, Version, and Scenario dimensions cannot be assigned to
the column axis.
● The Entity dimension can be assigned to either the row, page, or POV axis.
● The Version and Scenario dimensions must be assigned to either the page or
POV axis.

➤ To set display options for the form:


1. In the Precision area, set the number of decimal positions you want for
displayed values in the form.
– From the Currency Values drop-down list, select the number you want.

246 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
– From the Non-Currency Values drop-down list, select the number you
want.
– From the Percentage Values drop-down list, select the number you want.
2. In the Display Properties area, select the appropriate check boxes to enable
the following features:
● Display missing values as blank - You can select this option to leave
form cells empty where data does not exist. If this option is not selected,
empty cells display the text “#missing.”
● Enable account annotations - You can select this option to enable users
to add annotations of up to 1500 characters to accounts during data entry.

Note: The Enable Account Annotations option displays if the form meets the
criteria listed above for enabling account level annotations.

● Allow multiple currencies per entity - If the application supports


multiple currencies, you can select this option to allow entities to support
multiple currencies, regardless of their base currency. Users can select the
currency for displayed cell values in a form on the fly.
3. In the Printing Options area, set your preferences for how the information in
the form is displayed:

Option Explanation

Orientation Select the orientation of the PDF file:


Normal - displays the form with a vertical
orientation
Landscape - displays the form with a
horizontal orientation
Font Select from among the available fonts in the
drop-down list to set the font for the
information displayed in the PDF file. To add
fonts to the drop-down list, see “Adding Fonts”
on page 249.
Font size Type a number from 1 to 26 to set the font size
for the information displayed in the PDF file.

Hyperion Planning Administrator’s Guide ■ 247


Using Data Entry Forms

Option Explanation

Percentage of the page to Type a number from 1 to 99 to set the


use for row headers percentage of the page to use for row headers.
If the row header exceeds the space allotted for
it, the text wraps. Set a smaller percentage
value to allot more display space for the data
and columns headers. The default value is 35.
Number of data columns per If you have more rows or columns than will fit
page on a page, type the number of columns to
display on each page.
Repeat headers on all pages If you consistently have more rows or columns
than will fit on one page, select this check box
to repeat the headers on all displayed pages.
Format data Select this check box to apply the number
format settings from the data entry form to the
displayed data.
Apply precision Select this check box to apply the form’s
precision settings (desired number of decimal
points) to the data that is displayed in the PDF
file.
Include supporting detail Select this check box to include supporting
detail as extra rows in the PDF file. Use the
drop-down list to specify how the supporting
detail is displayed:
Normal Order - prints the supporting detail in
the same order in which it appears on the
Supporting Detail page, after the member it is
associated with
Reverse Order - prints the supporting detail in
reverse order, before the member it is
associated with. Supporting detail for children
appears above their parents and the order of
siblings is preserved.
Show account annotations If the form designer enabled account
annotations for the form, select this check box
to display account annotations in the PDF file.

248 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
Option Explanation

Show attribute members If attribute members are selected in the form,


select this check box to display them in the
PDF file.
Show currency codes If the form supports multiple currencies, select
this check box to display the currency codes of
values in the PDF file.

4. Do one of the following:


● Click Save to save the form and return to the Form Management page.
● Click Save As to save the form under a new name.
● Click Next to continue setting up the form.
● Click Previous to return to the previous tab.

Adding Fonts
By default, Hyperion Planning supports a number of built-in (type-1) fonts for
printing forms (for example, Helvetica, Times, Courier, and so on). Administrators
can add true type fonts to the Font drop-down list to enable printing in various
other languages such as Turkish and Russian. All Hyperion Planning applications
on the application server can access the added fonts.

➤ To add fonts that are available for printing forms:


1. Open the HspJSHome.properties file, which is located in the
webapps\HyperionPlanning\Web-inf\classes directory within your
Web Application Server directory.

Note: If this file does not exist, see “Creating the Properties File” on page 46 for
instructions on creating the properties file.

2. Add an entry, using the following syntax:


PDF_FONT_FILE=path\\font1,path\\font2,path\\font3

Note: You must use double backslashes in the path name (for example,
c:\\winnt\\fonts\comic.ttf) and separate font names with commas.

Hyperion Planning Administrator’s Guide ■ 249


Using Data Entry Forms

Here is an example (ignore the line breaks):


PDF_FONT_FILE=
c:\\winnt\\fonts\\comic.ttf,c:\\winnt\\fonts\\msgothic.ttc,c
:\\winnt\\fonts\\msmincho.ttc

3. Save and close the HspJSHome.properties file.


4. Restart the application server.
The fonts you added to the properties file are now available from the Font
drop-down list.

Using Business Rules


You can create business rules using a graphical user interface with Hyperion
Business Rules for use with Hyperion Planning. These business rules can reside
either directly in the Hyperion Business Rules repository or can be exported to
Hyperion Essbase as calculation scripts. These business rules can be launched
directly from Hyperion Planning Web or associated with Web data entry forms.
Both the designers of the forms and users entering data into the form can see and
launch only business rules to which they have access.
In Hyperion Business Rules, administrators and interactive users can define
business rules that prompt users for input when the rules are launched. For
information on:
● Creating business rules, see the Hyperion Business Rules Administrator’s
Guide
● Using run-time prompts, see “Using Run-Time Prompts” on page 252 and
“Enabling Run-Time Prompts” on page 253
● Setting security on business rules, see “Setting Up Security for Business
Rules” on page 126

Selecting Business Rules


On the Business Rules tab, you can associate one or more business rules to which
you have access with a form, by plan type. This lets users launch any or all of the
associated business rules from the data entry form to allocate and calculate
values.You can also set whether each business rule that is associated with a form
automatically launches when the Save button is clicked during data entry.

250 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
➤ To select business rules for the form:
1. From the Plan Type drop-down list, select the plan type.
2. From the Business Rules list, select the business rules you want to associate
with the form.
3. Move the business rules to the Selected Business Rules on the right side by
clicking the right arrow to move the selected business rules or clicking the
double right arrows to move all the business rules.

Note: By default, the Calculate Form and the Calculate Currencies business rules
are selected. The Calculate Form business rule is programatically created for each
form to calculate subtotals. The Calculate Currencies business rule is created for
forms that include multiple currencies in a row, column, or page, to enable
converting values among the available currencies.

4. To set the order of the selected business rules (which determines the order
users see the rules displayed and the order in which they are launched when
the data is saved), select a business rule in the Selected Business Rules list
and click the up or down arrow.

Note: The order in which business rules are launched is very important and may
affect the data. If you are launching both conversion and subtotal business rules, it
is important that the conversions be run first, before subtotaling.

Setting Properties of Business Rules


On the Business Rule Properties page, you can set whether each business rule that
is associated with a form automatically launches when Save is clicked during data
entry. If a business rule has run-time prompts, you can also set whether or not the
default member selection on the run-time prompt window matches the current
member selection in the page and POV axes.
You set up the properties for business rules as part of the process of creating a form.
For more information, see “Creating Forms” on page 237.

➤ To set up properties for a business rule:


1. Select the Run on Save check box next to the business rules you want to run
automatically during save operations.

Hyperion Planning Administrator’s Guide ■ 251


Using Data Entry Forms

The business rule Calculate Form is programmatically created for each form
to calculate subtotals. The Calculate Currencies business rule is created for
forms that include multiple currencies to enable the conversion of values
among the available currencies.

Note: The Run on Save option is not available for business rules that have
run-time prompts.

2. If a business rule has run-time prompts and you want the default member
selection on the run-time prompt window to match the current member
selection in the page and POV axes of the open form, select the Use Members
on Form check box.

Note: The Use Members on Form option is available only for business rules that
have run-time prompts. This option is most effective when used by run-time
prompts that use a dimension only once.

For more information on run-time prompts, see “Using Run-Time Prompts”


on page 252.
3. Click OK.

Using Run-Time Prompts


In Hyperion Business Rules, administrators and interactive users can set up
business rules that, when launched from Hyperion Planning, prompt users for such
variables as members, text, or numbers. Here are some examples of run-time
prompts:
● Please select an account.
● Select a month.
● Enter the expected number of customer visits per quarter.
● What percentage change in earnings do you expect next month?

Tip: Create prompts that are specific and that let the user know what type of data is
expected.

Note: When launching a business rule with a run-time prompt, Hyperion Planning
validates the value entered, but it does not validate the business rule.

To learn how to set the default member selection in a run-time prompt, see “Setting
Properties of Business Rules” on page 251.

252 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
Enabling Run-Time Prompts
For users to be able to select a business rule that has a run-time prompt, the
administrator must first establish a connection between Hyperion Planning and
Hyperion Business Rules.

Note: The following steps apply to Microsoft Windows only, not to UNIX systems.

➤ To set up a connection between Hyperion Planning and Hyperion Business Rules:


1. Start the application server.
2. From your Web browser, log on to Hyperion Planning.
3. Start the Hyperion Business Rules server:
a. Navigate to the bin folder where Hyperion Business Rules is installed.
b. Double-click starthbr.bat.
The starthbr.bat file synchronizes Hyperion Business Rules with
Hyperion Planning. If the connection is lost, Hyperion Planning tries to
reconnect at a predefined interval.
4. When the connection between the two products is established, the following
message is displayed: “HBR Server bound in registry.”

Previewing a Form
While you are designing or changing a data entry form, you can preview the form’s
structure: which dimensions are assigned to the POV (Point of View), columns,
rows, and page axes. Preview does not display data associated with the form.

➤ To preview a form’s design, select the Preview tab.

Assigning Access to a Form


By assigning access to forms, administrators and interactive users determine:
● Administrators and interactive users who can view and change various form
designs. By default, administrators have write access to all forms for design
modifications. Interactive users have write access to certain forms based on
access rights.

Hyperion Planning Administrator’s Guide ■ 253


Using Data Entry Forms

● Users who can access the forms for view or data input. By default,
administrators have write access to all data entry forms. Interactive users and
planners have access to data entry forms based on access rights. Whether users
have access to the data in the form depends on whether they have access to its
members.

Assigning Access to a Form


➤ To assign access to forms:
1. At the Form Management page, select the form for which you want to set
access.

Note: Access rights are assigned to forms, not to form folders. You can assign
access to one form at a time.

2. Click Assign Access.


3. Click Add Access and select the users or groups you want to have access to
the form.
4. In the Type of Access box, select the kind of access you want the selected
users or groups to have to the form:
– Read - enables users to see and use the form for data entry
– Write - enables users to change the form’s design and to see and use
the form for data entry
– None - prevents users from seeing the form listed
5. Click Add.
6. Click Close.

Changing Access to a Form


➤ To change which users can use a form or change the form’s design:
1. At the Form Management page, select the form for which you want to
change access.

Note: Access rights are assigned to forms, not to form folders. You can change
access to only one form at a time.

254 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
2. Click Assign Access.
3. Select the users or groups for which you want to change the access assignment
and click Edit Access.
4. In the Type of Access box, select the kind of access you want the selected
users or groups to have to the form:
– Read - enables users to see and use the form for data entry
– Write - enables users to change the form’s design and to see and use
the form for data entry
– None - prevents users from seeing the form listed
5. Click Set.
6. Click Close.

➤ To remove access from forms:


1. At the Form Management page, select the form for which you want to
remove access.

Note: Access rights are assigned to forms, not to form folders. You can remove
access to only one form at a time.

2. Click Assign Access.


3. Select the users or groups for which you want to remove the access assignment
and click Remove Access.
4. You are prompted to confirm your intention to remove access. Click OK.

Modifying Forms
➤ To modify a form:
1. From the Hyperion Planning Home page, click Manage Forms.
2. From the Form Folders list on the left side of the Form Management page,
select the form folder where the form you want to modify is stored.
3. From the Forms list on the Form Management page, select the form you
want to modify.
4. From the right side of the Form Management page, click Edit.

Hyperion Planning Administrator’s Guide ■ 255


Using Data Entry Forms

5. Make the necessary changes to the form. For additional information on


modifying a form, see:
● “Setting Form Properties” on page 237
● “Setting the Row and Column Layout” on page 238
● “Defining the Page and POV” on page 245
● “Selecting Members” on page 241
● “Setting a Form’s Display Options” on page 246
● “Selecting Business Rules” on page 250

Note: When you open a form, all business rules that are associated with the
form display and remain selected regardless of your access rights. You can
reposition or remove these business rules. When you select new business
rules to add to the form, you can select only those business rules to which you
have access.

● “Assigning Access to a Form” on page 253

Moving Forms
➤ To move a form:
1. From the Hyperion Planning Home page, click Manage Forms.
2. From the Form Folders list on the left side of the Form Management page,
select the form folder where the form you want to move is stored.
3. From the Forms list on the Form Management page, select the form you
want to move.

Note: You can move multiple forms at once if they are in the same form folder.

4. From the right side of the Form Management page, click Move.
5. From the drop-down list, select the destination form folder.
6. Click OK.

256 ■ Hyperion Planning Administrator’s Guide


Using Data Entry Forms
11
Deleting Forms
➤ To delete a form:
1. From the Hyperion Planning Home page, click Manage Forms.
2. From the Form Folders list on the left side of the Form Management page,
select the form folder where the form you want to delete is stored.
3. From the Forms list on the Form Management page, select the form you
want to delete.
4. From the right side of the Form Management page, click Delete.
5. When you are prompted to confirm your intention to delete the form, click
OK.

Hyperion Planning Administrator’s Guide ■ 257


Using Data Entry Forms

258 ■ Hyperion Planning Administrator’s Guide


Chapter Managing the Budgeting

12 Process 12

This section describes the concept of a planning unit and its life cycle through the
review process.

About the Budgeting Process


The Hyperion Planning budgeting process lets you track the progress of a budget
from any level in the organization using the Web-based client. The budgeting
process lets you identify problems in the review process, view status information,
quickly identify ownership of budget planning units, and change the budget status.
Hyperion Planning tracks the budget by planning units, which are combinations of
scenario, version, and entity.
The budget process is designed to reduce budget cycle time through these key
characteristics.
● Approve a planning unit from any process state
● Approval path is independent of organizational structure
● Highlight the exceptions and problem areas
● Built-in audit information through annotations and process status
● Add annotations and comments at each pass through the review process
● Accountability through ownership

Planning Units
Scenarios and versions are the basis of the planning review cycle. Entities submit
planning data for a particular scenario and version. The combination of scenario,
version, and entity is called a planning unit and is the basic unit for preparing,
reviewing, and approving plan data.

Hyperion Planning Administrator’s Guide ■ 259


Managing the Budgeting Process

For example, consider the data outline below:

● The Version dimension has two members: Best Case, Worst Case
● The Entities dimension has three members: New York, California,
Connecticut
● The Scenario dimension has two members: Actual, Budget
The planning unit might consist of a version (Worst Case), an entity (New York),
and a scenario (Actual) as shaded in the example below:

260 ■ Hyperion Planning Administrator’s Guide


Managing the Budgeting Process

You start, view, and promote planning units using Hyperion Planning Web’s Check
Status task. Hyperion Planning Web also maintains a history of the budget review
process and supports users’ annotations. For more information about Check
Status, see the Hyperion Planning Web help. 12
A planning unit is in one of six possible states:
● Not Started - the initial state of all planning units. Any budget administrator
can initiate the review process using the Start action.
● First Pass - The first state for planning units that have been selected to go
through the budgeting process. There is no owner of a planning unit during
First Pass. Any user with data access can enter data and promote the planning
unit during the First Pass state.
● Under Review - This state occurs when a Promote action is taken on a
planning unit and signifies that a planning unit is being reviewed by someone
in the organization. Only the current owner or the budget administrators can
modify data or perform an action on a planning unit that is in the Under
Review state.
● Signed Off - This state occurs when a Sign Off action is taken on a planning
unit. Only the current owner or the budget administrators can modify data or
perform an action on a planning unit that is in a Signed Off state. Ownership
does not change when a planning unit is signed off.
● Not Signed Off - This state occurs when a Reject action is taken on a planning
unit. Only the current owner or the budget administrators can modify data or
perform an action on a planning until it is in a Not Signed Off state.
● Approved - This state occurs when an Approve action is taken on a planning
unit. After a planning unit is approved, the budget administrator becomes the
owner of the planning unit. Only the budget administrators can modify data or
perform an action on a planning unit that is in the Approved state. With
multiple budget administrators, management of the planning cycle is
procedural, requiring coordination among the administrators. Once all the
planning units are approved, the budget cycle is complete.

Note: In all states except the Not Started state, all users with read access can view
data, view the process state, view the history, and read and enter new annotations.

Hyperion Planning Administrator’s Guide ■ 261


Managing the Budgeting Process

Starting the Review Process


A budget administrator begins the review process by selecting a planning unit and
starting it. The budget administrator can select all planning units or a subset of
planning units for the review process. The Start action changes the state of the
planning unit to First Pass, which is the beginning state of the review process.
During the First Pass state, the budget administrator may choose to exclude some
or all of the entities from the planning unit.

➤ To start a planning unit:


1. From the Hyperion Planning Home page, click Check Status / Manage
Process.
2. From the Scenario drop-down list, select a scenario.
3. From the Version drop-down list, select a version.
4. Click Go.
5. Select the Start option next to the entity that you want to start.

Note: For budget administrators, the Entity list can be displayed as a tree or a flat
list. If you are in a tree view, you can expand the hierarchy until you see the entity
or entities you want to work with, or if you are in the flat list view, you can click a
column header to sort the list.

6. Optional: To remove planning units from the planning process or from being
tracked in the system, select the Exclude option next to the desired planning
unit.

Note: After an administrator excludes a planning unit, all annotations and history
associated with the planning unit are discarded. The planning unit’s status is
returned to Not Started and the owner is set to No Owner. However, the data values
are retained.

Tip: For more information on working with planning units, see the User’s help system.

Entity Hierarchy
The parent/child relationships between entities affect their movement through the
review process. The following rules apply:
● When you promote or reject a parent, its children are automatically promoted
or rejected, unless they are in the Approved state. The owner selected for the
parent becomes the owner of the children also.

262 ■ Hyperion Planning Administrator’s Guide


Managing the Budgeting Process

● When you approve a parent, its children are automatically approved.


● After all of the children of a parent are promoted to the same owner, the parent
is promoted to that owner automatically.
12
● After all of the children of a parent are signed off, the parent status
automatically changes to signed off.

Note: You cannot change the status of a parent if its children are owned by different
users. If the children of a parent are promoted to different users or signed off by different
users, the parent has no owner and its status can only be changed by the budget
administrators.

Enabling E-mail Notification


The Preferences page displays differently for the application owner versus the
other application users because the application owner must set up the application’s
e-mail server before anyone else can successfully enable e-mail notification. After
e-mail notification is enabled, users receive an e-mail when they become the new
owner of a planning unit. The subject of the e-mail is NEW OWNER: XYZ Plan
(Scenario, Version, Entity).

Note: This feature is available for SMTP e-mail systems only.

➤ To enable e-mail notification for the other application users:


1. From the Hyperion Planning Home page, click the Preferences link.
2. Select the Application tab.
3. In the Email Server text box, type the name of the e-mail server for the
current application.
4. In the Email Address text box, type in the appropriate e-mail address.
5. Select the Enable Email Notification check box.
6. Optional: Select Copy The Application Owner if you want the owner of the
application to receive a copy of the e-mail notifications.

Note: Click Reset to revert to the selections that were set when you accessed the
Preferences page. Reset lets you undo your latest changes and start over again
from your previous selections.

7. Click Save.

Hyperion Planning Administrator’s Guide ■ 263


Managing the Budgeting Process

8. Repeat the above steps for each application you want e-mail notification
enabled.
If the e-mail server name and e-mail address are valid, the application owner now
becomes the source of all e-mail notifications. If the e-mail server name and e-mail
address are not valid, no one else can enable e-mail notification.

264 ■ Hyperion Planning Administrator’s Guide


Chapter Customizing Hyperion

13 Planning Web Client

13
You can customize five different aspects of the Hyperion Planning Web user
interface:
● Home Page Tools
● Style (font size, alignment, etc.)
● Text
● Images/Color
● Process Management

Customizing the Hyperion Planning Web Home


Page
Administrators can customize the Hyperion Planning Home page by adding links
to commonly-used tools for analyzing, tracking, and reporting on planning data.
Other Hyperion Planning users can then click on links that launch associated tools.
The customized links appear on the Hyperion Planning Home page, under the
Tools: Analyze and Report section.

➤ To add a link to the Hyperion Planning Home page:


1. Log on to the Hyperion Planning Home page.
1. Click the Preferences link.
2. Select the Custom Tools tab.
3. In the Name text box, enter the name of the link that you want to display on
the Hyperion Planning Home page.

Hyperion Planning Administrator’s Guide ■ 265


Customizing Hyperion Planning Web Client

4. In the URL text box, enter the URL for the site or application to which you
want to link.
Examples:
http://ABCcompany/announcement.htm
http://www.hyperion.com
5. From the User Type drop-down list, select which user type you want to have
access to this link. Your choices are Administrator, Interactive, and Basic.
– Administrator users see all links
– Interactive users see interactive user and basic user links
– Basic users see basic user links
6. Click Save.

Tip: To revert to the previous settings, click Reset.

Customizing Cascading Style Sheets


You should have a basic knowledge of cascading style sheets before customizing
the Hyperion Planning cascading style sheets, as some of the settings are necessary
for the proper display of certain portions of Hyperion Planning. Any changes to the
cascading style sheets must be made on the Web server. These changes then affect
all users connected to the Web server.

Note: Colors defined in the style sheets are not governed by the image and color
resources.

The default Hyperion Planning cascading style sheet is named HspStyle.css and
is located in the following location:
<WebAppServer>\<application directory>\HyperionPlanning

➤ To customize the cascading style sheet:


1. Locate the HspStyle.css file in the <WebAppServer>\<application
directory>\HyperionPlanning directory.

2. Copy and paste the HspStyle.css file to the


<WebAppServer>\<application
directory>\HyperionPlanning\custom directory.

3. Rename the file HspCustom.css.

266 ■ Hyperion Planning Administrator’s Guide


Customizing Hyperion Planning Web Client

4. Make all changes to the HspCustom.css file in the


<WebAppServer>\<application
directory>\HyperionPlanning\custom directory.

All Hyperion Planning Web pages include a reference to the HspCustom.css file
and any settings made here override those in HspStyle.css.
For example, the style that defines the look of the small action buttons used in
various places in Hyperion Planning is defined:
.SmallBtnIn { 13
background-color:#99CCCC;
border:solid thin;
border-width:1;
border-color:#969696;
}

and would be customized to change the colors in the following way:


.SmallBtnIn {
background-color:#0000DD;
border:solid thin;
border-width:1;
border-color:#777777;
}

Customizing Text
You can customize the text that appears in various locations throughout the
Hyperion Planning Web interface. All customizable text is stored in the
HspCustomMsgs_en.template file, which is located in the
<WebAppServer>\<application directory>\HyperionPlanning\custom
directory. The text in HspCustomMsgs_en.template is the English version of
the labels and messages used in Hyperion Planning. You can override the text
through two levels of customization.
The first level of customization is localization, in which the text resources of
HspCustomMsgs_en.template are overridden by the localized versions of the
text. These files are generated by a localization vendor, renamed according to the
localized language, and installed to the <WebAppServer>\<application
directory>\HyperionPlanning\Web-inf\lib directory. For example, the
French version of this file is named HspCustomMsgs_fr.properties and is
installed to the <WebAppServer>\<application
directory>\HyperionPlanning\Web-inf\lib directory.

Hyperion Planning Administrator’s Guide ■ 267


Customizing Hyperion Planning Web Client

The second level of customization is any custom modifications you make to text
resources.

➤ To customize the HspCustomMsgs_en.template file:


1. Locate the HspCustomMsgs_en.template file in the
<WebAppServer>\<application
directory>\HyperionPlanning\custom directory.

Note: If you are using WebLogic on a UNIX machine, see “Customizing Hyperion
Planning When Using WebLogic and UNIX” on page 270.

2. Copy and paste the HspCustomMsgs_en.template file to the


<WebAppServer>\<application
directory>\HyperionPlanning\Web-inf\lib directory.

3. Rename the file HspCustomMsgs_en.properties.


4. Make all changes in the HspCustomMsgs_en.properties file in the
<WebAppServer>\<application
directory>\HyperionPlanning\Web-inf\lib directory.

Each line in the HspCustomMsgs_en.properties file represents an individual


text resource you can customize. The name of the resource starts each line,
followed immediately by an equals sign, followed immediately by the contents of
the text resource. There is no punctuation required at the end of the line. The
carriage return signals the end of the resource.
For example, if you want to change the Tools menu label used on the Hyperion
Planning Home page, find the following string:
LABEL_HOME_TOOLS=Tools: Analyze and Report
and make a corresponding entry in HspCustomMsgs_en.properties:
LABEL_HOME_TOOLS=Tools: Additional Resources
After making changes to the .properties files, stop and restart JRun Server in order
for changes to take affect.

Customizing Text in Non-Latin Languages


You can customize the text that appears in the Hyperion Planning Web interface,
even in non-Latin languages such as Chinese, Russian, Japanese, and so on.

268 ■ Hyperion Planning Administrator’s Guide


Customizing Hyperion Planning Web Client

You will need the native2ascii program, which is included with the Sun JDK.
Some application servers such as WebLogic install this program for you. If you
don’t have the native2ascii program, you may either install the JDK or copy
this program from a computer that has the JDK installed.

➤ To customize the HspCustomMsgs_en.template file:


1. Copy the HspCustomMsgs_en.template file into the
web-inf\lib folder.
13
2. Rename this file HspCustomMsgs_ru.source.
3. Customize the .source file as needed with the appropriate label names,
messages, and so on.
4. Copy a .bat file similar to this one for Russian into the web-inf\lib folder:
@echo off
echo Creating HspCustomMsgs_ru.properties
set path=.;C:\bea\jdk131\bin
set CLASSPATH=.
native2ascii -encoding Cp1251 (To determine the correct
encoding, see the Note that follows these steps.)
HspCustomMsgs_ru.source
HspCustomMsgs_ru.properties
pause
5. Edit the .bat file to make sure the language settings and directory path to the
native2ascii executable are correct.
6. Run the .bat file to generate an HspCustomMsgs_ru.properties file.
7. Restart the application server.
You should now be able to see all characters correctly.
Note: You can find a complete list of canonical encodings at this Web site:
http://java.sun.com/j2se/1.3/docs/guide/intl/encoding.
doc.html
To generate a new .properties file, you must make any additional
customization changes to the .source file and then run the .bat file again.

Hyperion Planning Administrator’s Guide ■ 269


Customizing Hyperion Planning Web Client

Restricted Characters
Certain characters can cause errors when used in custom messages. This also
depends on whether the text string is being generated by java or java script. Pop
up boxes and some buttons are usually generated by java script and text messages
are usually generated by java.
Avoid using the following characters in custom messages:
“/ ‘
● If you need to use /b within a text string, use //b instead.
● If you need to use ‘ within a text string, use //‘ instead.

Customizing Hyperion Planning When Using WebLogic


and UNIX
If you are running WebLogic on a UNIX machine, you will follow slightly
different steps before you can customize the text, colors, and images of the
Hyperion Planning Web interface.

➤ To prepare for customization:


1. Manually decompress the HyperionPlanning.ear file.
2. Locate the HspCustomMsgs_en.template file in the
<WebAppServer>\<application
directory>\HyperionPlanning\custom directory.

3. Copy and paste the HspCustomMsgs_en.template file to the same


directory in which the HspJSHome.properties file is located.
The location of this file will vary depending on where you decided to
decompress the HyperionPlanning.ear file.
4. Rename the file HspCustomMsgs_en.properties.
5. Make all changes in the HspCustomMsgs_en.properties file.

Customizing Hyperion Planning When Using Apache


Tomcat
If you are using Apache Tomcat as your Web application server, you follow
slightly different steps before you can customize the text, colors, and images of the
Hyperion Planning Web interface.

270 ■ Hyperion Planning Administrator’s Guide


Customizing Hyperion Planning Web Client

➤ To prepare for customization:


1. Locate the HspCustomMsgs_en.template file and the
HspCustomImgs_en.template file in the
tomcat\webapps\HyperionPlanning\custom directory.

2. Copy and paste the HspCustomMsgs_en.template file nd the


HspCustomImgs_en.template file to the same directory in which the
HspJSHome.properties file is located.
3. Rename the files as HspCustomMsgs_en.properties and 13
HspCustomImgs_en.properties.

4. Make all changes in the HspCustomMsgs_en.properties and


HspCustomImgs_en.properties files.

Customizing Colors and Images


You can customize the colors and images that appear in various locations
throughout the Hyperion Planning Web interface. All customizable colors and
images are stored in the HspCustomImgs_en.template file, which is located in
the <WebAppServer>\<application
directory>\HyperionPlanning\custom directory. The information in
HspCustomImgs_en.template is the English version of the colors and images
used in Hyperion Planning.

➤ To customize the HspCustomImgs_en.template file:


1. Locate the HspCustomImgs_en.template file in the
<WebAppServer>\<application
directory>\HyperionPlanning\custom directory.

Note: If you are using WebLogic on a UNIX machine, see “Customizing Hyperion
Planning When Using WebLogic and UNIX” on page 270.

2. Copy and paste the HspCustomImgs_en.template file to the


<WebAppServer>\<application
directory>\HyperionPlanning\Web-inf\lib directory.

3. Rename the file HspCustomImgs_en.properties.

Hyperion Planning Administrator’s Guide ■ 271


Customizing Hyperion Planning Web Client

4. Make all changes in the HspCustomImgs_en.properties file in the


WebAppServer>\<application
directory>\HyperionPlanning\Web-inf\lib directory.

Note: Image file names and the Images directory are case-sensitive on some
application servers and operating systems.

Each line in the HspCustomImgs_en.properties file represents an individual


color or image resource you can customize. The name of the resource starts each
line, followed immediately by an equals sign, followed immediately by the
contents of the resource. There is no punctuation required at the end of the line.
The carriage return signals the end of the resource.
For example, if you want to change the image on the Hyperion Planning Log On
page, find the following resource:
IMG_LOGON=Images/logon_nobdr_nopnstrp.gif
and make the following entry in HspCustomImgs_en.properties:
IMG_LOGON=Images/my_logon_image.gif
You have the ability to change every reference to a particular color (such as the
various shades of teal) to be some other color. Some of the colors are named, some
are given as hex values, and some are given as RGB values. Any new images that
you add to the Web interface must also be stored in the Hyperion
Solutions\Hyperion Planning\Web\Images directory.

After making changes to the .properties files, stop and restart JRun Server in order
for changes to take affect.

Customizing the Colors, States, and Actions for


Process Status
You can customize the color, state name, and action name for process status in
Hyperion Planning Workflow Tasks. Customizing the color, state, and action of
each process status requires some knowledge of how to maintain and manipulate
the relational database you are using.

272 ■ Hyperion Planning Administrator’s Guide


Customizing Hyperion Planning Web Client

Customizing the Colors


By default, each process status state in the Workflow Tasks page is black.
However, you can customize each process status state to display different colors
(e.g., red for Not Started, green for First Pass, etc.). Valid colors include all named
colors, which means they are those colors that a browser will recognize. Refer to
the Microsoft Web site for an up to date list of supported named colors.
The process status state color information is stored in the HSP_PM_STATES table
in the COLOR column. You will need to run statements for your particular 13
relational database to change the color value in the database.
The following examples are for an SQL relational database.
● To get a list of all the available process status states and their current color
settings, run the following query:
select * from hsp_pm_states

● This returns various information, including the state_id, the name of the
process status state, several other pieces of information, and the color. By
default, the value of the color will be <NULL> which converts to black.
● Take note of the state_id of the process status state for which you want to
change the color and run the following query:
UPDATE HSP_PM_STATES SET COLOR = '<new color>' WHERE STATE_ID
= <state_id>

Example:
To change the First Pass process status state color to green, run the following SQL
statement:
UPDATE HSP_PM_STATES SET COLOR='GREEN' WHERE STATE_ID=1

Note: For an Oracle relational database you need to remember to issue a commit to
commit the transaction.

Example:
COMMIT;

Customizing the States


By default, the following process status states are available in the Workflow Tasks
page:

Hyperion Planning Administrator’s Guide ■ 273


Customizing Hyperion Planning Web Client

● Not Started
● First Pass
● Approved
● Not Signed Off
● Under Review
● Signed Off
However, you can customize each process status state to display a different name
(e.g., you can use the name “Promoted” rather than the default “Approved”).
The process status state information is stored in the HSP_PM_STATES table in the
NAME column. You will need to run statements for your particular relational
database to change the state value in the database.
The following examples are for an SQL relational database.
● To get a list of all the available process status states and their current names,
run the following query:
select * from hsp_pm_states

● This returns various information, including the state_id, the name of the
process status state, several other pieces of information, and the color.
● Take note of the state_id of the process status state for which you want to
change the name and run the following query:
UPDATE HSP_PM_STATES SET NAME = '<new name>' WHERE STATE_ID =
<state_id>

Example:
To change the Approved process status state name to Promoted, run the following
SQL statement:
UPDATE HSP_PM_STATES SET NAME='PROMOTED' WHERE STATE_ID=1

Note: For an Oracle relational database you need to remember to issue a commit to
commit the transaction.

Example:
COMMIT;

274 ■ Hyperion Planning Administrator’s Guide


Customizing Hyperion Planning Web Client

Customizing the Actions


By default, the following process status actions are available in the Workflow
Tasks page:
● Start
● Exclude
● Reject
● Approve
13
● Sign Off
● Promote
However, you can customize each process status action to display a different name
(for example, you can use the name “Accept” rather than the default “Approve”).
The process status action information is stored in the HSP_PM_ACTIONS table in
the NAME column. You will need to run statements for your particular relational
database to change the action value in the database.
The following examples are for an SQL relational database.
● To get a list of all the available process status actions and their current names,
run the following query:
select * from hsp_pm_actions

● This returns various information, including the action_id, the name of the
process status action, and several other pieces of information.
● Take note of the state_id of the process status action for which you want to
change the name and run the following query:
UPDATE HSP_PM_ACTIONS SET NAME = '<new name>' WHERE ACTION_ID
= <action_id>

Example:
To change the Approve process status action name to Accept, run the following
SQL statement:
UPDATE HSP_PM_ACTIONS SET NAME='ACCEPT' WHERE ACTION_ID=1

Note: For an Oracle relational database you need to remember to issue a commit to
commit the transaction.

Hyperion Planning Administrator’s Guide ■ 275


Customizing Hyperion Planning Web Client

Example:
COMMIT;

276 ■ Hyperion Planning Administrator’s Guide


Chapter Troubleshooting

14
This section describes how to resolve some common issues.

Currency Conversion Calc Script Failed 14

Scenario
When verifying your calc scripts, the following error message appears if the
scenarios, versions, or currencies in the calc script are dynamic calc members or if
all account members are dynamic: “The FIX statement cannot contain a dynamic
calc member.”

Solution
When selecting scenarios, versions, and currencies for creating a currency
conversion calc script on the Manage Database task, the selected scenarios,
versions, and currencies cannot be dynamic calc members. In addition, at least one
of the accounts must be set as Store.

500 Error Message


Scenario
You may receive a 500 ERROR message on a data entry form when the number of
members on the Page (the cross-product combination of dimensions after security
filter is applied) causes Java to run out of memory.

Hyperion Planning Administrator’s Guide ■ 277


Troubleshooting

Solution
It is recommended that the number of cross-product dimension combinations on
the Page be reduced as much as possible. By default, Java is allocated 128MB of
memory, but if your server has more memory available, you should increase the
amount that Java can use. As a general rule, if the server is dedicated to Hyperion
Planning, allocate 75% of the server’s RAM to Java; if the server is not dedicated,
allocate 25 to 50%of the RAM to Java. The minimum memory setting should be
128MB.

➤ To change the Java memory settings for JRun:


1. Open the JRun Management Console and navigate to JRun Default Server >
Java Settings > Java Arguments.
2. In the Input text box, enter the amount of RAM you want to allocate, using
the following expression:
-Xmx<amount>M

For example, to set Java to use 512MB of RAM, enter:


-Xmx512M

3. Select Update.
4. Close the JRun Management Console.
5. Restart the JRun Default Server to apply the change.

➤ To change the Java memory settings for WebSphere 3.5.x:


1. Highlight the Hyperion Reports\Hyperion Planning application server in the
administrator console.
2. Add the Java memory settings to the same place where you add or modify the
-CLASSPATH arguments.

CAUTION: Do not modify the admin.config file settings. Any changes


made to this file will be in affect for all application server JVMs.

➤ To change the Java memory settings for WebSphere 4.0:


1. Highlight the default server in the administrator console.

278 ■ Hyperion Planning Administrator’s Guide


Troubleshooting

2. Enter the amount of RAM in the Initial java heap size and the Maximum java
heap size fields.

Note: You can set both values to 512 or 1024, depending on how much RAM your
system has. If your system has 1 GB of physical RAM, use 512MB as the java heap
size.

➤ To change the Java memory settings for WebLogic 6.x:


1. Open the .cmd file used to start the application server (for example,
startHPServer.cmd).

2. Locate the section for the %JAVA_HOME% variables and make the setting
changes shown below. This procedure is the same for both Hyperion Planning
and Hyperion Reports.
14
echo on
"%JAVA_HOME%\bin\java" -hotspot -ms128m -mx128m -classpath
%CLASSPATH% -Dweblogic.management.discover=false
-Dweblogic.Domain=Hyperion -Dweblogic.Name=HPServer
"-Dbea.home=%BEA_HOME%" -Dweblogic.management.password=
%WLS_PW% -Dweblogic.ProductionModeEnabled=%STARTMODE%
"-Djava.security.policy==
%WEBLOGIC_HOME%/lib/weblogic.policy" weblogic.Server
goto finish

JRun Server Connection Refused


Scenario
You may receive the following error when initially using the Hyperion Application
Link Planning Adapter: “Connection refused to host [DRIVENAME:11333];
nested exception is: java.net.connectexception:connection refused.”

Solution
Log on to the Hyperion Planning Web server. Below are two procedures to connect
to the JRun server. The first is for the default server, the second is for when the
server is an Oracle relational store.

Hyperion Planning Administrator’s Guide ■ 279


Troubleshooting

➤ To connect to the JRun default server:


1. Rerun hspsetupsupport.exe which by default, is found in the
<DRVIE>:\Program Files\Hyperion Solutions\Hyperion
Planning\Utils directory.

2. Select the appropriate driver (for example, JTurbo).


3. Stop and start or recycle the JRun default server.

➤ To connect to the JRun default server on an Oracle relational store, perform the
following:
1. Rerun hspsetupsupport.exe which by default, is found in the
<DRVIE>:\Program Files\Hyperion Solutions\Hyperion
Planning\Utils directory.

2. Select the appropriate driver (for example, Oracle Thin).


3. If the Oracle server is not on the same machine as the Hyperion Planning Web
server, open the hspjshome.properties file in the C:\Program
Files\Hyperion Solutions\Hyperion Planning\Web\Web-inf\Lib
directory.
4. Change the PLANNING_JDBC_URL line from @localhost to
@OracleServerName and save your changes.

5. Stop and start or recycle the JRun default server.

Manage Database Errors


Scenario
Manage database errors can occur when the 8.3 naming convention is not used.
The error may appear as: “Manage Database Errors detected (Start 1060044):
Could not open outline -2147218904.”

Solution
To resolve manage database errors you may need to redirect the operating system
environment variables. Ensure that the 8.3 character naming convention is applied
to the file system. If you are certain that the correct naming convention is applied,
see Setting Environment Variables.

280 ■ Hyperion Planning Administrator’s Guide


Troubleshooting

File Naming Convention


Ensure you are logged on to the Hyperion Planning server as the DCOM user
before making any changes.

➤ To confirm that the DCOM user's temp environment variables conform to an 8.3
naming convention, perform one of the following:
● To check the environment variables for Windows NT:
a. Close Hyperion Planning.
b. Close Hyperion Essbase.
c. On the Windows desktop, right-click My Computer.
d. Select Properties. 14
e. Select the Environment tab.
f. Change the settings for Temp and Tmp in the user variable to the 8.3
naming convention.
For example, C:\Temp
● To check the environment variables for Windows 2000:
a. Close Hyperion Planning.
b. Close Hyperion Essbase.
c. On the Windows desktop, right-click My Computer.
d. Select Properties.
e. Select the Advanced tab.
f. Select Environment Variables.
g. Change the settings for Temp and Tmp in the user variable to the 8.3
naming convention.
For example, C:\Temp
h. Open the Essbase Application Manager and open the outline.
i. Close the Essbase Application Manager and restart Hyperion Planning.

Note: The settings for Temp and Tmp in the user and system variables must be unique.
Do not set the user and system variables to the same directory.

Hyperion Planning Administrator’s Guide ■ 281


Troubleshooting

Setting Environment Variables


Once you are certain that you are using the 8.3 naming convention, you can resolve
the issue by setting the environment variables.

➤ To set the environment variables:


1. Using Microsoft Explorer, add a directory under Temp called Temp.
2. Redirect environment variables to C:\temp\temp.
3. Try Refresh\Create.
4. If you continue to receive the error, redirect environment variables back to
C:\temp.

5. Try Refresh\Create again.

Restore Navigation Icons in Hyperion Planning


2.0
Scenario
The navigation icons in Planning 2.0 are missing.

Solution
When the Hyperion Reports server has stopped, you must apply the navigation
icon selections to Hyperion Planning.

➤ To apply the navigation icons:


1. Log on to Hyperion Reports.
2. From the menu, select View/Navigation frame/Organize navigation frame.
3. Click Advanced.
4. Click New.
5. Click Add.
6. From the drop-down box, select Plan apps.
7. Type Hyperion Planning for the display name and the full name.

282 ■ Hyperion Planning Administrator’s Guide


Troubleshooting

8. Click OK.
9. Bring over the icon selections you want to see in your navigation frame, and
click OK.

java/rmi/Naming Error
Scenario
You receive the error: “java/rmi/Naming” when creating a new Hyperion Planning
Adapter.

Note: This scenario occurs only in versions of Hyperion Planning prior to version 2.2.
14
Solution
To resolve this issue, you must download and install the RMI patch from the
Microsoft support site or acquire it from your MSDN support representative at
your location.

➤ To download and install the RMI patch:


1. Go to the following Microsoft ftp site to obtain the rmi.zip file:
ftp://ftp.microsoft.com/developr/msdn/unsup-ed/rmi.zip

2. Extract the contents to a temporary directory.


3. Copy the following directories to C:\winnt\java\classes:
● sun
● java
● sunw (optional)
4. Verify that your machine has a sun and java directory in the
C:\winnt\java\classes directory.

Note: You may also have other directories such as sunw or com directory depending
on your setup of WinZip, but they are not required.

5. From a Command Prompt, run the command clspack -auto


6. Delete the temporary directory.
7. Restart your machine.

Hyperion Planning Administrator’s Guide ■ 283


Troubleshooting

Missing Hyperion Planning Adapter


Scenario
When you use a new machine with a copy of the old C drive, the path to the
Hyperion Application Link task palette is broken. In some instances, either the
Hyperion Planning icon or the flat file icon is lost.

Solution
Locate the Hyperion Planning or flat file .prx file.

➤ To replace the missing icon on the task palette:


1. Go to the Extensions menu.
2. Click Browse.
3. Locate and select the missing prx file.
Examples:
● Hyperion Planning is Planning.PRX
● Flat file is Files.prx.

Slow Performance When Opening Large Forms


Scenario
Unusually large data entry forms with many cells may require significant time to
open.

Solution
You can choose to display a warning when someone tries to open data entry forms
that are larger than a specified number of cells. When a user tries to open a form
that is beyond the specified size limit, Hyperion Planning displays a warning about
the time needed to open the form. The user can choose whether or not to open the
data entry form.
The default value of cells that trigger the warning is 1500. Administrators can
change the default value.

284 ■ Hyperion Planning Administrator’s Guide


Troubleshooting

➤ To set the number of form cells that trigger a warning message upon opening:
1. On the Web, select Preferences.
2. Click the Data Display tab.
3. In the text box Warn If Form Larger Than __ Cells, type a value.
4. Optional: To apply this value to all users, select Apply To All.

Unable to Create Application Error


Scenario
When you try to create a new application in Hyperion Planning, you may receive 14
the following error message when you click Finish in the Create Application task:
“Unable to create application <application name>. Error number: -2147160060.”

Solution
There may be several causes of this issue. To resolve it, ensure that the following
conditions are met:
● Hyperion Essbase must be running.
● Advanced User Rights must be set up on the local machine.
● Administrator user must be set up in DCOM (run dcomcnfg.exe) for
HsxServer and HspDataSource.
● If the Hyperion Essbase supervisor username is the same as the Hyperion
Planning administrator username, then the passwords must be identical.
● If using local authentication, then the machine name must be different from
the username.
● For all versions later than Hyperion Planning 1.0, you must be running MDAC
2.5 or higher (with the exception of version 2.7, which is not compatible). To
confirm the version, check the properties on any .dll in C:\Program
Files\Common Files\System\Msadc. The newer version can be
downloaded from the Microsoft Web site.

Hyperion Planning Administrator’s Guide ■ 285


Troubleshooting

Unsuccessful Login
Scenario
When logging on to Hyperion Planning Web client, you receive the error:
“Unsuccessful login. Please try again.”

Solution
Ensure that you are using a valid username and password. Otherwise proceed to
the following possible resolutions.

JRun Evaluation Period Expired, Outdated, or


Missing
Check your JRun default-err.log for a message stating that your Evaluation period
of Jturbo has expired.

➤ To replace an expired copy of JRun:


1. Stop the JRun Default Server and replace your current copy of jturbo.jar
with a current licensed copy or evaluation version.
2. Place the jturbo.jar in the Hyperion Planning \web\web-inf\lib
directory.
3. Start the JRun Default Server.
4. Log on to the Hyperion Planning Web client.

Incorrect JDBC Driver (SQL)


If you have the incorrect driver to run JRun, it is necessary to select the correct one
when running hspsetupsupport.exe.

➤ To select the correct driver:


1. Rerun hspsetupsupport.exe and select the appropriate driver (for example,
JTurbo).
2. Stop and start or recycle the JRun Default Server or the Hyperion Planning
server.

286 ■ Hyperion Planning Administrator’s Guide


Troubleshooting

Incorrect JDBC Driver (Oracle)


The same case may apply if you are running on Oracle. You must select the
appropriate driver when running hspsetupsupport.exe. You may also need to
modify the hspjshome.properties file.
1. Rerun hspsetupsupport.exe and select the appropriate driver (for example,
Oracle Thin).
2. If the Oracle server is not on the same machine as the Hyperion Planning Web
server, open the hspjshome.properties file in the C:/Program
Files/Hyperion Solutions/Hyperion Planning/Web/Web-inf/Lib
directory.
3. Change the PLANNING_JDBC_URL line from @localhost to
@OracleServerName and save your changes. 14
4. Stop and start or recycle the JRun Default server or the Hyperion Planning
server.

Classes Zip Files Missing (Oracle)


Another cause of this problem on an Oracle system is a copy of the
CLASSES12.ZIP file was not found in the C:\Program Files\Hyperion
Solutions\Hyperion Planning\Web\Web-inf\Lib directory.

➤ To replace or provide the classes zip files:


1. Locate the classes files on your Hyperion Planning CD or download .zip file.
2. Copy the CLASSES12.ZIP file to C:\Program Files\Hyperion
Solutions\Hyperion Planning\Web\Web-inf\Lib directory.

3. Restart or recycle the JRun Default Server.

Hyperion Planning Administrator’s Guide ■ 287


Troubleshooting

Restore or Move an Application


Scenario
When a Hyperion Planning application needs to be restored or moved to another
machine, it can be done by a consultant at your site or when a support staff member
receives your file for testing purposes (usually referred to as “restoring”). For SQL
databases, you use the Backup utility. Then, either the consultant or the support
staff uses the Restore utility.

Solution

➤ To restore or move an Hyperion Planning application:


1. Create a temporary relational database.
2. Create a permanent relational database.
3. Restore the relational database from the customer backup file to the new
permanent database created in step 2.
4. Create a temporary UDL pointing to the temporary database.
5. Create a permanent UDL pointing to the permanent database.
6. Create a permanent DSN pointing to the temporary UDL.
7. Run the Hyperion Planning Create Application task with same name as the
customer <appname>.

Note: If you do not know the name of the customer application and are using SQL
Server for your relational database management system (RDBMS), look at the list
of tables for the restored database. There is a table named
Hsp_<appname>_RoleAccess where appname is the name of the customer’s
application.

288 ■ Hyperion Planning Administrator’s Guide


Troubleshooting

8. If your testing requires that users be brought over, you need to add users to
your Temporary Planning application (from your own domain). You can add
the same number as the customer or fewer. If you add fewer, the excess users
will be displayed in Planning as “Account Unknown”, but they will retain the
security set by the customer.

Note: If you do not know the total number of users in the customer application and
are using SQL Server for your RDBMS, look at the list of tables for the restored
database. Open the HSP_USERS table and count the number of non-admin users
(or count them all and subtract 1).

9. Run HPRestore using permanent DSN and permanent UDL.


10. At the prompts, choose the permanent datasource (Step 6 above) and
permanent UDL (Step 5 above.) 14
11. When you get the message “Done!”, click OK
12. Log on to the restored application through Hyperion Planning using the
machine's NT username and password.
13. To create the databases in Essbase, open the application in Hyperion Planning,
go into Manage Application > Manage Database and click Create.

Unable to Find Properties File


Scenario
When you try to connect to Hyperion Planning through the Web, you may receive
the error: “An exception was reported: Unable to find properties file:
HspJSHome.properties.”

Solution

➤ To run the HspSetupSupport.exe file:


1. From Microsoft Windows Explorer go into Hyperion Planning\Utils
directory (default: <drive>\Program Files\Hyperion
Solutions\Hyperion Planning\Utils) and run HspSetupSupport.exe.

2. Create\modify the HspJSHome.properties located in <drive>:/Program


Files/Hyperion Solutions/Hyperion Planning/web/web-inf/lib.

3. Stop and Start JRun default server or the Hyperion Planning server.

Hyperion Planning Administrator’s Guide ■ 289


Troubleshooting

Error: "database locked by another


administrator"
Scenario
Occasionally, Hyperion Planning applications may become locked. This can be
caused by events such as abnormally exiting the application and Hyperion
Planning.

Solution
For information on how to unlock an application, see “Unlocking Applications” on
page 63.

290 ■ Hyperion Planning Administrator’s Guide


Glossary

account. A dimension that represents an accounting container that identifies the


location and primary nature of the data.
account type. The definition of how an account’s value flows over time, as well
as its sign behavior. Account type options are expense, revenue, asset, liability, or
equity. An additional account type option factor is used for calculation purposes.
Expense examples: payroll expenses, salaries, office supplies, legal expenses, and
rent. Revenue examples: sales, interest income, and other income. Asset examples:
cash, accounts receivable, fixed assets, and accumulated depreciation. Liability

Glossary
examples: accounts payable, accrued expenses, and long-term debt. Equity
examples: common stock, preferred stock, additional paid-in-capital, and retained
earnings.
active window. A window with a highlighted title bar or border distinguishing it
from other visible windows. A user can perform actions only within an active
window. Only one window can be active at any given time.
activity-level authorization. Defines user access to application components and
the types of activities they can perform on the application component.
Activity-level authorization controls whether a given user may perform a certain
action in an application and is independent of the data that will be operated on by
the action. Data access is controlled by data-level authorization.
adapter. The fundamental elements in a Hyperion Application Link adapter
process. Each adapter represents a set of specialized instructions.
add-in file. A small file you load within a larger software program that enhances
the functions and capabilities of the larger program. Hyperion Planning
Spreadsheet Add-in is an add-in file you load within Microsoft Excel.
aggregate function. An operation that summarizes or performs analysis on data.
Sum, calculation of an average, and identification of a maximum value are
examples of aggregate functions.

Hyperion Planning Administrator’s Guide ■ 291


Glossary

alias. An alternative name for a dimension, member, or description.


alias table. A database table that stores aliases for the dimensions or members.
ancestor. A branch member that has members below it. For example, in a
dimension that includes years, quarters, and months, the members Qtr2 and 2001
are ancestors of the member April.
application. A related set of dimensions, dimension members, and plan types
associated with a database that are used to meet a specific set of analytical and/or
reporting requirements.
application currency. The default reporting currency for the application.
application log. A record of user actions performed on an application.
application server. A middle-tier server that is used to deploy and run
Web-based application processes.
asset account. An account type that stores values that represent the assets of a
company.
asymmetric rows or columns. A form design characterized by groups of
members that differ by at least one member across the groups. There can be a
difference in the number of members or the names of members under each heading
in the form. For example, a form could have three members (Product A, B, and C)
grouped under “East” and two members (Product D and E) grouped under “West.”
attribute. A classification of a member in a dimension. You can select and group
members based on their associated attributes. You can also specify an attribute
when you perform calculations and use calculation functions. For example, a
Product dimension can have several attributes, such as Size and Flavor. A specific
member of the Product dimension can have the Size attribute, 8, and the Flavor
attribute, Cola.
authentication. Verification of identity as a security measure. Authentication is
typically based on a user ID and password. Passwords and digital signatures are
forms of authentication.
authentication server. The authentication server provides authentication and
server-level authorization services. It is a middle-tier server responsible for
authenticating users as they log on to the Hyperion Analytic Framework. When the
user attempts to access the Hyperion Desktop, the client obtains the user’s user
name and password through a logon dialog.
balance account. An account type that stores unsigned values that relate to a
particular point in time.

292 ■ Hyperion Planning Administrator’s Guide


Glossary

base currency. The currency in which daily business transactions are performed.
base entity. An entity at the bottom of the organization structure that does not
own other entities.
broadcast message. A simple text message sent by an administrator to a user
who is logged on to a Hyperion Planning application. The message displays
information to the user such as system availability, notification of application
refresh, or application backups.
budget administrator. A person responsible for setting up, configuring,
maintaining, and controlling an application. Has all application privileges and data
access rights.
business rules. Logical expressions or formulas that are created within an
application to produce a desired set of resulting values.
calculated data field. A calculated data field is a field that holds a data value
resulting from a formula or arithmetic calculation as opposed to being retrieved as
a stored data value from a database.
calculation script. A set of commands that define how a database is consolidated
or aggregated. A calculation script may also contain commands that specify
allocation and other calculation rules separate from the consolidation process.
calendar. User-defined time periods and their relationship to each other. Q1, Q2,
Q3, and Q4 comprise a calendar or fiscal year.
cell. A unit of data representing the intersection of dimensions in a
multidimensional database; the intersection of a row and a column in a worksheet.
child. A member that has a parent above it in the database outline.
column. A vertical display of information in a grid or table. A column can contain
data from a single field, derived data from a calculation, or textual information.
The terms column and field are sometimes used interchangeably. Contrast with
row.
cube. A block of data that contains three or more dimensions. Multidimensional
cubes are better suited for complex data analyses than for relational databases
because relational databases are limited to two dimensions. A Hyperion Essbase
database consists of miniature cubes that make up a larger cube, or hypercube.
currency. The monetary unit of measure associated with a balance or transaction.

Hyperion Planning Administrator’s Guide ■ 293


Glossary

currency code. A three-character ISO (International Standards Organization)


code used to identify a country’s currency. US dollars = USD, British pound
sterling = GPB, Japanese Yen = YEN
currency conversion. A process that converts currency values in a database from
one currency into another currency. For example, to convert one US dollar into
the euro, the exchange rate of 0.923702 is multiplied with the dollar (1* 0.923702).
After conversion, the euro amount is .92.
custom dimension. A dimension created and defined by users. For example,
channel, product, department, project, or region could be custom dimensions.
custom property. A property of a dimension or a dimension member that is
created by a user.
data. The values (monetary or non-monetary) associated with the query
intersection.
data entry form. A grid display that allows users to enter data into the database
from a Web browser. Certain dimension member values are fixed, giving users a
specific view into the data.
data source. A storage area containing data that is available to the user. A data
source may be a multidimensional database, a relational database, or a file.
data type. Defines the kind of data associated with an account member: currency,
non-currency, or percentage.
default. A pre-loaded response to a request for data and the accepted value if no
data is entered.
dense dimension. A dimension likely to contain data for every combination of
dimension members. For example, a time dimension is typically a dense
dimension because it contains all combinations of all members. Contrast with
sparse dimension.
dependent entity. An entity that is owned by another entity in the organization.
descendant. Any member below a parent in the database outline. For example,
in a dimension that includes years, quarters, and months, the members Qtr2 and
April are descendants of the member Year.
destination currency. The currency to which the balances will be converted.
You enter exchange rates and convert from the source currency to the destination
currency. For example, when you convert from euros to USD, the destination
currency is USD.

294 ■ Hyperion Planning Administrator’s Guide


Glossary

dimension. A data category that is used to organize business data for retrieval and
preservation of values. Each dimension usually contains a hierarchy of related
members grouped within it. For example, a Year dimension often includes
members for each time period, such as quarters and months. Other common
business dimensions may be measures, natural accounts, products, and markets.
direct rate. A currency rate that you enter directly in the exchange rate table. The
direct rate is used for currency conversion. For example, assume you want to
convert balances from GBP to USD. In the exchange rate table, you enter a rate for
the period/scenario where the source currency is GBP and the destination currency
is USD.
drill down. The process of retrieving progressively detailed data relative to a
selected dimension by expanding a parent member to reveal its children. The
expansion can reveal hierarchical relationships, such as those between a parent
entity and its child entity, a parent account and a child account, and a summary
time period and a base time period. For example, drilling down can reveal the
hierarchical relationships between year and quarters or between quarter and
months.
entity. A dimension representing organizational units, which can be divisions,
subsidiaries, plants, regions, products, or any other financial reporting unit.
Essbase OLAP Server. A Hyperion server that locates and accesses
multidimensional data.
exchange rate. A numeric value used to convert one currency to another. For
example, to convert $1 into Euros, the exchange rate of 0.8936 is multiplied with
the dollar. The Euro equivalent of $1 is 0.8936.
exchange rate type. An identifier associated with an exchange rate. Different
rate types are used because there may be more than one rate for a period and year.
Users traditionally define a rate at period end for the average rate of the period and
also a rate for the end of the period. Additional rate types are historical rates,
budget rates, forecast rates, and so on. All of these exchange rate types apply to the
same point in time.
expense account. An account type that stores periodic and year-to-date values
that decrease net worth if the value is positive.
file delimiter. One or more characters, such as a comma (,), separating fields in a
data source.
frame. An area of the desktop where information is displayed to the user. There
are two main areas on the desktop: the navigation frame and the workspace frame.

Hyperion Planning Administrator’s Guide ■ 295


Glossary

generation. A layer in a hierarchical tree structure that defines member


relationships in a database. For example, Essbase orders generations
incrementally from the dimension (generation 1) down to the child members.
hierarchy. A set of multidimensional relationships in an outline, often created in
a tree formation. For example, parents, children, and generations represent a
hierarchy.
Hyperion Application Link. A suite of application integration services that
connect resource planning systems, transaction processing applications, and other
data sources with Hyperion’s analytic applications.
Hyperion Business Rules. An application module for application designers who
need to create, document, and maintain complex allocation processes and business
rules for analytic applications throughout an organization.
Hyperion Reports. A graphical report writer that enables users to create a wide
variety of financial reports for printing and online access.
input currency type. An attribute that designates the currency type of the values
that are entered and stored in the applications.
interactive user. Interactive users can review and approve budgets, set up e-mail
notification to other users, create Web-based data entry forms, create worksheets
using the Spreadsheet Add-in, create reports using Hyperion Reports, create and
launch integrations using Hyperion Application Link, create and launch business
rules using Hyperion Business Rules and/or Hyperion Essbase Application
Manager, enter and view data in Web data entry forms and the Spreadsheet
Add-in.
iteration. A “pass” of the budget or planning cycle in which the same version of
data is revised and promoted.
liability account. An account type that stores “point in time” balances that
represent the liabilities of a company. Examples of liability accounts include
accrued expenses, accounts payable, and long term debt.
local currency. Any input currency type. When an input currency type is not
specified, the local currency is the same as the entity’s base currency.
log. A system-maintained record of transactional data resulting from actions and
commands.

296 ■ Hyperion Planning Administrator’s Guide


Glossary

log file. A system-maintained file that records transactional data resulting from
actions and commands. For example, an application log file records user actions
that are performed on that application; a client log file records client messages,
actions, and errors.
member. A discrete component within a dimension. For example, a time
dimension might include such members as Jan, Feb, and Qtr1.
metadata. The structure elements of an application that describe and hold data.
Examples of metadata are dimension names, member names, properties, exchange
rates, and security.
missing data (#MISSING). A marker indicating that data in the labeled location
does not exist, contains no meaningful value, or was never entered or loaded. For
example, missing data exists when an account contains data for a previous or a
future period but not for the current period.
multidimensional database (MDDB). A method of organizing, storing, and
referencing data through three or more dimensions. An individual value is the
intersection of a point for a set of dimensions.
navigation frame. The left side of the desktop where you access applications and
their related components. The tasks presented in the navigation frame are based
upon the user’s security rights.
page axis. Enables you to set up views (pages) of selected members, to organize
the data in a data entry form into smaller, logical groups. Each page on the page
axis can have members selected from one dimension or from multiple dimensions.
For example, you could set up one page to enter data for Radio promotions and
another page to enter data for Web promotions.
parent. A member that has an aggregated branch of children below it.
planner. Planners comprise the majority of users and can enable e-mail
notification for themselves, input, submit, and view data, user reports that have
been created by others, run data integration routines, execute business rules, and
use Hyperion Planning Spreadsheet Add-in.
planning unit. A slice of data at the intersection of a scenario, a version, and an
entity. It is the basic unit for preparing, reviewing, annotating, and approving plan
data.
POV (point of view). A feature that lets you work with members of dimensions
that are not assigned to a row, column, or page axis. For example, you could assign
the Currency dimension to the POV and select the Euro member. By selecting this
POV in a data entry form, all the data in the form is displayed in Euro values.

Hyperion Planning Administrator’s Guide ■ 297


Glossary

precision. Number of decimal places displayed in a number.


process pad. A button bar in the top part of the workspace frame that guides users
through a series of screens related to a process.
promote. The act of notifying other users that data is ready for review. Example:
a user promotes a version of their budget for review to the budget analyst.
RDBMS. See relational database management system (RDBMS).
relational database. A type of database that stores data in the form of related
tables. A single database can be spread across several tables, and can be viewed in
many different ways. Contrast with multidimensional database (MDDB).
relational database management system (RDBMS). A database management
system for accessing data in a relational database and storing data in the form of
related tables. A RDBMS takes SQL statements entered by a user or contained in
an application program and creates, updates, or provides access to the relational
database.
report. A layout that dynamically identifies the content and formatting of a
report. Reports become populated with data when they are run.
reporting currency. The currency in which an enterprise prepares its financial
statements. Hyperion Planning supports currency conversions from local
currencies to one or more reporting currencies. The converted reporting currency
values are stored.
row. A horizontal display of information in a grid or table. A row can contain data
from a single field, derived data from a calculation, or textual information. The
words row and record are sometimes used interchangeably. Contrast with column.
saved assumptions. Planning assumptions that are created either globally or
locally. The saved assumptions can be named, saved and referenced in planning
methods and allocations to help drive plan and budget values.
scaling. Determines how currency values are displayed in a data entry form or
report: in whole numbers, tens, hundreds, thousands, millions, and so on.
scenario. A dimension that specifies a data classification. Examples include
Actuals, Budget, Forecast1, and Forecast2.
security rights. User security rights defined by the user’s data access permissions
and activity-level privileges as explicitly defined for a user and as inherited from
other user groups.

298 ■ Hyperion Planning Administrator’s Guide


Glossary

shared member. A member that shares storage space with another member of the
same name. The shared member has a property that designates it as shared. The
use of shared members prevents duplicate calculation of members that appear
more than once in an Essbase outline.
shortcut menu. A menu that is displayed when the user right-clicks a selection or
a toolbar. A shortcut menu lists commands pertaining only to that screen region or
selection.
sibling. A child member at the same generation as another child member and
having the same immediate parent. For example, the members Florida and New
York are both children of the member, East, and siblings of each other.
sparse dimension. A dimension unlikely to contain data for all combinations of
dimension members. For example, product and market dimensions are sparse if
not all products are sold in all markets. Contrast with dense dimension.
standard form. A spreadsheet-like grid whose format guides users in entering
the necessary budget and plan data.
supporting detail. Calculations and assumptions from which the values of cells
are derived. Supporting detail can include text, values, and operators that define
how data aggregates.
system administrator. A person responsible for installing and initially
configuring Hyperion Planning, including setting up security.
time dimension. A dimension that defines how often data is collected and
updated, such as fiscal or calendar periods.
triangulation currency. A currency through which exchange rates can be
derived. For example, if you set up the Euro/Dollar exchange rate and the
Euro/Yen rate, the Dollar/Yen rate can be derived by using Euro as the
triangulation currency.
variance. The difference between two values (for example, between a planned
and actual value).
version. A possible outcome used within the context of a scenario of data. For
example, Budget - Best Case and Budget - Worst Case where Budget is the
scenario and Best Case and Worst Case are the versions.
workspace frame. The area on the right of the desktop that displays the window
related to the task currently selected in the left navigation frame.

Hyperion Planning Administrator’s Guide ■ 299


Glossary

300 ■ Hyperion Planning Administrator’s Guide


Index

Numerics rate type, 177


refreshing, 70
4-4-5 weekly pattern, 57 saved assumptions, 176
500 error message, 277 account types, 174
5-4-4 weekly pattern, 57 adapter palette, 221
adapter process
A creating, 222
running, 228
access rights
administrator user type, 107
assigning to data entry forms, 253
administrators
assigning to members, 192
and application ownership, 30

Index
assigning to scenario and version members, 216
setting up multiple, 108
assigning to users and groups, 123
advanced properties
available options, 123
defining for Account members, 180
data entry forms, 232
defining for Entity members, 170
defining for scenarios, 207
defining for user-defined custom dimension
deleting for members, 194
members, 191
deleting from scenario and version members, 217
aggregation options, 160
for business rules, 126
alias names, 129
importing, 117
alias tables
inheritance options, 124
adding, 130
modifying for members, 193
clearing, 131
modifying for scenario and version members, 216
copying, 130
setting for scenarios and versions, 215
deleting, 132
access statistics, 66
renaming, 131
Account dimension, 174
selecting in the Web Client, 132
Account members
setting for Entity members, 170
account types, 174
Analyzer
adding, 177
see Hyperion Analyzer, 27
annotating, 246
annotating accounts, 246
data type, 177
application
defining advanced properties for, 180
databases, implications of creating, 69
deleting, 183
populating with data overview, 35
modifying, 181
set up overview, 29
plan types, 174
application currency conversion calcscript

Hyperion Planning Administrator’s Guide ■ 301


Index

and batch refresh, 74 defining, 196


and create database, 67 deleting, 197
application databases modifying, 197
about, 67 on data entry forms, 233
refreshing, 70 overview, 195
scheduling a refresh, 72 refreshing, 70
application servers using in Hyperion Application Link, 203
registering, 50 using in Hyperion Planning Web data entry
unregistering, 50 forms, 202
applications
backing up, 61
choosing, 55
B
closing, 63 backing up an application, 288
copying and renaming, 89 backing up databases, 70
creating, 54 to 60 backing up system tables, 61
creating additional, 60 base currency for Entity members, 168
creating the calendar, 56 base time period
currency conversion calcscripts, 69 defining, 56 to 57
data source for, 55 spreading data, 56
defining currencies, 58 bottom-up versions, 211
defining the calendar range, 57 and currency calculations, 71
deleting, 61 broadcast messaging, 64
moving, 85, 288 BroadcastMessage.exe file, 65
naming, 56 budget process
opening, 60 impact of the entity hierarchy, 262
optimizing performance, 76 overview, 259
overview, 53 business rules
restoring, 288 access rights, 126
saving, 59 and Spreadsheet Add-in, 36
setting up plan types, 59 launch upon Save, 251
Setup Application task, 54 launching overview, 40
unlocking, 63 migrating, 87
using, 60 to 63 overview, 35
asymmetric rows and columns, 244 selecting members for run-time prompts, 251
attribute values setup overview, 35
assigning to members, 199 using, 250
defining, 198
deleting, 201
loading, 222
C
modifying, 200 calculation method of currency conversion, 150
overview, 198 calendar range,defining, 57
selecting as members on data entry forms, 244 Calendar workspace frame, 56
using in Hyperion Application Link, 203 calendars
using in Hyperion Planning Web data entry adding years to, 139
forms, 202 changing the current period, 140
attributes changing the current year, 140
creating in applications, 56

302 ■ Hyperion Planning Administrator’s Guide


Index

creating summary time periods, 136 assigning access rights, 253


defining roll ups, 135 attributes, 233
deleting summary time periods, 138 creating, 237
expanding and collapsing the summary time creating asymmetric rows and columns, 244
periods hierarchy, 139 currencies, 232
modifying summary time periods, 137 designing with multiple currencies, 233
setting up, 135 to 140 layout, 238
cascading style sheets modifying, 255
customizing, 266 moving, 256 to 257
category nodes, 47 page axis, 234
closing applications, 63 plan types, 231
colors, customizing in the UI, 271 point of view, 234
column definitions previewing design, 253
adding, 240 printing options, 247
changing, 241 rows and columns, 234
copying an application, 89 selecting attribute values as members, 244
css files, customizing, 266 selecting business rules, 250
CSS Property Name, 105 selecting members, 241
cube setup overview, 32 setting options, 246
currencies setting properties, 237
adding, 145 setup overview, 33
calculating conversions, 150 shared members, 233
conversions with, 58 unusually large, 284
data entry forms, 232 versions, 233
defining in an application, 58 data files
deleting, 148 load file example, 230
modifying, 147 loading, 229
multiple, 58 data source name (DSN), 55
setting up, 140 to 148 data type for Account members, 177
usage representation, 145 databases
currency conversion calc script Essbase, 67
setting parameters, 68 implications of creating, 69
troubleshooting, 277 unlocking, 290
customizing text DCOM, configuring, 105
about, 267 Define Basis tab, 56
in non-Latin languages, 268 Define Range tab, 57
customizing the UI, 265 dense dimensions, 157
when using WebLogic and UNIX, 270 deployment scenario for Hyperion Planning, 28
Desktop
overview of, 47 to 49
D showing/hiding components on, 48
data dimensions
distribution over time, 56 Account, 174
importing, 228 to 230 adding user-defined, 185
data entry forms, 231 aggregation options, 160
access rights, 232 collapsing, 162

Hyperion Planning Administrator’s Guide ■ 303


Index

concurrent usage, 165 overview of, 149


dense, 157 setting up, 151
Entity, 165 exchange rate types, 142
expanding, 162 exchange rates
finding, 163 refreshing, 70
hierarchies, 158 setting up, 149
in relation to their members, 157
modifying user-defined, 186
overview, 157
F
restoring properties, 164 fiscal year, setting up, 57
saving changes to, 164 FIX statement, troubleshooting, 277
sparse, 157 Flat File Adapter
storage options, 161 adding, 226
user-defined, 184 using, 225
distribution of data over time periods, 56 flat file load file, 226
domains, 94 Flow Diagram workspace, 221
DSN (data source name), 55 fonts, adding, 249
Dynamic Calc and Store option, 161 form folders
dynamic calc members creating, 235
and currency conversion calc script, 70 deleting, 236
in currency conversion calc script, 277 moving, 236
setting, 161 forms (see data entry forms), 231

E G
e-mail announcements, 64 groups
e-mail notification, 263 adding, 119
enterprise resource planning (ERP), 220 deleting, 121
Entity dimension, 165 modifying, 120
Entity members overview of setting up, 119
adding, 168
alias table, 169, 172, 178, 182, 185 to 186,
188 to 189
H
and plan types, 167 HAL
base currency, 168 see Hyperion Application Link, 26
defining advanced properties, 170 HBR
deleting, 173 see Hyperion Business Rules, 26
modifying, 171 Hsp_Rates dimension, 150
error messages, 277 HspCustomMsgs_en.template file, 268
Essbase HspJSHome.properties file, 46, 66, 99
see Hyperion Essbase, 25 adding fonts to, 249
Essbase.sec file, 67 to 68 unable to find, 289
exchange rate tables HspSetupSupport utility, 66, 99, 289
defining for scenarios, 206 HsxSysAdmin file, 62, 105
deleting, 154 Hyperion Analyzer
modifying, 154 overview of, 27
Hyperion Application Link

304 ■ Hyperion Planning Administrator’s Guide


Index

overview of, 26 loading shared members, 222


using attributes and attribute values, 203 using, 222
using to import members, 220 Hyperion Planning Home Page, customizing, 265
Hyperion Business Rules Hyperion Planning Spreadsheet Add-in
about run-time prompts, 252 overview of, 24
enabling run-time prompts, 253 worksheet overview, 34
overview of, 26 Hyperion Planning Web Client
security, 126 overview of, 24
Hyperion Essbase Hyperion Reports
closing, 51 migrating data, 87
multidimensional databases, 67 overview of, 25
overview of, 25 security, 127
security, 124
starting, 45
Hyperion Essbase Adapter
I
adding, 224 images, customizing in the UI, 271
using, 224 importing users, 113
Hyperion Planning ImportSecurity utility, 117
application setup overview, 29 ImportUsers utility, 113
budget review process overview, 41 inheritance options
business rules set up overview, 35 Children option, 124, 192
closing, 51 Descendant option, 124, 192
cube setup overview, 32 iChildren option, 124, 192
data entry form setup overview, 33 iDescendant option, 124, 192
deployment scenario, 28 Member option, 124, 192
getting started, 45 to 51 interactive users, 108
initializing the planning cycle overview, 38
launching business rules overview, 40
metadata setup overview, 30
J
overview of, 23 Java memory, allocating, 278
plan building overview, 38 JDBC
populating the application overview, 35 connection pooling, 46
post-planning activities overview, 43 selecting correct driver (Oracle), 287
reporting overview, 37 selecting correct driver (SQL), 286
setting the target overview, 36 JRun
Spreadsheet Add-in, 24 setting Java memory, 278
spreadsheet worksheets overview, 34 troubleshooting server connection, 279
starting on the Web, 49
starting the Desktop, 47 L
usage scenario, 28 to 44
user setup overview, 31 language in the UI, localizing, 267
using with other products, 25 to 27 load file, flat file, 226
Web Client, 24 localizing the UI text, 267
Hyperion Planning Adapter locked application, 63
adding, 223 logged-on users, 66
loading attribute values, 222 logging on to Hyperion Planning Web, 49

Hyperion Planning Administrator’s Guide ■ 305


Index

M moving an application, 85, 288


multiple alias tables, 129
member formulas,refreshing, 70 multiple currencies, 58
member selection designing forms with, 233
on a form, 241 enabling, 140
setting for run-time prompts, 251 loading exchange rate data, 225
members
adding Account members, 177
adding Entity members, 168 N
adding user-defined custom dimension members, native2ascii program, 269
187 navigation frame
alias names, 129 using, ?? to 49
assigning access rights to, 192 navigation frame, using, 47
assigning attribute values to, 199 NTLM authentication
collapsing, 162 about, 94
defining advanced properties for Account configuring for, 99
members, 180 cross-platform configuration, 99
defining advanced properties for Entity members, search order, 111
170 number formatting, 143
defining advanced properties for user-defined
custom dimension members, 191
deleting access rights, 194 O
deleting Account members, 183 online guide
deleting Entity members, 173 displaying, xviii
deleting user-defined custom dimension searching, xviii
members, 190 opening large forms, 284
expanding, 162 Oracle system, troubleshooting, 287
finding, 163
importing custom dimension members,
219 to 228 P
importing overview, 220 page axis, 234
importing using Hyperion Application Link, 220 passwords
modifying access rights, 193 modifying, 122
modifying Account members, 181 sharing, 122
modifying Entity members, 171 PDF printing, fonts in, 249
modifying user-defined custom dimension performance
members, 189 optimizing in applications, 76
moving within the dimension hierarchy, 194 when opening large forms, 284
of the Entity dimension, 167 period, changing in the calendar, 140
restoring properties, 164 plan building, overview, 38
saving changes to, 164 plan types
working with shared members, 165 Account members, 174
memory settings for Java, 278 data entry forms, 231
message announcements, 64 Entity members, 167
metadata setup overview, 30 setting up in applications, 59
migrating an application, 85 planners, 109
monthly distribution patterns, 56 Planning

306 ■ Hyperion Planning Administrator’s Guide


Index

see Hyperion Planning, 23 S


planning units, 259
enabling e-mail notification, 263 saved assumptions, 176
starting the review process, 262 scaling, 143
point of view, 234 scenarios
ports, connecting, 227 adding, 207
previewing form design, 253 and currency conversion calc scripts, 69
printing fonts, 249 assigning access rights, 216
printing options for forms, 247 copying, 209
process status states creating, 206
customizing the actions, 272, 275 defining access rights, 207
customizing the color, 272 to 273 defining exchange rate tables, 206
customizing the states, 272 to 273 defining time periods, 206
properties file, 46 deleting, 209
for LDAP, 102 deleting access rights, 217
for MS Active Directory, 102 modifying, 208
for NTLM, 99 modifying access rights, 216
unable to find, 289 setting access rights, 215
setting up, 205 to 210
scheduling an application refresh, 72
Q scheduling messages, 64
quick connect port connection, 227 search order for finding users, 111
Secfile.txt file, 118
security
R about, 106
rate type for Account members, 177 authentication providers, 93
refresh application DCOM, 105
scheduling, 72 LDAP support, 93
refresh Hyperion Essbase databases, 67 Microsoft NTLM, 94
refreshing data, implications of, 72 setting up, 93 to 127
refreshing databases, 70 setting up in Hyperion Business Rules, 126
relational database setting up in Hyperion Essbase, 124
optimizing, 45 setting up in Hyperion Reports, 127
Remote Method Invocation server security filters
configuration with, 99 generating for all users, 68
reporting currencies, 144 generating for one or more users, 116
restoring an application, 288 validating, 67, 71
RMI server, configuration with, 99 servers
roll ups, defining in calendars, 135 registering, 50
row definitions unregistering, 50
adding, 240 Setup Application task, 54
changing, 241 shared member
run-time prompts setting, 161
about, 252 shared members, 165
enabling, 253 applying security to, 68
Russian font, adding, 249 data entry forms, 233
loading, 222

Hyperion Planning Administrator’s Guide ■ 307


Index

sparse dimensions, 157 interactive user, 108


spreading data, 56 planners, 109
Spreadsheet Add-in tasks, 110
and business rules, 36 user-defined custom dimension members
setting up worksheets, 34 adding, 187
starthbr.bat file, 253 defining advanced properties, 191
starting Hyperion Planning deleting, 190
on the Desktop, 47 modifying, 189
on the Web, 49 user-defined dimensions
statistics on usage, 66 adding, 185
status bar, using, 47 modifying, 186
storage options, 161 users
strings,customizing, 267 about setting up, 111
style sheets, customizing, 266 adding from the Web, 112
summary time periods deleting, 116
collapsing the hierarchy, 139 importing, 113
creating in calendars, 136 modifying, 115
deleting in calendars, 138 search order, 111
expanding the hierarchy, 139 setup overview, 31
modifying in calendars, 137 utilities
supporting detail detection cache, 66 for importing security, 117
allocating memory for, 78 for importing users, 113
HspSetupSupport, 99, 289
unlocking an application, 64
T
target versions, 211
targets V
setting up, 36 validate security filter size, 71
tasks versions
collapsing on the navigation frame, 49 adding, 211
expanding on the navigation frame, 49 and currency conversion calc scripts, 69
text,customizing, 267 assigning access rights, 216
time periods copying, 214
defining for scenarios, 206 data entry forms, 233
toolbar, using, 49 deleting, 213
triangulation, 143 deleting access rights, 217
implied rates, 150 modifying, 212
troubleshooting, 277 modifying access rights, 216
Turkish font, adding, 249 setting access rights, 215
setting up, 210 to 214
setting up bottom up versions, 211
U setting up bottom-up versions, 71
UNIX and NTLM authentication, 98 setting up target versions, 211
unlocking applications, 63, 290 target, and currency conversion, 71
usage statistics, 66 viewing, 214
user types
administrator, 107

308 ■ Hyperion Planning Administrator’s Guide


Index

W
Web, starting Hyperion Planning on, 49
WebSphere, setting Java memory, 278
weekly distribution patterns, 56
worksheet, setting up, 34

Y
years
adding to the calendar, 139
changing in the calendar, 140

Hyperion Planning Administrator’s Guide ■ 309


Index

310 ■ Hyperion Planning Administrator’s Guide